Koppeltaal 2.0 Implementation Guide (Full Documentation)
0.15.0 - ci-build
NL
Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v0.15.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2Organization | Version: 0.15.0 | |||
| Draft as of 2023-01-24 |
Realm: |
Computable Name: KT2_Organization | ||
Copyright/Legal: VZVZ |
||||
The Organization resource represents a formally or informally recognized grouping of people or organizations that collectively provide healthcare services. This includes healthcare providers, departments, community groups, and healthcare practice groups operating within the Koppeltaal ecosystem. The profile extends the NlcoreHealthcareProviderOrganization profile with Koppeltaal-specific requirements.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | NlcoreHealthcareProviderOrganization | HealthcareProvider Constraints: org-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
ΣC | 1..* | Identifier | HealthcareProviderIdentificationNumber Slice: Unordered, Open by value:$this |
![]() ![]() ![]() |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/ura | |
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
![]() ![]() ![]() |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/agb-z | |
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
![]() ![]() |
?!Σ | 1..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() |
Σ | 0..* | CodeableConcept | Kind of organization Slice: Unordered, Open by value:$this Binding: OrganizationType (example): Used to categorize the organization. |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | DepartmentSpecialty Binding: AfdelingSpecialismeCodelijst (required): Used to categorize the organization. |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | OrganizationType Binding: OrganisatieTypeCodelijst (required): Used to categorize the organization. |
![]() ![]() |
Σ | 0..1 | Reference(KT2_Organization) | The organization of which this organization forms a part |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-typeFrom the FHIR Standard | |
| Organization.type:departmentSpecialty | required | AfdelingSpecialismeCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.2.4--20200901000000 | |
| Organization.type:organizationType | required | OrganisatieTypeCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.2.3--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Organization.contact.telecom:telephoneNumbers, Organization.contact.telecom:emailAddresses | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Organization | 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-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
This structure is derived from NlcoreHealthcareProviderOrganization
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
NlcoreHealthcareProviderOrganization | |||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
![]() ![]() |
1..* | Identifier | HealthcareProviderIdentificationNumber | |
![]() ![]() |
1..1 | boolean | Whether the organization's record is still in active use | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..1 | Reference(KT2_Organization) | The organization of which this organization forms a part | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | NlcoreHealthcareProviderOrganization | HealthcareProvider Constraints: org-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
ΣC | 1..* | Identifier | HealthcareProviderIdentificationNumber Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/ura | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/agb-z | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
?!Σ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Kind of organization Slice: Unordered, Open by value:$this Binding: OrganizationType (example): Used to categorize the organization. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | DepartmentSpecialty Binding: AfdelingSpecialismeCodelijst (required): Used to categorize the organization. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | OrganizationType Binding: OrganisatieTypeCodelijst (required): Used to categorize the organization. | ||||
![]() ![]() |
ΣC | 0..1 | string | OrganizationName | ||||
![]() ![]() |
Σ | 0..1 | Reference(KT2_Organization) | The organization of which this organization forms a part | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Organization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-typeFrom the FHIR Standard | ||||
| Organization.type:departmentSpecialty | required | AfdelingSpecialismeCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.2.4--20200901000000 | ||||
| Organization.type:organizationType | required | OrganisatieTypeCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.2.3--20200901000000 | ||||
| Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typeFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Organization.contact.telecom:telephoneNumbers, Organization.contact.telecom:emailAddresses | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Organization | 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-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| nl-core-NameInformation-01 | warning | Organization.contact.name | If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage. : (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| zib-NameInformation-1 | error | Organization.contact.name | If a prefix for a family name is specified, the family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() | |
| zib-NameInformation-2 | error | Organization.contact.name | If the prefix for a partner family name is specified, the partner family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() |
This structure is derived from NlcoreHealthcareProviderOrganization
Summary
Mandatory: 2 elements
Prohibited: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | NlcoreHealthcareProviderOrganization | HealthcareProvider Constraints: org-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
ΣC | 1..* | Identifier | HealthcareProviderIdentificationNumber Slice: Unordered, Open by value:$this |
![]() ![]() ![]() |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/ura | |
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
![]() ![]() ![]() |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/agb-z | |
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
![]() ![]() |
?!Σ | 1..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() |
Σ | 0..* | CodeableConcept | Kind of organization Slice: Unordered, Open by value:$this Binding: OrganizationType (example): Used to categorize the organization. |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | DepartmentSpecialty Binding: AfdelingSpecialismeCodelijst (required): Used to categorize the organization. |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | OrganizationType Binding: OrganisatieTypeCodelijst (required): Used to categorize the organization. |
![]() ![]() |
Σ | 0..1 | Reference(KT2_Organization) | The organization of which this organization forms a part |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-typeFrom the FHIR Standard | |
| Organization.type:departmentSpecialty | required | AfdelingSpecialismeCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.2.4--20200901000000 | |
| Organization.type:organizationType | required | OrganisatieTypeCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.2.3--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Organization.contact.telecom:telephoneNumbers, Organization.contact.telecom:emailAddresses | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Organization | 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-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
Differential View
This structure is derived from NlcoreHealthcareProviderOrganization
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
NlcoreHealthcareProviderOrganization | |||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
![]() ![]() |
1..* | Identifier | HealthcareProviderIdentificationNumber | |
![]() ![]() |
1..1 | boolean | Whether the organization's record is still in active use | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
![]() ![]() |
0..1 | Reference(KT2_Organization) | The organization of which this organization forms a part | |
![]() ![]() |
0..0 | |||
![]() ![]() |
0..0 | |||
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | NlcoreHealthcareProviderOrganization | HealthcareProvider Constraints: org-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
ΣC | 1..* | Identifier | HealthcareProviderIdentificationNumber Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/ura | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/agb-z | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
?!Σ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Kind of organization Slice: Unordered, Open by value:$this Binding: OrganizationType (example): Used to categorize the organization. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | DepartmentSpecialty Binding: AfdelingSpecialismeCodelijst (required): Used to categorize the organization. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | OrganizationType Binding: OrganisatieTypeCodelijst (required): Used to categorize the organization. | ||||
![]() ![]() |
ΣC | 0..1 | string | OrganizationName | ||||
![]() ![]() |
Σ | 0..1 | Reference(KT2_Organization) | The organization of which this organization forms a part | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Organization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-typeFrom the FHIR Standard | ||||
| Organization.type:departmentSpecialty | required | AfdelingSpecialismeCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.2.4--20200901000000 | ||||
| Organization.type:organizationType | required | OrganisatieTypeCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.2.3--20200901000000 | ||||
| Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typeFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Organization.contact.telecom:telephoneNumbers, Organization.contact.telecom:emailAddresses | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Organization | 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-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| nl-core-NameInformation-01 | warning | Organization.contact.name | If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage. : (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| zib-NameInformation-1 | error | Organization.contact.name | If a prefix for a family name is specified, the family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() | |
| zib-NameInformation-2 | error | Organization.contact.name | If the prefix for a partner family name is specified, the partner family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() |
This structure is derived from NlcoreHealthcareProviderOrganization
Summary
Mandatory: 2 elements
Prohibited: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
The identifier element is mandatory and should contain at least one identifier for the organization. Common identifiers include:
Example:
{
"identifier": [{
"system": "http://fhir.nl/fhir/NamingSystem/agb-z",
"value": "12345678"
}]
}
The active element is required and indicates whether the organization's record is in active use.
Values:
true - Organization is activefalse - Organization is inactive/archivedThe name element should contain the official name of the organization as it should be displayed.
Organization types should follow the nl-core organization type coding when applicable.
When an organization is part of a larger organization (e.g., a department within a hospital), the partOf element must reference another KT2_Organization resource.
Example:
{
"partOf": {
"reference": "Organization/parent-hospital"
}
}
When specified, the endpoint element must reference KT2_Endpoint resources. This links the organization to its technical endpoints for service delivery.
Example:
{
"endpoint": [{
"reference": "Endpoint/org-endpoint-1"
}]
}
partOf element