Koppeltaal 2.0 Implementation Guide
0.9.0 - ci-build
Koppeltaal 2.0 Implementation Guide - Local Development build (v0.9.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2RelatedPerson | Version: 0.9.0 | |||
| Draft as of 2025-04-11 | Computable Name: KT2_RelatedPerson | |||
Copyright/Legal: VZVZ |
||||
A related person is a person with a specific role and/or relationship to the patient to assist in the therapy
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | NlcoreContactPerson | Contact dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..* | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
Σ | 1..* | Identifier | A human identifier for this person ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
?!Σ | 1..1 | boolean | Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
ΣC | 1..1 | Reference(KT2_Patient) | The patient this person is related to ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() |
Σ | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Closed by value:$this Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role Binding: RolCodelijst (required): The nature of the relationship between a patient and the related person. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣN | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required): The nature of the relationship between a patient and the related person. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 1..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣC | 0..2 | NlcoreNameInformation | NameInformation ele-1: All FHIR elements must have a @value or children zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well nl-core-NameInformation-01: 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. |
![]() ![]() ![]() |
ΣN | 0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
ΣCN | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣCN | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣCN | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 1..1 | date | The date on which the related person was born ele-1: All FHIR elements must have a @value or children |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | |
| RelatedPerson.relationship:role | required | RolCodelijsthttp://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 | RelatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 | |
| RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom, 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() | |
| nl-core-NameInformation-01 | warning | RelatedPerson.name:nameInformation | 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() | |
| ref-1 | error | RelatedPerson.patient | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
| 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 NlcoreContactPerson
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
NlcoreContactPerson | |||
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..* | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
![]() ![]() |
1..* | Identifier | A human identifier for this person | |
![]() ![]() |
1..1 | boolean | Whether this related person's record is in active use | |
![]() ![]() |
1..1 | Reference(KT2_Patient) | The patient this person is related to | |
![]() ![]() |
1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Closed by value:$this | |
![]() ![]() ![]() |
0..* | CodeableConcept | Role | |
![]() ![]() |
1..* | HumanName | NameInformation / PayerName | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..2 | NlcoreNameInformation | NameInformation | |
![]() ![]() |
1..1 | code | male | female | other | unknown | |
![]() ![]() |
1..1 | date | The date on which the related person was born | |
![]() ![]() |
0..0 | |||
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | NlcoreContactPerson | Contact dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
![]() ![]() |
Σ | 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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
Σ | 1..* | Identifier | A human identifier for this person | ||||
![]() ![]() |
?!Σ | 1..1 | boolean | Whether this related person's record is in active use | ||||
![]() ![]() |
ΣC | 1..1 | Reference(KT2_Patient) | The patient this person is related to ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() |
Σ | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Closed by value:$this Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role Binding: RolCodelijst (required): The nature of the relationship between a patient and the related person. | ||||
![]() ![]() ![]() |
ΣN | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required): The nature of the relationship between a patient and the related person. | ||||
![]() ![]() |
Σ | 1..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() |
ΣC | 0..2 | NlcoreNameInformation | NameInformation zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well nl-core-NameInformation-01: 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. | ||||
![]() ![]() ![]() |
ΣN | 0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage | ||||
![]() ![]() |
ΣCN | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this cpt-2: A system is required if a value is provided. | ||||
![]() ![]() ![]() |
ΣCN | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers cpt-2: A system is required if a value is provided. | ||||
![]() ![]() ![]() |
ΣCN | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses cpt-2: A system is required if a value is provided. | ||||
![]() ![]() |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
Σ | 1..1 | date | The date on which the related person was born | ||||
![]() ![]() |
Σ | 0..* | NlcoreAddressInformation | AddressInformation | ||||
![]() ![]() |
C | 0..1 | Period | Period of time that this relationship is considered valid per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
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.
| |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | ||||
| RelatedPerson.relationship:role | required | RolCodelijsthttp://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 | RelatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 | ||||
| RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom, 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() | |
| nl-core-NameInformation-01 | warning | RelatedPerson.name:nameInformation | 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() | |
| per-1 | error | RelatedPerson.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| ref-1 | error | RelatedPerson.patient | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
| 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 NlcoreContactPerson
Summary
Mandatory: 6 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | NlcoreContactPerson | Contact dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..* | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
Σ | 1..* | Identifier | A human identifier for this person ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
?!Σ | 1..1 | boolean | Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
ΣC | 1..1 | Reference(KT2_Patient) | The patient this person is related to ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() |
Σ | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Closed by value:$this Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role Binding: RolCodelijst (required): The nature of the relationship between a patient and the related person. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣN | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required): The nature of the relationship between a patient and the related person. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 1..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣC | 0..2 | NlcoreNameInformation | NameInformation ele-1: All FHIR elements must have a @value or children zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well nl-core-NameInformation-01: 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. |
![]() ![]() ![]() |
ΣN | 0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
ΣCN | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣCN | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣCN | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses cpt-2: A system is required if a value is provided. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
Σ | 1..1 | date | The date on which the related person was born ele-1: All FHIR elements must have a @value or children |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | |
| RelatedPerson.relationship:role | required | RolCodelijsthttp://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 | RelatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 | |
| RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom, 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() | |
| nl-core-NameInformation-01 | warning | RelatedPerson.name:nameInformation | 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() | |
| ref-1 | error | RelatedPerson.patient | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
| 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() |
Differential View
This structure is derived from NlcoreContactPerson
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
NlcoreContactPerson | |||
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..* | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
![]() ![]() |
1..* | Identifier | A human identifier for this person | |
![]() ![]() |
1..1 | boolean | Whether this related person's record is in active use | |
![]() ![]() |
1..1 | Reference(KT2_Patient) | The patient this person is related to | |
![]() ![]() |
1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Closed by value:$this | |
![]() ![]() ![]() |
0..* | CodeableConcept | Role | |
![]() ![]() |
1..* | HumanName | NameInformation / PayerName | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..2 | NlcoreNameInformation | NameInformation | |
![]() ![]() |
1..1 | code | male | female | other | unknown | |
![]() ![]() |
1..1 | date | The date on which the related person was born | |
![]() ![]() |
0..0 | |||
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | NlcoreContactPerson | Contact dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
![]() ![]() |
Σ | 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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..* | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() |
Σ | 1..* | Identifier | A human identifier for this person | ||||
![]() ![]() |
?!Σ | 1..1 | boolean | Whether this related person's record is in active use | ||||
![]() ![]() |
ΣC | 1..1 | Reference(KT2_Patient) | The patient this person is related to ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() |
Σ | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Closed by value:$this Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role Binding: RolCodelijst (required): The nature of the relationship between a patient and the related person. | ||||
![]() ![]() ![]() |
ΣN | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required): The nature of the relationship between a patient and the related person. | ||||
![]() ![]() |
Σ | 1..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() |
ΣC | 0..2 | NlcoreNameInformation | NameInformation zib-NameInformation-1: If a prefix for a family name is specified, the family name is expected as well zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well nl-core-NameInformation-01: 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. | ||||
![]() ![]() ![]() |
ΣN | 0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage | ||||
![]() ![]() |
ΣCN | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this cpt-2: A system is required if a value is provided. | ||||
![]() ![]() ![]() |
ΣCN | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers cpt-2: A system is required if a value is provided. | ||||
![]() ![]() ![]() |
ΣCN | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses cpt-2: A system is required if a value is provided. | ||||
![]() ![]() |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
Σ | 1..1 | date | The date on which the related person was born | ||||
![]() ![]() |
Σ | 0..* | NlcoreAddressInformation | AddressInformation | ||||
![]() ![]() |
C | 0..1 | Period | Period of time that this relationship is considered valid per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
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.
| |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | ||||
| RelatedPerson.relationship:role | required | RolCodelijsthttp://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 | RelatieCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000 | ||||
| RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom, 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() | |
| nl-core-NameInformation-01 | warning | RelatedPerson.name:nameInformation | 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() | |
| per-1 | error | RelatedPerson.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| ref-1 | error | RelatedPerson.patient | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
| 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 NlcoreContactPerson
Summary
Mandatory: 6 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
The relationship(s) that the Patient has with the RelatedPerson can be documented using various code systems. Below, three examples are provided.
A Patient can maintain multiple relationship types with a RelatedPerson.
{
"relationship": [
{
"coding": [
{
"system": "http://terminology.h17.org/Codesystem/v3-RoleCode",
"code": "MTH",
"display": "Mother"
}
]
},
{
"coding": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.3.11.22.472",
"code": "21",
"display": "Cliëntondersteuner"
}
]
}
]
}
The KT2_RelatedPerson.patient element contains the reference to the Patient to which the given RelatedPerson is linked. See the example below:
{
"patient": {
"reference": "Patient/${PatientID}"
}
}