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-ContactPerson | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: NlcoreContactPerson | |||
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. |
||||
A contact is a person not being a healthcare professional who is involved in the patient’s care, such as family members, caregivers, mental caretakers, guardians and legal representatives.
In addition to identification information such as the name, address and contact information can also be entered. The relationship to the patient and the role this person has can be entered as well.
A derived profile from zib-ContactPerson 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 ZibContactPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson | 0..* | ZibContactPerson | Contact | |
  patient | 1..1 | Reference(Patient | nl core Patient) | The patient this person is related to | |
 name:nameInformation | 0..2 | NlcoreNameInformation | NameInformation | |
| name:nameInformation-GivenName | 0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage | |
| telecom:telephoneNumbers | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers | |
| telecom:emailAddresses | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses | |
  address | 0..* | NlcoreAddressInformation | AddressInformation | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| RelatedPerson.relationship | preferred | PatientRelationshipType |
| RelatedPerson.relationship:role | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 |
| RelatedPerson.relationship:relationship | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:emailAddresses | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | 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() | |
| zib-NameInformation-1 | error | RelatedPerson.name:nameInformation | 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 | RelatedPerson.name:nameInformation | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson | 0..* | ZibContactPerson | Contact | |||||
 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 | ||||
| identifier | Σ | 0..* | Identifier | A human identifier for this person | ||||
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||
| patient | Σ | 1..1 | Reference(Patient | nl core Patient) | The patient this person is related to | ||||
  Slices for relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by value:$this Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
  relationship:role | Σ | 0..* | CodeableConcept | Role Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 (required) | ||||
 relationship:relationship | Σ | 0..* | CodeableConcept | Relationship Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 (required) | ||||
| Slices for name | Σ | 0..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use | ||||
| name:nameInformation | C | 0..2 | NlcoreNameInformation | NameInformation | ||||
| name:nameInformation-GivenName | 0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage | |||||
| Slices for telecom | Σ | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this | ||||
| telecom:telephoneNumbers | C | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers | ||||
| telecom:emailAddresses | C | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date on which the related person was born | ||||
| address | 0..* | NlcoreAddressInformation | AddressInformation | |||||
| photo | 0..* | Attachment | Image of the person | |||||
| period | 0..1 | Period | Period of time that this relationship is considered valid | |||||
 communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
 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 | ||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| RelatedPerson.language | preferred | CommonLanguages
| ||||
| RelatedPerson.relationship | preferred | PatientRelationshipType | ||||
| RelatedPerson.relationship:role | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 | ||||
| RelatedPerson.relationship:relationship | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 | ||||
| RelatedPerson.gender | required | AdministrativeGender | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
|
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:emailAddresses | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | 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() | |
| zib-NameInformation-1 | error | RelatedPerson.name:nameInformation | 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 | RelatedPerson.name:nameInformation | 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 ZibContactPerson
Summary
Structures
This structure refers to these other structures:
Differential View
This structure is derived from ZibContactPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | ZibContactPerson | Contact | |
| patient | 1..1 | Reference(Patient | nl core Patient) | The patient this person is related to | |
| name:nameInformation | 0..2 | NlcoreNameInformation | NameInformation | |
| name:nameInformation-GivenName | 0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage | |
| telecom:telephoneNumbers | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers | |
| telecom:emailAddresses | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses | |
| address | 0..* | NlcoreAddressInformation | AddressInformation | |
| Documentation for this format | ||||
Key Elements View
| Path | Conformance | ValueSet |
| RelatedPerson.relationship | preferred | PatientRelationshipType |
| RelatedPerson.relationship:role | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 |
| RelatedPerson.relationship:relationship | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:emailAddresses | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | 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() | |
| zib-NameInformation-1 | error | RelatedPerson.name:nameInformation | 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 | RelatedPerson.name:nameInformation | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson | 0..* | ZibContactPerson | Contact | |||||
| 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 | ||||
| identifier | Σ | 0..* | Identifier | A human identifier for this person | ||||
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use | ||||
| patient | Σ | 1..1 | Reference(Patient | nl core Patient) | The patient this person is related to | ||||
| Slices for relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by value:$this Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
| relationship:role | Σ | 0..* | CodeableConcept | Role Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 (required) | ||||
| relationship:relationship | Σ | 0..* | CodeableConcept | Relationship Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 (required) | ||||
| Slices for name | Σ | 0..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use | ||||
| name:nameInformation | C | 0..2 | NlcoreNameInformation | NameInformation | ||||
| name:nameInformation-GivenName | 0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage | |||||
| Slices for telecom | Σ | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this | ||||
| telecom:telephoneNumbers | C | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers | ||||
| telecom:emailAddresses | C | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date on which the related person was born | ||||
| address | 0..* | NlcoreAddressInformation | AddressInformation | |||||
| photo | 0..* | Attachment | Image of the person | |||||
| period | 0..1 | Period | Period of time that this relationship is considered valid | |||||
| communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
| 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 | ||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| RelatedPerson.language | preferred | CommonLanguages
| ||||
| RelatedPerson.relationship | preferred | PatientRelationshipType | ||||
| RelatedPerson.relationship:role | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000 | ||||
| RelatedPerson.relationship:relationship | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 | ||||
| RelatedPerson.gender | required | AdministrativeGender | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
|
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:emailAddresses | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | RelatedPerson | 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 | RelatedPerson | 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 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | RelatedPerson | 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() | |
| zib-NameInformation-1 | error | RelatedPerson.name:nameInformation | 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 | RelatedPerson.name:nameInformation | 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 ZibContactPerson
Summary
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron