RIVO-Noord Zorgviewer Implementation Guide
1.7.0 - sprint45
RIVO-Noord Zorgviewer Implementation Guide - Local Development build (v1.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2024-11-12 |
Definitions for the Organization resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Organization | |
Invariants | zv-org-1: Organization AGB SHALL be present. (identifier.where(system='http://fhir.nl/fhir/NamingSystem/agb-z') ) |
2. Organization.identifier:URA | |
Slice Name | URA |
Note | This is a business identifier, not a resource identifier (see discussion) |
Must Support | true |
4. Organization.identifier:URA.system | |
Control | 1..? |
Fixed Value | http://fhir.nl/fhir/NamingSystem/ura |
6. Organization.identifier:AGB | |
Slice Name | AGB |
Note | This is a business identifier, not a resource identifier (see discussion) |
Must Support | true |
8. Organization.identifier:AGB.system | |
Control | 1..? |
Fixed Value | http://fhir.nl/fhir/NamingSystem/agb-z |
10. Organization.identifier:HL7NL | |
Slice Name | HL7NL |
Note | This is a business identifier, not a resource identifier (see discussion) |
Must Support | true |
12. Organization.identifier:HL7NL.system | |
Control | 1..? |
Fixed Value | urn:oid:2.16.840.1.113883.2.4.3 |
Guidance on how to interpret the contents of this table can be found here
0. 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. |
Short | HealthcareProviderA grouping of people or organizations with a common purpose |
Control | 0..* |
Alternate Names | Zorgaanbieder |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.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() )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() )org-1: The organization SHALL at least have a name or an id, and possibly more than one ( (identifier.count() + name.count()) > 0 )zv-org-1: Organization AGB SHALL be present. ( identifier.where(system='http://fhir.nl/fhir/NamingSystem/agb-z') )dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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()) 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()) 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. |
Short | A set of rules under which this content was created |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
4. 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. |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Alternate Names | extensions, user content |
6. 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. |
Short | Identifies this organization across multiple systems |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* This element is affected by the following invariants: org-1 |
Type | Identifier |
Summary | true |
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. |
Slicing | This element introduces a set of slices on Organization.identifier . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. Organization.identifier:URA | |
Slice Name | URA |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Short | URAIdentifies this organization across multiple systems |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* This element is affected by the following invariants: org-1 |
Type | Identifier |
Must Support | true |
Summary | true |
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 Names | URA |
10. Organization.identifier:URA.use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary (If known) |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use (required to http://hl7.org/fhir/ValueSet/identifier-use )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
12. Organization.identifier:URA.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Control | 10..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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 Value | http://fhir.nl/fhir/NamingSystem/ura |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
14. 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. |
Short | URA (UZI-register abonneenummer)The value that is unique |
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. |
Control | 10..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | URA (UZI-register abonneenummer) |
Example | <br/><b>General</b>:123456 <br/><b>Example URA</b>:12345678 |
16. Organization.identifier:AGB | |
Slice Name | AGB |
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Short | AGBIdentifies this organization across multiple systems |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* This element is affected by the following invariants: org-1 |
Type | Identifier |
Must Support | true |
Summary | true |
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 Names | AGB |
18. Organization.identifier:AGB.use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary (If known) |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use (required to http://hl7.org/fhir/ValueSet/identifier-use )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
20. Organization.identifier:AGB.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Control | 10..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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 Value | http://fhir.nl/fhir/NamingSystem/agb-z |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
22. 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. |
Short | AGB-Z (Vektis AGB-Z zorgverlenertabel)The value that is unique |
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. |
Control | 10..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | AGB-Z (Vektis AGB-Z zorgverlenertabel) |
Example | <br/><b>General</b>:123456 |
24. Organization.identifier:UZOVI | |
Slice Name | UZOVI |
Definition | Unique healthcare insurance company identification (the UZOVI number). Identifier for the organization that is used to identify the organization across multiple disparate systems. |
Short | UZOVIIdentifies this organization across multiple systems |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* This element is affected by the following invariants: org-1 |
Type | Identifier |
Summary | true |
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 Names | UZOVI |
26. Organization.identifier:UZOVI.use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary (If known) |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use (required to http://hl7.org/fhir/ValueSet/identifier-use )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
28. Organization.identifier:UZOVI.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Control | 10..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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 Value | http://fhir.nl/fhir/NamingSystem/uzovi |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
30. 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. |
Short | Unique healthcare insurance company identification (the UZOVI number)The value that is unique |
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. |
Control | 10..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | Unieke zorgverekeraar identificatie (het UZOVI-nummer) |
Example | <br/><b>General</b>:123456 |
32. Organization.identifier:HL7NL | |
Slice Name | HL7NL |
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. |
Short | Identifies this organization across multiple systems |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* This element is affected by the following invariants: org-1 |
Type | Identifier |
Must Support | true |
Summary | true |
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. |
34. Organization.identifier:HL7NL.use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary (If known) |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use (required to http://hl7.org/fhir/ValueSet/identifier-use )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
36. Organization.identifier:HL7NL.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Control | 10..1 |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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 Value | urn:oid:2.16.840.1.113883.2.4.3 |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
38. Organization.active | |
Definition | Whether the organization's record is still in active use. |
Short | Whether the organization's record is still in active use |
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. |
Control | 0..1 |
Type | boolean |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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. |
Default Value | true |
40. Organization.type | |
Definition | The kind(s) of organization that this is. |
Short | Kind of organization |
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. |
Control | 0..* |
Binding | For example codes, see OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-type (example to http://hl7.org/fhir/ValueSet/organization-type )Used to categorize the organization |
Type | CodeableConcept |
Summary | true |
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
Slicing | This element introduces a set of slices on Organization.type . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
42. Organization.type:organizationType | |
Slice Name | organizationType |
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. |
Short | OrganizationTypeKind of organization |
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. |
Control | 0..* |
Binding | The codes SHALL be taken from For example codes, see OrganisatieTypeCodelijsthttp://hl7.org/fhir/ValueSet/organization-type (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.2.3--20171231000000 ) |
Type | CodeableConcept |
Summary | true |
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
Alternate Names | OrganisatieType |
44. Organization.type:departmentSpecialty | |
Slice Name | departmentSpecialty |
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. |
Short | DepartmentSpecialtyKind of organization |
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. |
Control | 0..* |
Binding | The codes SHALL be taken from For example codes, see AfdelingSpecialismeCodelijsthttp://hl7.org/fhir/ValueSet/organization-type (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.2.4--20171231000000 ) |
Type | CodeableConcept |
Summary | true |
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. |
Alternate Names | AfdelingSpecialisme |
46. 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 | 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. |
Short | AddressInformationAn address for the organization |
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. |
Control | 0..* This element is affected by the following invariants: ele-1, nl-streetname-if-official-and-other-line-parts, org-2 |
Type | Address(nl-core-address) |
Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements. |
Alternate Names | AdresInformatie, Adresgegevens |
Example | <br/><b>Example of a Vacation Home address</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HV", "display" : "Vakantie adres" }] } }], "use" : "temp", "line" : ["Binnenkant 12A Hoog"], "_line" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString" : "Binnenkant" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString" : "12" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix", "valueString" : "A" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID", "valueString" : "Hoog" }] }], "city" : "Amsterdam", "state" : "NH", "postalCode" : "1000AA", "country" : "NLD" } <br/><b>Example of a Primary Home address</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Officieel adres" }] } }, { "url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official", "valueBoolean" : true }], "use" : "home", "line" : ["Binnenkant to 10"], "_line" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString" : "Binnenkant" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator", "valueString" : "to" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString" : "10" }] }], "city" : "Amsterdam", "state" : "NH", "postalCode" : "1001AA", "country" : "NLD" } |
Invariants | 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
0. 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. | ||||
Short | HealthcareProvider | ||||
Control | 0..* | ||||
Alternate Names | Zorgaanbieder | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.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() )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() )org-1: The organization SHALL at least have a name or an id, and possibly more than one ( (identifier.count() + name.count()) > 0 )zv-org-1: Organization AGB SHALL be present. ( identifier.where(system='http://fhir.nl/fhir/NamingSystem/agb-z') ) | ||||
2. Organization.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
4. 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. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
6. 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. | ||||
Short | A set of rules under which this content was created | ||||
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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
8. Organization.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
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). | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
10. 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. | ||||
Short | Text summary of the resource, for human interpretation | ||||
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. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, html, xhtml, display | ||||
12. 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. | ||||
Short | Contained, inline 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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
16. 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. | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Alternate Names | extensions, user content | ||||
18. 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. | ||||
Short | Identifies this organization across multiple systems | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* This element is affected by the following invariants: org-1 | ||||
Type | Identifier | ||||
Summary | true | ||||
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. | ||||
Slicing | This element introduces a set of slices on Organization.identifier . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
20. Organization.identifier:URA | |||||
Slice Name | URA | ||||
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. | ||||
Short | URA | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* This element is affected by the following invariants: org-1 | ||||
Type | Identifier | ||||
Must Support | true | ||||
Summary | true | ||||
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 Names | URA | ||||
22. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
24. 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on Organization.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
26. Organization.identifier:URA.use | |||||
Definition | The purpose of this identifier. | ||||
Short | usual | official | temp | secondary (If known) | ||||
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. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
28. 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. | ||||
Short | Description of identifier | ||||
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. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
30. Organization.identifier:URA.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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 Value | http://fhir.nl/fhir/NamingSystem/ura | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
32. 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. | ||||
Short | URA (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. | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | URA (UZI-register abonneenummer) | ||||
Example | <br/><b>General</b>:123456 <br/><b>Example URA</b>:12345678 | ||||
34. Organization.identifier:URA.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
36. Organization.identifier:URA.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
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. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
38. Organization.identifier:AGB | |||||
Slice Name | AGB | ||||
Definition | Identifier for the organization that is used to identify the organization across multiple disparate systems. | ||||
Short | AGB | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* This element is affected by the following invariants: org-1 | ||||
Type | Identifier | ||||
Must Support | true | ||||
Summary | true | ||||
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 Names | AGB | ||||
40. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
42. 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on Organization.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
44. Organization.identifier:AGB.use | |||||
Definition | The purpose of this identifier. | ||||
Short | usual | official | temp | secondary (If known) | ||||
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. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
46. 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. | ||||
Short | Description of identifier | ||||
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. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
48. Organization.identifier:AGB.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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 Value | http://fhir.nl/fhir/NamingSystem/agb-z | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
50. 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. | ||||
Short | AGB-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. | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | AGB-Z (Vektis AGB-Z zorgverlenertabel) | ||||
Example | <br/><b>General</b>:123456 | ||||
52. Organization.identifier:AGB.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
54. Organization.identifier:AGB.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
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. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
56. Organization.identifier:UZOVI | |||||
Slice Name | UZOVI | ||||
Definition | Unique healthcare insurance company identification (the UZOVI number). | ||||
Short | UZOVI | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* This element is affected by the following invariants: org-1 | ||||
Type | Identifier | ||||
Summary | true | ||||
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 Names | UZOVI | ||||
58. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
60. 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on Organization.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
62. Organization.identifier:UZOVI.use | |||||
Definition | The purpose of this identifier. | ||||
Short | usual | official | temp | secondary (If known) | ||||
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. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
64. 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. | ||||
Short | Description of identifier | ||||
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. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
66. Organization.identifier:UZOVI.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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 Value | http://fhir.nl/fhir/NamingSystem/uzovi | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
68. 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. | ||||
Short | Unique healthcare insurance company identification (the UZOVI number) | ||||
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. | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | Unieke zorgverekeraar identificatie (het UZOVI-nummer) | ||||
Example | <br/><b>General</b>:123456 | ||||
70. Organization.identifier:UZOVI.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
72. Organization.identifier:UZOVI.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
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. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
74. Organization.identifier:HL7NL | |||||
Slice Name | HL7NL | ||||
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. | ||||
Short | Identifies this organization across multiple systems | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* This element is affected by the following invariants: org-1 | ||||
Type | Identifier | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
76. Organization.identifier:HL7NL.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
78. Organization.identifier:HL7NL.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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on Organization.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
80. Organization.identifier:HL7NL.use | |||||
Definition | The purpose of this identifier. | ||||
Short | usual | official | temp | secondary (If known) | ||||
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. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
82. Organization.identifier:HL7NL.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Short | Description of identifier | ||||
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. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
84. Organization.identifier:HL7NL.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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 Value | urn:oid:2.16.840.1.113883.2.4.3 | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
86. Organization.identifier:HL7NL.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Short | The value that is unique | ||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Example | <br/><b>General</b>:123456 | ||||
88. Organization.identifier:HL7NL.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..1 | ||||
Type | Period | ||||
Summary | true | ||||
90. Organization.identifier:HL7NL.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
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. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
92. Organization.active | |||||
Definition | Whether the organization's record is still in active use. | ||||
Short | Whether the organization's record is still in active use | ||||
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. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
Default Value | true | ||||
94. Organization.type | |||||
Definition | The kind(s) of organization that this is. | ||||
Short | Kind of organization | ||||
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. | ||||
Control | 0..* | ||||
Binding | For example codes, see OrganizationType (example to http://hl7.org/fhir/ValueSet/organization-type )Used to categorize the organization | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. | ||||
Slicing | This element introduces a set of slices on Organization.type . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
96. Organization.type:organizationType | |||||
Slice Name | organizationType | ||||
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. | ||||
Short | OrganizationType | ||||
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. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from OrganisatieTypeCodelijst (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.2.3--20171231000000 ) | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. | ||||
Alternate Names | OrganisatieType | ||||
98. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
100. 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on Organization.type.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
102. Organization.type:organizationType.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
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. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
104. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
106. 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on Organization.type.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
108. Organization.type:organizationType.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Short | Identity of the terminology system | ||||
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. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Fixed Value | http://nictiz.nl/fhir/NamingSystem/organization-type | ||||
110. 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. | ||||
Short | Version of the system - if relevant | ||||
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. | ||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
112. 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). | ||||
Short | Symbol in syntax defined by the system | ||||
Control | 0..1 | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
114. Organization.type:organizationType.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Short | Representation defined by the system | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
116. 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). | ||||
Short | If this coding was chosen directly by the user | ||||
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. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
118. 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. | ||||
Short | Plain text representation of the concept | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
120. Organization.type:departmentSpecialty | |||||
Slice Name | departmentSpecialty | ||||
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. | ||||
Short | DepartmentSpecialty | ||||
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. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from AfdelingSpecialismeCodelijst (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.2.4--20171231000000 ) | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Need to be able to track the kind of organization that this is - different organization types have different uses. | ||||
Alternate Names | AfdelingSpecialisme | ||||
122. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
124. 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on Organization.type.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
126. Organization.type:departmentSpecialty.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
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. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
128. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
130. 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Slicing | This element introduces a set of slices on Organization.type.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
132. Organization.type:departmentSpecialty.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Short | Identity of the terminology system | ||||
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. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Fixed Value | urn:oid:2.16.840.1.113883.2.4.6.7 | ||||
134. 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. | ||||
Short | Version of the system - if relevant | ||||
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. | ||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
136. 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). | ||||
Short | Symbol in syntax defined by the system | ||||
Control | 0..1 | ||||
Type | code | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
138. Organization.type:departmentSpecialty.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Short | Representation defined by the system | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
140. 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). | ||||
Short | If this coding was chosen directly by the user | ||||
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. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
142. 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. | ||||
Short | Plain text representation of the concept | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
144. 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. | ||||
Short | OrganizationName or DepartmentName | ||||
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. | ||||
Control | 0..1 This element is affected by the following invariants: org-1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to use the name as the label of the organization. | ||||
Alternate Names | OrganisatieNaam of AfdelingNaam | ||||
146. Organization.alias | |||||
Definition | Other names that this Organization is known as. | ||||
Short | OrganizationAlias | ||||
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. | ||||
Control | 0..* | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
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 Names | OrganisatieAlias | ||||
148. 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 | | ||||
Short | ContactInformation | ||||
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. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | ContactPoint(nl-core-contactpoint) | ||||
Requirements | Human contact for the organization. | ||||
Alternate Names | Contactgegevens | ||||
Example | <br/><b>Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "work" } <br/><b>Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.</b>:{ "system" : "phone", "value" : "+31611234567", "use" : "mobile" } <br/><b>Primary Home Land Line</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }], "system" : "phone", "value" : "...", "use" : "home" } <br/><b>Temporary Land Line</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }], "system" : "phone", "value" : "...", "use" : "temp" } <br/><b>Primary Work Land Line</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "LL", "display" : "Land Line" }] } }], "system" : "phone", "value" : "...", "use" : "work" } <br/><b>Primary Home Fax</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }], "system" : "fax", "value" : "...", "use" : "home" } <br/><b>Temporary Fax</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }], "system" : "fax", "value" : "...", "use" : "temp" } <br/><b>Primary Work Fax</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept" : { "coding" : [{ "system" : "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code" : "FAX", "display" : "Fax" }] } }], "system" : "fax", "value" : "...", "use" : "work" } <br/><b>Primary Home Mobile Phone</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }], "system" : "phone", "value" : "...", "use" : "home" } <br/><b>Temporary Mobile Phone</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }], "system" : "phone", "value" : "...", "use" : "temp" } <br/><b>Primary Work Mobile Phone</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "MC", "display" : "Mobile Phone" }] } }], "system" : "phone", "value" : "...", "use" : "work" } <br/><b>Primary Home Pager</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }], "system" : "pager", "value" : "...", "use" : "home" } <br/><b>Temporary Pager</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }], "system" : "pager", "value" : "...", "use" : "temp" } <br/><b>Primary Work Pager</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "PG", "display" : "Pager" }] } }], "system" : "pager", "value" : "...", "use" : "work" } <br/><b>Private email address</b>:{ "system" : "email", "value" : "giesput@myweb.nl", "use" : "home" } <br/><b>Work email address</b>:{ "system" : "email", "value" : "example@workplace.nl", "use" : "work" } | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) )cpt-2: A system is required if a value is provided. ( value.empty() or system.exists() )org-3: The telecom of an organization can never be of use 'home' ( where(use = 'home').empty() ) | ||||
150. 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 | 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. | ||||
Short | AddressInformation | ||||
Comments | Note: address is for postal addresses, not physical locations. | ||||
Control | 0..* This element is affected by the following invariants: ele-1, nl-streetname-if-official-and-other-line-parts | ||||
Type | Address(nl-core-address) | ||||
Requirements | May need to keep track of the organization's addresses for contacting, billing or reporting requirements. | ||||
Alternate Names | AdresInformatie, Adresgegevens | ||||
Example | <br/><b>Example of a Vacation Home address</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HV", "display" : "Vakantie adres" }] } }], "use" : "temp", "line" : ["Binnenkant 12A Hoog"], "_line" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString" : "Binnenkant" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString" : "12" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix", "valueString" : "A" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID", "valueString" : "Hoog" }] }], "city" : "Amsterdam", "state" : "NH", "postalCode" : "1000AA", "country" : "NLD" } <br/><b>Example of a Primary Home address</b>:{ "extension" : [{ "url" : "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType", "valueCodeableConcept" : { "coding" : [{ "system" : "http://hl7.org/fhir/v3/AddressUse", "code" : "HP", "display" : "Officieel adres" }] } }, { "url" : "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official", "valueBoolean" : true }], "use" : "home", "line" : ["Binnenkant to 10"], "_line" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString" : "Binnenkant" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator", "valueString" : "to" }, { "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString" : "10" }] }], "city" : "Amsterdam", "state" : "NH", "postalCode" : "1001AA", "country" : "NLD" } | ||||
Invariants | 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() ) | ||||
152. Organization.partOf | |||||
Definition | The organization of which this organization forms a part. | ||||
Short | The organization of which this organization forms a part | ||||
Control | 0..1 | ||||
Type | Reference(nl-core-organization) | ||||
Summary | true | ||||
Requirements | Need to be able to track the hierarchy of organizations within an organization. | ||||
154. Organization.contact | |||||
Definition | Contact for the organization for a certain purpose. | ||||
Short | Contact for the organization for a certain purpose | ||||
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. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Requirements | Need to keep track of assigned contact points within bigger organization. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()) ) | ||||
156. 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. | ||||
Short | xml:id (or equivalent in JSON) | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
158. 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. | ||||
Short | Additional Content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
160. 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. | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
162. Organization.contact.purpose | |||||
Definition | Indicates a purpose for which the contact can be reached. | ||||
Short | The type of contact | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ContactEntityType (extensible to http://hl7.org/fhir/ValueSet/contactentity-type )The purpose for which you would contact a contact party | ||||
Type | CodeableConcept | ||||
Requirements | Need to distinguish between multiple contact persons. | ||||
164. Organization.contact.name | |||||
Definition | A name associated with the contact. | ||||
Short | A name associated with the contact | ||||
Control | 0..1 | ||||
Type | HumanName | ||||
Requirements | Need to be able to track the person by name. | ||||
166. Organization.contact.telecom | |||||
Definition | A contact detail (e.g. a telephone number or an email address) by which the party may be contacted. | ||||
Short | Contact details (telephone, email, etc.) for a contact | ||||
Control | 0..* | ||||
Type | ContactPoint | ||||
Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||
168. Organization.contact.address | |||||
Definition | Visiting or postal addresses for the contact. | ||||
Short | Visiting or postal addresses for the contact | ||||
Control | 0..1 | ||||
Type | Address | ||||
Requirements | May need to keep track of a contact party's address for contacting, billing or reporting requirements. | ||||
170. Organization.endpoint | |||||
Definition | Technical endpoints providing access to services operated for the organization. | ||||
Short | Technical endpoints providing access to services operated for the organization | ||||
Control | 0..* | ||||
Type | Reference(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. |