Koppeltaal 2.0 Implementation Guide
0.9.0 - ci-build Netherlands flag

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

Resource Profile: KT2_RelatedPerson

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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... extension:resource-origin 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
... modifierExtension ?! 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
... active ?!Σ 1..1 boolean Whether this related person's record is in active use
ele-1: All FHIR elements must have a @value or children
... patient Σ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
... 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.


ele-1: All FHIR elements must have a @value or children
.... relationship:role Σ 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
.... relationship:relationship Σ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
... Slices for name Σ 1..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... name:nameInformation Σ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.
.... name:nameInformation-GivenName ΣN 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
ele-1: All FHIR elements must have a @value or children
... Slices for telecom Σ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
.... telecom:telephoneNumbers Σ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
.... telecom:emailAddresses Σ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
... gender Σ 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
... birthDate Σ 1..1 date The date on which the related person was born
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.relationshippreferredPatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.relationship:rolerequiredRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
RelatedPerson.relationship:relationshiprequiredRelatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorRelatedPerson.telecom, RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:emailAddressesA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-NameInformation-01warningRelatedPerson.name:nameInformationIf 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-1errorRelatedPerson.patientSHALL 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-1errorRelatedPerson.name:nameInformationIf 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-2errorRelatedPerson.name:nameInformationIf 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson NlcoreContactPerson
... Slices for extension Content/Rules for all slices
.... extension:resource-origin 0..* 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
... 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 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
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... 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..* 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
ref-1: SHALL have a contained resource if a local reference is provided
... 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
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.
.... 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
cpt-2: A system is required if a value is provided.
.... telecom:telephoneNumbers ΣCN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
cpt-2: A system is required if a value is provided.
.... telecom:emailAddresses ΣCN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
cpt-2: A system is required if a value is provided.
... 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
per-1: If present, start SHALL have a lower value than end
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.relationshippreferredPatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.relationship:rolerequiredRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
RelatedPerson.relationship:relationshiprequiredRelatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
RelatedPerson.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorRelatedPerson.telecom, RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:emailAddressesA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-NameInformation-01warningRelatedPerson.name:nameInformationIf 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-1errorRelatedPerson.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorRelatedPerson.patientSHALL 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-1errorRelatedPerson.name:nameInformationIf 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-2errorRelatedPerson.name:nameInformationIf 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:

  • The element 1 is sliced based on the value of RelatedPerson.relationship (Closed)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... extension:resource-origin 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
... modifierExtension ?! 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
... active ?!Σ 1..1 boolean Whether this related person's record is in active use
ele-1: All FHIR elements must have a @value or children
... patient Σ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
... 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.


ele-1: All FHIR elements must have a @value or children
.... relationship:role Σ 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
.... relationship:relationship Σ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
... Slices for name Σ 1..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... name:nameInformation Σ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.
.... name:nameInformation-GivenName ΣN 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
ele-1: All FHIR elements must have a @value or children
... Slices for telecom Σ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
.... telecom:telephoneNumbers Σ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
.... telecom:emailAddresses Σ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
... gender Σ 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
... birthDate Σ 1..1 date The date on which the related person was born
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.relationshippreferredPatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.relationship:rolerequiredRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
RelatedPerson.relationship:relationshiprequiredRelatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorRelatedPerson.telecom, RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:emailAddressesA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-NameInformation-01warningRelatedPerson.name:nameInformationIf 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-1errorRelatedPerson.patientSHALL 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-1errorRelatedPerson.name:nameInformationIf 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-2errorRelatedPerson.name:nameInformationIf 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson NlcoreContactPerson
... Slices for extension Content/Rules for all slices
.... extension:resource-origin 0..* 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
... 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 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
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... 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..* 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
ref-1: SHALL have a contained resource if a local reference is provided
... 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
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.
.... 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
cpt-2: A system is required if a value is provided.
.... telecom:telephoneNumbers ΣCN 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
cpt-2: A system is required if a value is provided.
.... telecom:emailAddresses ΣCN 0..* NlcoreContactInformationEmailAddresses EmailAddresses
cpt-2: A system is required if a value is provided.
... 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
per-1: If present, start SHALL have a lower value than end
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.relationshippreferredPatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.relationship:rolerequiredRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
RelatedPerson.relationship:relationshiprequiredRelatieCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
RelatedPerson.communication.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorRelatedPerson.telecom, RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:emailAddressesA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
nl-core-NameInformation-01warningRelatedPerson.name:nameInformationIf 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-1errorRelatedPerson.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorRelatedPerson.patientSHALL 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-1errorRelatedPerson.name:nameInformationIf 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-2errorRelatedPerson.name:nameInformationIf 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:

  • The element 1 is sliced based on the value of RelatedPerson.relationship (Closed)

 

Other representations of profile: CSV, Excel, Schematron

Notes:

KT2_RelatedPerson.relationship

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.

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 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}"
  }
}

Unexpected validation Warnings

Due to an issue with the FHIR profile, the following validation warnings are generated for the `KT2_RelatedPerson` resource: > This element does not match any known slice defined in the profile http://koppeltaal.nl/fhir/StructureDefinition/KT2RelatedPerson|0.xx.xx This information notification is ignored when the creation or update of the resource is successful. However at the moment a resource contains an error, this information warning shows up in the `OperationOutcome`, potentially confusing / obfuscating the process of error assessment. We advise to ignore this _warning_ and focus on the _error_ in the `OperationOutcome` resource. Despite the effort to get this notification removed, the implementation team has not succeeded in removing the information notification.