RIVO Noord Zorgviewer MVP2 Implementation Guide
0.2.1 - CI build Netherlands flag

RIVO Noord Zorgviewer MVP2 Implementation Guide - Local Development build (v0.2.1). See the Directory of published versions

Resource Profile: Organization - Detailed Descriptions

Draft as of 2023-03-22

Definitions for the Organization resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Organization
2. Organization.identifier:AGB
SliceNameAGB
NoteThis is a business identifier, not a resource identifier (see discussion)
Must Supporttrue
InvariantsDefined on this element
zv-org-1: Organization AGB SHALL be present. (: (identifier.exists()))

Guidance on how to interpret the contents of this table can be found here.

1. Organization
Definition

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.

Control0..*
Alternate NamesZorgaanbieder
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
org-1: The organization SHALL at least have a name or an id, and possibly more than one (: (identifier.count() + name.count()) > 0)
2. Organization.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

3. Organization.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

4. Organization.identifier
Definition

The organization’s identification number. For Dutch healthcare providers, the URA number or the AGB number is used, if possible. For foreign or non-affiliated healthcare providers, another unique identification number can be used. This must be accompanied by the name and/or code of the issuing organization.

Identifier for the organization that is used to identify the organization across multiple disparate systems.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: org-1
TypeIdentifier
Summarytrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

SlicingThis element introduces a set of slices on Organization.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
5. Organization.identifier:URA
SliceNameURA
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: org-1
TypeIdentifier
Summarytrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Alternate NamesURA
6. Organization.identifier:URA.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

7. Organization.identifier:URA.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control10..1
Typeuri
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttp://fhir.nl/fhir/NamingSystem/ura
Example
General:http://www.acme.com/identifiers/patient
8. Organization.identifier:URA.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control10..1
Typestring
Summarytrue
Alternate NamesURA (UZI-register abonneenummer)
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
Example URA:12345678
9. Organization.identifier:AGB
SliceNameAGB
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: org-1
TypeIdentifier
Must Supporttrue
Summarytrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Alternate NamesAGB
InvariantsDefined on this element
zv-org-1: Organization AGB SHALL be present. (: (identifier.exists()))
10. Organization.identifier:AGB.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

11. Organization.identifier:AGB.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control10..1
Typeuri
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttp://fhir.nl/fhir/NamingSystem/agb-z
Example
General:http://www.acme.com/identifiers/patient
12. Organization.identifier:AGB.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control10..1
Typestring
Summarytrue
Alternate NamesAGB-Z (Vektis AGB-Z zorgverlenertabel)
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
13. Organization.identifier:UZOVI
SliceNameUZOVI
Definition

Unique healthcare insurance company identification (the UZOVI number).

Identifier for the organization that is used to identify the organization across multiple disparate systems.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: org-1
TypeIdentifier
Summarytrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Alternate NamesUZOVI
14. Organization.identifier:UZOVI.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

15. Organization.identifier:UZOVI.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control10..1
Typeuri
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttp://fhir.nl/fhir/NamingSystem/uzovi
Example
General:http://www.acme.com/identifiers/patient
16. Organization.identifier:UZOVI.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control10..1
Typestring
Summarytrue
Alternate NamesUnieke zorgverekeraar identificatie (het UZOVI-nummer)
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
17. Organization.active
Definition

Whether the organization's record is still in active use.

Control0..1
Typeboolean
Is Modifiertrue
Summarytrue
Requirements

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Comments

Default is true.

This active flag is not intended to be used to mark an organizations as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Default Valuetrue
18. Organization.type
Definition

The kind(s) of organization that this is.

Control0..*
BindingFor example codes, see OrganizationType

Used to categorize the organization

TypeCodeableConcept
Summarytrue
Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Comments

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

SlicingThis element introduces a set of slices on Organization.type. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ coding.system
19. Organization.type:organizationType
SliceNameorganizationType
Definition

The type of healthcare provider, such as general hospital, or nursing home. If this field is filled in and an AGB code is used for the HealthcareProviderIdentificationNumber, the type must match the type implicitly contained in the AGB code.

The kind(s) of organization that this is.

Control0..*
BindingThe codes SHALL be taken from OrganisatieTypeCodelijstFor example codes, see OrganizationType
TypeCodeableConcept
Summarytrue
Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Alternate NamesOrganisatieType
Comments

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

20. Organization.type:departmentSpecialty
SliceNamedepartmentSpecialty
Definition

The specialty of the healthcare provider’s department, e.g. Cardiology. The departmental specialty can be filled in if further indication of the healthcare provider is needed. This refers to the recognized medical specialties as stated in the BIG Act.

The kind(s) of organization that this is.

Control0..*
BindingThe codes SHALL be taken from AfdelingSpecialismeCodelijstFor example codes, see OrganizationType
TypeCodeableConcept
Summarytrue
Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Alternate NamesAfdelingSpecialisme
Comments

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

21. Organization.address
Definition

This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the HCIM AddressInformation (v1.0, 2017). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype.

To have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements.

Separate address parts

The first addition is that Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad.

Custom address types

The second addition is that the HCIM defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the HCIM concepts are mapped to the various FHIR elements (see the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType as well). The HCIM code itself should also be included using the AddressType extension.

| HCIM |.ext:AddressType | .ext:official | .use | .type | |-----------------------------------|:------------------:|:---------------:|:------:|:----------:| | Postal Address/Postadres | PST | | | postal | | Primary Home/Officieel adres | HP | true | home | | | Visit Address/Woon-/verblijfadres | PHYS | | home | physical | | Temporary Address/Tijdelijk adres | TMP | | temp | | | Work Place/Werkadres | WP | | work | | | Vacation Home/Vakantie adres | HV | | temp | |

If Address.type is both then this is to be understood as a dual purpose address (postal and physical). Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses.

NOTE: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the HCIM ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension.

An address for the organization.

Control0..* This element is affected by the following invariants: ele-1, nl-streetname-if-official-and-other-line-parts, org-2
TypeAddress(nl-core-address)
Requirements

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Alternate NamesAdresInformatie, Adresgegevens
Comments

Note: address is for postal addresses, not physical locations.

Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used.

Example
Example of a Vacation Home address:<valueAddress xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType">
    <valueCodeableConcept>
      <coding>
        <system value="http://hl7.org/fhir/v3/AddressUse"/>
        <code value="HV"/>
        <display value="Vakantie adres"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <use value="temp"/>
  <line value="Binnenkant 12A Hoog"/>
  <city value="Amsterdam"/>
  <state value="NH"/>
  <postalCode value="1000AA"/>
  <country value="NLD"/>
</valueAddress>

Example of a Primary Home address:<valueAddress xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType">
    <valueCodeableConcept>
      <coding>
        <system value="http://hl7.org/fhir/v3/AddressUse"/>
        <code value="HP"/>
        <display value="Officieel adres"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <extension url="http://fhir.nl/fhir/StructureDefinition/nl-core-address-official">
    <valueBoolean value="true"/>
  </extension>
  <use value="home"/>
  <line value="Binnenkant to 10"/>
  <city value="Amsterdam"/>
  <state value="NH"/>
  <postalCode value="1001AA"/>
  <country value="NLD"/>
</valueAddress>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value (: (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not())))
org-2: An address of an organization can never be of use 'home' (: where(use = 'home').empty())

Guidance on how to interpret the contents of this table can be found here.

1. Organization
Definition

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.

Control0..*
Alternate NamesZorgaanbieder
2. Organization.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Summarytrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. Organization.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Summarytrue
4. Organization.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

5. Organization.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

6. Organization.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

7. Organization.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

8. Organization.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

9. Organization.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

10. Organization.identifier
Definition

The organization’s identification number. For Dutch healthcare providers, the URA number or the AGB number is used, if possible. For foreign or non-affiliated healthcare providers, another unique identification number can be used. This must be accompanied by the name and/or code of the issuing organization.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: org-1
TypeIdentifier
Summarytrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

SlicingThis element introduces a set of slices on Organization.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
11. Organization.identifier:URA
SliceNameURA
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: org-1
TypeIdentifier
Summarytrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Alternate NamesURA
12. Organization.identifier:URA.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. Organization.identifier:URA.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Organization.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
14. Organization.identifier:URA.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

15. Organization.identifier:URA.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

16. Organization.identifier:URA.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttp://fhir.nl/fhir/NamingSystem/ura
Example
General:http://www.acme.com/identifiers/patient
17. Organization.identifier:URA.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Summarytrue
Alternate NamesURA (UZI-register abonneenummer)
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
Example URA:12345678
18. Organization.identifier:URA.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Summarytrue
19. Organization.identifier:URA.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

20. Organization.identifier:AGB
SliceNameAGB
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: org-1
TypeIdentifier
Must Supporttrue
Summarytrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Alternate NamesAGB
InvariantsDefined on this element
zv-org-1: Organization AGB SHALL be present. (: (identifier.exists()))
21. Organization.identifier:AGB.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
22. Organization.identifier:AGB.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Organization.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
23. Organization.identifier:AGB.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

24. Organization.identifier:AGB.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

25. Organization.identifier:AGB.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttp://fhir.nl/fhir/NamingSystem/agb-z
Example
General:http://www.acme.com/identifiers/patient
26. Organization.identifier:AGB.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Summarytrue
Alternate NamesAGB-Z (Vektis AGB-Z zorgverlenertabel)
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
27. Organization.identifier:AGB.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Summarytrue
28. Organization.identifier:AGB.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

29. Organization.identifier:UZOVI
SliceNameUZOVI
Definition

Unique healthcare insurance company identification (the UZOVI number).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..* This element is affected by the following invariants: org-1
TypeIdentifier
Summarytrue
Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Alternate NamesUZOVI
30. Organization.identifier:UZOVI.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
31. Organization.identifier:UZOVI.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Organization.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
32. Organization.identifier:UZOVI.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

33. Organization.identifier:UZOVI.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

34. Organization.identifier:UZOVI.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valuehttp://fhir.nl/fhir/NamingSystem/uzovi
Example
General:http://www.acme.com/identifiers/patient
35. Organization.identifier:UZOVI.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Summarytrue
Alternate NamesUnieke zorgverekeraar identificatie (het UZOVI-nummer)
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
36. Organization.identifier:UZOVI.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Summarytrue
37. Organization.identifier:UZOVI.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

38. Organization.active
Definition

Whether the organization's record is still in active use.

Control0..1
Typeboolean
Is Modifiertrue
Summarytrue
Requirements

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Comments

Default is true.

This active flag is not intended to be used to mark an organizations as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Default Valuetrue
39. Organization.type
Definition

The kind(s) of organization that this is.

Control0..*
BindingFor example codes, see OrganizationType Used to categorize the organizatio
TypeCodeableConcept
Summarytrue
Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Comments

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

SlicingThis element introduces a set of slices on Organization.type. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ coding.system
40. Organization.type:organizationType
SliceNameorganizationType
Definition

The type of healthcare provider, such as general hospital, or nursing home. If this field is filled in and an AGB code is used for the HealthcareProviderIdentificationNumber, the type must match the type implicitly contained in the AGB code.

Control0..*
BindingThe codes SHALL be taken from OrganisatieTypeCodelijst
TypeCodeableConcept
Summarytrue
Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Alternate NamesOrganisatieType
Comments

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

41. Organization.type:organizationType.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
42. Organization.type:organizationType.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Organization.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
43. Organization.type:organizationType.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

44. Organization.type:organizationType.coding.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
45. Organization.type:organizationType.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Organization.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
46. Organization.type:organizationType.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://nictiz.nl/fhir/NamingSystem/organization-type
47. Organization.type:organizationType.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

48. Organization.type:organizationType.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

49. Organization.type:organizationType.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

50. Organization.type:organizationType.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

51. Organization.type:organizationType.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

52. Organization.type:departmentSpecialty
SliceNamedepartmentSpecialty
Definition

The specialty of the healthcare provider’s department, e.g. Cardiology. The departmental specialty can be filled in if further indication of the healthcare provider is needed. This refers to the recognized medical specialties as stated in the BIG Act.

Control0..*
BindingThe codes SHALL be taken from AfdelingSpecialismeCodelijst
TypeCodeableConcept
Summarytrue
Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Alternate NamesAfdelingSpecialisme
Comments

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

53. Organization.type:departmentSpecialty.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
54. Organization.type:departmentSpecialty.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Organization.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
55. Organization.type:departmentSpecialty.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

56. Organization.type:departmentSpecialty.coding.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
57. Organization.type:departmentSpecialty.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Organization.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
58. Organization.type:departmentSpecialty.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valueurn:oid:2.16.840.1.113883.2.4.6.7
59. Organization.type:departmentSpecialty.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

60. Organization.type:departmentSpecialty.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

61. Organization.type:departmentSpecialty.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

62. Organization.type:departmentSpecialty.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

63. Organization.type:departmentSpecialty.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

64. Organization.name
Definition

The full name associated with the organization, which may include information about the organization's location. Specifics of the parent organization can be found through the partOf element.

Control0..1 This element is affected by the following invariants: org-1
Typestring
Summarytrue
Requirements

Need to use the name as the label of the organization.

Alternate NamesOrganisatieNaam of AfdelingNaam
Comments

If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

65. Organization.alias
Definition

Other names that this Organization is known as.

Control0..*
Typestring
Requirements

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the organization was known by can be very useful.

Alternate NamesOrganisatieAlias
Comments

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

66. Organization.telecom
Definition

Contact information includes a person's telephone numbers and email addresses. This datatype defines a common basis for expressing all contact information around the world, but adds extensions to express Dutch contacts specifically, according to the HCIM ContactInformation (v1.0, 2017). A Dutch ContactPoint still is a proper FHIR ContactPoint, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. The table below explains how the HCIM concepts are mapped to the various FHIR elements. The HCIM code itself should also be included using the TelecomType extension.

| HCIM | .ext:TelecomType | .system | .use | |----------------------------------------------------|:------------------:|:---------:|:--------:| | Primary Home Land Line | LL | phone | home | | Temporary Land Line | LL | phone | temp | | Primary Work Land Line | LL | phone | work | | | | | | | Primary Home Fax | FAX | fax | home | | Temporary Fax | FAX | fax | temp | | Primary Work Fax | FAX | fax | work | | | | | | | Primary Home Mobile Phone | MC | phone | home | | Temporary Mobile Phone | MC | phone | temp | | Primary Work Mobile Phone | MC | phone | work | | | | | | | Primary Home Pager | PG | pager | home | | Temporary Pager | PG | pager | temp | | Primary Work Pager | PG | pager | work | | | | | | | Private email address | | email | home | | Work email address | | email | work | | | | | | | Mobile phone number undetermined private/business | | phone | mobile |

Control0..* This element is affected by the following invariants: ele-1
TypeContactPoint(nl-core-contactpoint)
Requirements

Human contact for the organization.

Alternate NamesContactgegevens
Comments

The use code home is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

Example
Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.:<valueContactPoint xmlns="http://hl7.org/fhir">
  <system value="phone"/>
  <value value="+31611234567"/>
  <use value="work"/>
</valueContactPoint>

Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.:<valueContactPoint xmlns="http://hl7.org/fhir">
  <system value="phone"/>
  <value value="+31611234567"/>
  <use value="mobile"/>
</valueContactPoint>

Primary Home Land Line:<valueContactPoint xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType">
    <valueCodeableConcept>
      <coding>
        <system value="urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1"/>
        <code value="LL"/>
        <display value="Land Line"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <system value="phone"/>
  <value value="..."/>
  <use value="home"/>
</valueContactPoint>

Temporary Land Line:<valueContactPoint xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType">
    <valueCodeableConcept>
      <coding>
        <system value="urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1"/>
        <code value="LL"/>
        <display value="Land Line"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <system value="phone"/>
  <value value="..."/>
  <use value="temp"/>
</valueContactPoint>

Primary Work Land Line:<valueContactPoint xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType">
    <valueCodeableConcept>
      <coding>
        <system value="urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1"/>
        <code value="LL"/>
        <display value="Land Line"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <system value="phone"/>
  <value value="..."/>
  <use value="work"/>
</valueContactPoint>

Primary Home Fax:<valueContactPoint xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType">
    <valueCodeableConcept>
      <coding>
        <system value="urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1"/>
        <code value="FAX"/>
        <display value="Fax"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <system value="fax"/>
  <value value="..."/>
  <use value="home"/>
</valueContactPoint>

Temporary Fax:<valueContactPoint xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType">
    <valueCodeableConcept>
      <coding>
        <system value="urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1"/>
        <code value="FAX"/>
        <display value="Fax"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <system value="fax"/>
  <value value="..."/>
  <use value="temp"/>
</valueContactPoint>

Primary Work Fax:<valueContactPoint xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType">
    <valueCodeableConcept>
      <coding>
        <system value="urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1"/>
        <code value="FAX"/>
        <display value="Fax"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <system value="fax"/>
  <value value="..."/>
  <use value="work"/>
</valueContactPoint>

Primary Home Mobile Phone:<valueContactPoint xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType">
    <valueCodeableConcept>
      <coding>
        <system value="http://hl7.org/fhir/v3/AddressUse"/>
        <code value="MC"/>
        <display value="Mobile Phone"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <system value="phone"/>
  <value value="..."/>
  <use value="home"/>
</valueContactPoint>

Temporary Mobile Phone:<valueContactPoint xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType">
    <valueCodeableConcept>
      <coding>
        <system value="http://hl7.org/fhir/v3/AddressUse"/>
        <code value="MC"/>
        <display value="Mobile Phone"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <system value="phone"/>
  <value value="..."/>
  <use value="temp"/>
</valueContactPoint>

Primary Work Mobile Phone:<valueContactPoint xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType">
    <valueCodeableConcept>
      <coding>
        <system value="http://hl7.org/fhir/v3/AddressUse"/>
        <code value="MC"/>
        <display value="Mobile Phone"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <system value="phone"/>
  <value value="..."/>
  <use value="work"/>
</valueContactPoint>

Primary Home Pager:<valueContactPoint xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType">
    <valueCodeableConcept>
      <coding>
        <system value="http://hl7.org/fhir/v3/AddressUse"/>
        <code value="PG"/>
        <display value="Pager"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <system value="pager"/>
  <value value="..."/>
  <use value="home"/>
</valueContactPoint>

Temporary Pager:<valueContactPoint xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType">
    <valueCodeableConcept>
      <coding>
        <system value="http://hl7.org/fhir/v3/AddressUse"/>
        <code value="PG"/>
        <display value="Pager"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <system value="pager"/>
  <value value="..."/>
  <use value="temp"/>
</valueContactPoint>

Primary Work Pager:<valueContactPoint xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType">
    <valueCodeableConcept>
      <coding>
        <system value="http://hl7.org/fhir/v3/AddressUse"/>
        <code value="PG"/>
        <display value="Pager"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <system value="pager"/>
  <value value="..."/>
  <use value="work"/>
</valueContactPoint>

Private email address:<valueContactPoint xmlns="http://hl7.org/fhir">
  <system value="email"/>
  <value value="giesput@myweb.nl"/>
  <use value="home"/>
</valueContactPoint>

Work email address:<valueContactPoint xmlns="http://hl7.org/fhir">
  <system value="email"/>
  <value value="example@workplace.nl"/>
  <use value="work"/>
</valueContactPoint>
InvariantsDefined on this element
cpt-2: A system is required if a value is provided. (: value.empty() or system.exists())
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
org-3: The telecom of an organization can never be of use 'home' (: where(use = 'home').empty())
67. Organization.address
Definition

This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the HCIM AddressInformation (v1.0, 2017). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype.

To have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements.

Separate address parts

The first addition is that Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad.

Custom address types

The second addition is that the HCIM defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the HCIM concepts are mapped to the various FHIR elements (see the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType as well). The HCIM code itself should also be included using the AddressType extension.

| HCIM |.ext:AddressType | .ext:official | .use | .type | |-----------------------------------|:------------------:|:---------------:|:------:|:----------:| | Postal Address/Postadres | PST | | | postal | | Primary Home/Officieel adres | HP | true | home | | | Visit Address/Woon-/verblijfadres | PHYS | | home | physical | | Temporary Address/Tijdelijk adres | TMP | | temp | | | Work Place/Werkadres | WP | | work | | | Vacation Home/Vakantie adres | HV | | temp | |

If Address.type is both then this is to be understood as a dual purpose address (postal and physical). Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses.

NOTE: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the HCIM ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension.

Control0..* This element is affected by the following invariants: ele-1, nl-streetname-if-official-and-other-line-parts
TypeAddress(nl-core-address)
Requirements

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Alternate NamesAdresInformatie, Adresgegevens
Comments

Note: address is for postal addresses, not physical locations.

Example
Example of a Vacation Home address:<valueAddress xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType">
    <valueCodeableConcept>
      <coding>
        <system value="http://hl7.org/fhir/v3/AddressUse"/>
        <code value="HV"/>
        <display value="Vakantie adres"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <use value="temp"/>
  <line value="Binnenkant 12A Hoog"/>
  <city value="Amsterdam"/>
  <state value="NH"/>
  <postalCode value="1000AA"/>
  <country value="NLD"/>
</valueAddress>

Example of a Primary Home address:<valueAddress xmlns="http://hl7.org/fhir">
  <extension url="http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType">
    <valueCodeableConcept>
      <coding>
        <system value="http://hl7.org/fhir/v3/AddressUse"/>
        <code value="HP"/>
        <display value="Officieel adres"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <extension url="http://fhir.nl/fhir/StructureDefinition/nl-core-address-official">
    <valueBoolean value="true"/>
  </extension>
  <use value="home"/>
  <line value="Binnenkant to 10"/>
  <city value="Amsterdam"/>
  <state value="NH"/>
  <postalCode value="1001AA"/>
  <country value="NLD"/>
</valueAddress>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
nl-streetname-if-official-and-other-line-parts: Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value (: (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not())))
org-2: An address of an organization can never be of use 'home' (: where(use = 'home').empty())
68. Organization.partOf
Definition

The organization of which this organization forms a part.

Control0..1
TypeReference(nl-core-organization)
Summarytrue
Requirements

Need to be able to track the hierarchy of organizations within an organization.

69. Organization.contact
Definition

Contact for the organization for a certain purpose.

Control0..*
TypeBackboneElement
Requirements

Need to keep track of assigned contact points within bigger organization.

Comments

Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
70. Organization.contact.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
71. Organization.contact.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

72. Organization.contact.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

73. Organization.contact.purpose
Definition

Indicates a purpose for which the contact can be reached.

Control0..1
BindingThe codes SHALL be taken from ContactEntityType; other codes may be used where these codes are not suitable The purpose for which you would contact a contact part
TypeCodeableConcept
Requirements

Need to distinguish between multiple contact persons.

74. Organization.contact.name
Definition

A name associated with the contact.

Control0..1
TypeHumanName
Requirements

Need to be able to track the person by name.

75. Organization.contact.telecom
Definition

A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

Control0..*
TypeContactPoint
Requirements

People have (primary) ways to contact them in some way such as phone, email.

76. Organization.contact.address
Definition

Visiting or postal addresses for the contact.

Control0..1
TypeAddress
Requirements

May need to keep track of a contact party's address for contacting, billing or reporting requirements.

77. Organization.endpoint
Definition

Technical endpoints providing access to services operated for the organization.

Control0..*
TypeReference(Endpoint)
Requirements

Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.