Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions
| Official URL: http://nictiz.nl/fhir/StructureDefinition/nl-core-Payer-Organization | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: NlcorePayerOrganization | |||
Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
||||
Payers are organizations or individuals that pay for the healthcare supplied to the patient. These organizations or individuals can be: facilities or people who financially guarantee or who are responsible for the patient (such as parents or guardians of minors), organizations with direct financial responsibility, combinations of these or the patient themselves.
A derived profile from zib-Payer-Organization to provide a version better suited for implementation purposes. This profile augments the base profile with elements found in the various use cases that have adopted the zib.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ZibPayerOrganization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization | 0..* | ZibPayerOrganization | InsuranceCompany | |
  telecom:telephoneNumbers | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers | |
| telecom:emailAddresses | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses | |
  address | 0..* | NlcoreAddressInformation | AddressInformation | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | C | 0..* | ZibPayerOrganization | InsuranceCompany |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
  Slices for identifier | ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:$this |
  identifier:uzovi | ΣC | 0..1 | Identifier | IdentificationNumber Required Pattern: At least the following |
   system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/uzovi | |
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| Slices for telecom | C | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this |
 telecom:telephoneNumbers | C | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers |
 telecom:emailAddresses | C | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses |
| address | C | 0..* | NlcoreAddressInformation | AddressInformation |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Organization.telecom:telephoneNumbers, Organization.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 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom, Organization.telecom:telephoneNumbers, Organization.telecom:emailAddresses | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Organization | C | 0..* | ZibPayerOrganization | InsuranceCompany | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:$this | ||||
| identifier:uzovi | ΣC | 0..1 | Identifier | IdentificationNumber Required Pattern: At least the following | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 0..1 | CodeableConcept | Description of identifier | |||||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/uzovi | |||||
| value | 0..1 | string | The value that is unique | |||||
| period | 0..1 | Period | Time period when id is/was valid for use | |||||
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
| type | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||
| name | ΣC | 0..1 | string | OrganizationName / PayerName | ||||
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| Slices for telecom | C | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this | ||||
| telecom:telephoneNumbers | C | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers | ||||
| telecom:emailAddresses | C | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses | ||||
| address | C | 0..* | NlcoreAddressInformation | AddressInformation | ||||
 partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
| contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
| name | 0..1 | HumanName | A name associated with the contact | |||||
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
| address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Organization.language | preferred | CommonLanguages
| ||||
| Organization.type | example | OrganizationType | ||||
| Organization.contact.purpose | extensible | ContactEntityType |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Organization.telecom:telephoneNumbers, Organization.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 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom, Organization.telecom:telephoneNumbers, Organization.telecom:emailAddresses | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from ZibPayerOrganization
Summary
Structures
This structure refers to these other structures:
Differential View
This structure is derived from ZibPayerOrganization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | 0..* | ZibPayerOrganization | InsuranceCompany | |
| telecom:telephoneNumbers | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers | |
| telecom:emailAddresses | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses | |
| address | 0..* | NlcoreAddressInformation | AddressInformation | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | C | 0..* | ZibPayerOrganization | InsuranceCompany |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:$this |
| identifier:uzovi | ΣC | 0..1 | Identifier | IdentificationNumber Required Pattern: At least the following |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/uzovi | |
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| Slices for telecom | C | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this |
| telecom:telephoneNumbers | C | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers |
| telecom:emailAddresses | C | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses |
| address | C | 0..* | NlcoreAddressInformation | AddressInformation |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Organization.telecom:telephoneNumbers, Organization.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 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom, Organization.telecom:telephoneNumbers, Organization.telecom:emailAddresses | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Organization | C | 0..* | ZibPayerOrganization | InsuranceCompany | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:$this | ||||
| identifier:uzovi | ΣC | 0..1 | Identifier | IdentificationNumber Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 0..1 | CodeableConcept | Description of identifier | |||||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/uzovi | |||||
| value | 0..1 | string | The value that is unique | |||||
| period | 0..1 | Period | Time period when id is/was valid for use | |||||
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
| type | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||
| name | ΣC | 0..1 | string | OrganizationName / PayerName | ||||
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| Slices for telecom | C | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this | ||||
| telecom:telephoneNumbers | C | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers | ||||
| telecom:emailAddresses | C | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses | ||||
| address | C | 0..* | NlcoreAddressInformation | AddressInformation | ||||
| partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
| contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
| name | 0..1 | HumanName | A name associated with the contact | |||||
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
| address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Organization.language | preferred | CommonLanguages
| ||||
| Organization.type | example | OrganizationType | ||||
| Organization.contact.purpose | extensible | ContactEntityType |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | Organization.telecom:telephoneNumbers, Organization.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 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom, Organization.telecom:telephoneNumbers, Organization.telecom:emailAddresses | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from ZibPayerOrganization
Summary
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron