Koppeltaal 2.0 Implementation Guide (Full Documentation)
1.4.5-beta.011 - ci-build
Koppeltaal 2.0 Implementation Guide (Full Documentation)
1.4.5-beta.011 - ci-build
Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v1.4.5-beta.011) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2RelatedPerson | Version: 1.4.5-beta.011 | |||
| Draft as of 2025-10-13 | Computable Name: KT2_RelatedPerson | |||
Copyright/Legal: VZVZ |
||||
The RelatedPerson resource represents an individual who has a personal or professional relationship with a patient and may be involved in their care. This includes family members, caregivers, legal guardians, and other support persons who assist in the patient's therapy and treatment. The profile extends the NlcoreContactPerson 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:   |
|---|---|---|---|---|
  RelatedPerson |
0..* | NlcoreContactPerson | Contact Constraints: dom-2, dom-3, dom-4, dom-5, dom-6 | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
Content/Rules for all slices | |||
   extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
 identifier |
Σ | 1..* | Identifier | A human identifier for this person |
| active |
?!Σ | 1..1 | boolean | Whether this related person's record is in active use |
 patient |
ΣC | 1..1 | Reference(KT2_Patient) | The patient this person is related to Constraints: ref-1 |
| Slices for relationship |
Σ | 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. |
 relationship:role |
Σ | 0..* | CodeableConcept | Role Binding: RolCodelijst (required): The nature of the relationship between a patient and the related person. |
| relationship:relationship |
ΣN | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required): The nature of the relationship between a patient and the related person. |
| Slices for name |
Σ | 1..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use |
| name:nameInformation |
ΣC | 0..2 | NlcoreNameInformation | NameInformation Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01 |
| name:nameInformation-GivenName |
ΣN | 0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage |
| Slices for telecom |
ΣCN | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this Constraints: cpt-2 |
| telecom:telephoneNumbers |
ΣCN | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers Constraints: cpt-2 |
| telecom:emailAddresses |
ΣCN | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses Constraints: cpt-2 |
| gender |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
 birthDate |
Σ | 1..1 | date | The date on which the related person was born |
| 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 Filter: |
|---|---|---|---|---|
| RelatedPerson |
NlcoreContactPerson | |||
| Slices for extension |
Content/Rules for all slices | |||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
 identifier |
1..* | Identifier | A human identifier for this person | |
| active |
1..1 | boolean | Whether this related person's record is in active use | |
| patient |
1..1 | Reference(KT2_Patient) | The patient this person is related to | |
| Slices for relationship |
1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Closed by value:$this | |
| relationship:role |
0..* | CodeableConcept | Role | |
| name |
1..* | HumanName | NameInformation / PayerName | |
| Slices for name |
Content/Rules for all slices | |||
| name:nameInformation |
0..2 | NlcoreNameInformation | NameInformation | |
| gender |
1..1 | code | male | female | other | unknown | |
| birthDate |
1..1 | date | The date on which the related person was born | |
| photo |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | NlcoreContactPerson | Contact Constraints: dom-2, dom-3, dom-4, dom-5, dom-6 | |||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier |
Σ | 1..* | Identifier | A human identifier for this person | ||||
| active |
?!Σ | 1..1 | boolean | Whether this related person's record is in active use | ||||
| patient |
ΣC | 1..1 | Reference(KT2_Patient) | The patient this person is related to Constraints: ref-1 | ||||
| Slices for relationship |
Σ | 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. | ||||
| relationship:role |
Σ | 0..* | CodeableConcept | Role Binding: RolCodelijst (required): The nature of the relationship between a patient and the related person. | ||||
| relationship:relationship |
ΣN | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required): The nature of the relationship between a patient and the related person. | ||||
| Slices for name |
Σ | 1..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use | ||||
| name:nameInformation |
ΣC | 0..2 | NlcoreNameInformation | NameInformation Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01 | ||||
| name:nameInformation-GivenName |
ΣN | 0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage | ||||
| Slices for telecom |
ΣCN | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this Constraints: cpt-2 | ||||
| telecom:telephoneNumbers |
ΣCN | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers Constraints: cpt-2 | ||||
| telecom:emailAddresses |
ΣCN | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses Constraints: cpt-2 | ||||
| gender |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 1..1 | date | The date on which the related person was born | ||||
| address |
Σ | 0..* | NlcoreAddressInformation | AddressInformation | ||||
| period |
C | 0..1 | Period | Period of time that this relationship is considered valid Constraints: per-1 | ||||
 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 Slice: Unordered, Open by value:url | |||||
| 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 | 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 Filter: |
|---|---|---|---|---|
| RelatedPerson |
0..* | NlcoreContactPerson | Contact Constraints: dom-2, dom-3, dom-4, dom-5, dom-6 | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| identifier |
Σ | 1..* | Identifier | A human identifier for this person |
| active |
?!Σ | 1..1 | boolean | Whether this related person's record is in active use |
| patient |
ΣC | 1..1 | Reference(KT2_Patient) | The patient this person is related to Constraints: ref-1 |
| Slices for relationship |
Σ | 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. |
| relationship:role |
Σ | 0..* | CodeableConcept | Role Binding: RolCodelijst (required): The nature of the relationship between a patient and the related person. |
| relationship:relationship |
ΣN | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required): The nature of the relationship between a patient and the related person. |
| Slices for name |
Σ | 1..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use |
| name:nameInformation |
ΣC | 0..2 | NlcoreNameInformation | NameInformation Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01 |
| name:nameInformation-GivenName |
ΣN | 0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage |
| Slices for telecom |
ΣCN | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this Constraints: cpt-2 |
| telecom:telephoneNumbers |
ΣCN | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers Constraints: cpt-2 |
| telecom:emailAddresses |
ΣCN | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses Constraints: cpt-2 |
| gender |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate |
Σ | 1..1 | date | The date on which the related person was born |
| 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 Filter: |
|---|---|---|---|---|
| RelatedPerson |
NlcoreContactPerson | |||
| Slices for extension |
Content/Rules for all slices | |||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |
| identifier |
1..* | Identifier | A human identifier for this person | |
| active |
1..1 | boolean | Whether this related person's record is in active use | |
| patient |
1..1 | Reference(KT2_Patient) | The patient this person is related to | |
| Slices for relationship |
1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Closed by value:$this | |
| relationship:role |
0..* | CodeableConcept | Role | |
| name |
1..* | HumanName | NameInformation / PayerName | |
| Slices for name |
Content/Rules for all slices | |||
| name:nameInformation |
0..2 | NlcoreNameInformation | NameInformation | |
| gender |
1..1 | code | male | female | other | unknown | |
| birthDate |
1..1 | date | The date on which the related person was born | |
| photo |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | NlcoreContactPerson | Contact Constraints: dom-2, dom-3, dom-4, dom-5, dom-6 | |||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:resource-origin |
0..1 | Reference(KT2_Device) | Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier |
Σ | 1..* | Identifier | A human identifier for this person | ||||
| active |
?!Σ | 1..1 | boolean | Whether this related person's record is in active use | ||||
| patient |
ΣC | 1..1 | Reference(KT2_Patient) | The patient this person is related to Constraints: ref-1 | ||||
| Slices for relationship |
Σ | 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. | ||||
| relationship:role |
Σ | 0..* | CodeableConcept | Role Binding: RolCodelijst (required): The nature of the relationship between a patient and the related person. | ||||
| relationship:relationship |
ΣN | 0..* | CodeableConcept | Relationship Binding: RelatieCodelijst (required): The nature of the relationship between a patient and the related person. | ||||
| Slices for name |
Σ | 1..* | HumanName | NameInformation / PayerName Slice: Unordered, Open by value:use | ||||
| name:nameInformation |
ΣC | 0..2 | NlcoreNameInformation | NameInformation Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01 | ||||
| name:nameInformation-GivenName |
ΣN | 0..* | NlcoreNameInformationGivenName | Name of a human - parts and usage | ||||
| Slices for telecom |
ΣCN | 0..* | ContactPoint | ContactInformation Slice: Unordered, Open by profile:$this Constraints: cpt-2 | ||||
| telecom:telephoneNumbers |
ΣCN | 0..* | NlcoreContactInformationTelephoneNumbers | TelephoneNumbers Constraints: cpt-2 | ||||
| telecom:emailAddresses |
ΣCN | 0..* | NlcoreContactInformationEmailAddresses | EmailAddresses Constraints: cpt-2 | ||||
| gender |
Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 1..1 | date | The date on which the related person was born | ||||
| address |
Σ | 0..* | NlcoreAddressInformation | AddressInformation | ||||
| period |
C | 0..1 | Period | Period of time that this relationship is considered valid Constraints: per-1 | ||||
| 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 Slice: Unordered, Open by value:url | |||||
| 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 | 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. A Patient can maintain multiple relationship types with a RelatedPerson.
Example:
{
"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 patient element contains the reference to the Patient to which the given RelatedPerson is linked:
{
"patient": {
"reference": "Patient/${PatientID}"
}
}
The following elements are mandatory:
identifier - At least one identifier for the related personactive - Indicates whether the record is in active usepatient - Reference to the associated KT2_Patientrelationship - At least one relationship codename - Name information following Dutch conventionsgender - Gender of the related personbirthDate - Birth date of the related personDue to an issue with the FHIR profile, validation warnings may be generated for the KT2_RelatedPerson resource:
This element does not match any known slice defined in the profile
These warnings should be ignored when the creation or update of the resource is successful. Focus on actual errors in the OperationOutcome resource rather than these informational warnings.