IKNL PZP STU3
1.0.0-alpha1 - consultation International flag

IKNL PZP STU3, published by IKNL. This guide is not an authorized publication; it is the continuous build for version 1.0.0-alpha1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IKNL/PZP-FHIR-STU3/ and changes regularly. See the Directory of published versions

Resource Profile: ContactPerson

Official URL: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-ContactPerson Version: 1.0.0-alpha1
Draft as of 2025-10-23 Computable Name: ACPContactPerson

Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.

A person not being a healthcare professional who is involved in the patient’s care, such as family members, caregivers, mental caretakers, guardians and legal representatives. Based on nl-core-ContactPerson and HCIM ContactPerson.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* nl-core-relatedperson(2.0.5) An person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:role 0..* (Complex) Optional Extensions Element
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role
..... url 1..1 uri "http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role"
..... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept Role
Binding: RolCodelijst (2017-12-31T00:00:00) (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient Σ 1..1 Reference(Patient(1.0.0-alpha1)) The patient this person is related to
... relationship Σ 0..1 CodeableConcept Relationship
Binding: RelatieCodelijst (2017-12-31T00:00:00) (extensible)
... name Σ 0..* nl-core-humanname(2.0.10) NameInformation
.... Slices for extension Content/Rules for all slices
..... extension:humannameAssemblyOrder 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
...... Slices for valueCode Content/Rules for all slices
....... valueCode:valueCode 0..1 code Value of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name
.... given Σ 0..* string Given
This repeating element order: Given Names appear in the correct order for presenting the name
..... Slices for extension Content/Rules for all slices
...... extension:iso21090EnQualifier 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... Slices for valueCode Content/Rules for all slices
........ valueCode:valueCode 0..1 code Value of extension
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type
... telecom Σ 0..* nl-core-contactpoint(2.0.8) A contact detail for the person
.... Slices for extension Content/Rules for all slices
..... extension:TelecomType 0..1 (Complex) Provides the specific HCIM code for TelecomType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: TelecomTypeCodelijst (2017-12-31T00:00:00) (required): TelecomTypeCodelijst
.... system ΣC 1..1 code TelecomType / EmailAddressType
Binding: ContactPointSystem (required)
.... value Σ 0..1 string TelephoneNumber / EmailAddress
Example Example TelephoneNumber international: +31611234567
Example Example EmailAddress: giesput@myweb.nl
.... use ?!Σ 0..1 code TelecomType / NumberType / EmailAddressType
Binding: ContactPointUse (required)
... address Σ 0..* nl-core-address(3.0.6) AddressInformation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.extension:role.​value[x]:valueCodeableConcept Base extensible RolCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
RelatedPerson.relationship Base extensible RelatieCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
RelatedPerson.name.extension:humannameAssemblyOrder.​valueCode:valueCode Base required HumanNameAssemblyOrder 📍3.0.2 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍3.0.2 FHIR Std.
RelatedPerson.name.given.​extension:iso21090EnQualifier.​valueCode:valueCode Base required EntityNamePartQualifier 📍3.0.2 FHIR Std.
RelatedPerson.telecom.​extension:TelecomType.​value[x]:valueCodeableConcept Base required TelecomTypeCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
RelatedPerson.telecom.​system Base required ContactPointSystem 📍3.0.2 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from nl-core-relatedperson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* nl-core-relatedperson(2.0.5) An person that is related to a patient, but who is not a direct target of care
... Slices for extension Content/Rules for all slices
.... extension:role 0..* nl core relatedperson role(2.0.1) Optional Extensions Element
... patient 1..1 Reference(Patient(1.0.0-alpha1)) The patient this person is related to
... relationship 0..1 CodeableConcept Relationship
.... use 0..1 code usual | official | temp | nickname | anonymous | old | maiden
.... family
..... Slices for extension Content/Rules for all slices
...... extension:humannameOwnPrefix 0..1 own-prefix Voorvoegsel derived from person's own surname
...... extension:humannameOwnName 0..1 own-name Portion derived from person's own surname
...... extension:humannamePartnerPrefix 0..1 partner-prefix Voorvoegsel derived from person's partner's surname
...... extension:humannamePartnerName 0..1 partner-name Portion derived from person's partner's surname
.... given 0..* string Given
... telecom 0..* nl-core-contactpoint(2.0.8) A contact detail for the person
.... Slices for extension Content/Rules for all slices
..... extension:TelecomType 0..1 Zib ContactInformation TelecomType(1.0.1) Provides the specific HCIM code for TelecomType
.... system 1..1 code TelecomType / EmailAddressType
.... value 0..1 string TelephoneNumber / EmailAddress
.... use 0..1 code TelecomType / NumberType / EmailAddressType
... address 0..* nl-core-address(3.0.6) AddressInformation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* nl-core-relatedperson(2.0.5) An person that is related to a patient, but who is not a direct target of care
... 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
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 Extension
Slice: Unordered, Open by value:url
.... extension:role 0..* (Complex) Optional Extensions Element
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role"
..... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept Role
Binding: RolCodelijst (2017-12-31T00:00:00) (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier A human identifier for this person
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient(1.0.0-alpha1)) The patient this person is related to
... relationship Σ 0..1 CodeableConcept Relationship
Binding: RelatieCodelijst (2017-12-31T00:00:00) (extensible)
... name Σ 0..* nl-core-humanname(2.0.10) NameInformation
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:humannameAssemblyOrder 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
...... Slices for valueCode Content/Rules for all slices
....... valueCode:valueCode 0..1 code Value of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Surname
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:humannameOwnPrefix 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
....... Slices for valueString Content/Rules for all slices
........ valueString:valueString 0..1 string Value of extension
...... extension:humannameOwnName 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
....... Slices for valueString Content/Rules for all slices
........ valueString:valueString 0..1 string Value of extension
...... extension:humannamePartnerPrefix 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
....... Slices for valueString Content/Rules for all slices
........ valueString:valueString 0..1 string Value of extension
...... extension:humannamePartnerName 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
....... Slices for valueString Content/Rules for all slices
........ valueString:valueString 0..1 string Value of extension
..... value 0..1 string Primitive value for string
Max Length:1048576
.... given Σ 0..* string Given
This repeating element order: Given Names appear in the correct order for presenting the name
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:iso21090EnQualifier 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... Slices for valueCode Content/Rules for all slices
........ valueCode:valueCode 0..1 code Value of extension
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type
..... value 0..1 string Primitive value for string
Max Length:1048576
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom Σ 0..* nl-core-contactpoint(2.0.8) A contact detail for the person
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:TelecomType 0..1 (Complex) Provides the specific HCIM code for TelecomType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: TelecomTypeCodelijst (2017-12-31T00:00:00) (required): TelecomTypeCodelijst
.... system ΣC 1..1 code TelecomType / EmailAddressType
Binding: ContactPointSystem (required)
.... value Σ 0..1 string TelephoneNumber / EmailAddress
Example Example TelephoneNumber international: +31611234567
Example Example EmailAddress: giesput@myweb.nl
.... use ?!Σ 0..1 code TelecomType / NumberType / EmailAddressType
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the related person was born
... address Σ 0..* nl-core-address(3.0.6) AddressInformation
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base extensible Common Languages 📍3.0.2 FHIR Std.
RelatedPerson.extension:role.​value[x]:valueCodeableConcept Base extensible RolCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
RelatedPerson.relationship Base extensible RelatieCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
RelatedPerson.name.extension:humannameAssemblyOrder.​valueCode:valueCode Base required HumanNameAssemblyOrder 📍3.0.2 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍3.0.2 FHIR Std.
RelatedPerson.name.given.​extension:iso21090EnQualifier.​valueCode:valueCode Base required EntityNamePartQualifier 📍3.0.2 FHIR Std.
RelatedPerson.telecom.​extension:TelecomType.​value[x]:valueCodeableConcept Base required TelecomTypeCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
RelatedPerson.telecom.​system Base required ContactPointSystem 📍3.0.2 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍3.0.2 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from nl-core-relatedperson

Summary

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* nl-core-relatedperson(2.0.5) An person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:role 0..* (Complex) Optional Extensions Element
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role
..... url 1..1 uri "http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role"
..... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept Role
Binding: RolCodelijst (2017-12-31T00:00:00) (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient Σ 1..1 Reference(Patient(1.0.0-alpha1)) The patient this person is related to
... relationship Σ 0..1 CodeableConcept Relationship
Binding: RelatieCodelijst (2017-12-31T00:00:00) (extensible)
... name Σ 0..* nl-core-humanname(2.0.10) NameInformation
.... Slices for extension Content/Rules for all slices
..... extension:humannameAssemblyOrder 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
...... Slices for valueCode Content/Rules for all slices
....... valueCode:valueCode 0..1 code Value of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name
.... given Σ 0..* string Given
This repeating element order: Given Names appear in the correct order for presenting the name
..... Slices for extension Content/Rules for all slices
...... extension:iso21090EnQualifier 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... Slices for valueCode Content/Rules for all slices
........ valueCode:valueCode 0..1 code Value of extension
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type
... telecom Σ 0..* nl-core-contactpoint(2.0.8) A contact detail for the person
.... Slices for extension Content/Rules for all slices
..... extension:TelecomType 0..1 (Complex) Provides the specific HCIM code for TelecomType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: TelecomTypeCodelijst (2017-12-31T00:00:00) (required): TelecomTypeCodelijst
.... system ΣC 1..1 code TelecomType / EmailAddressType
Binding: ContactPointSystem (required)
.... value Σ 0..1 string TelephoneNumber / EmailAddress
Example Example TelephoneNumber international: +31611234567
Example Example EmailAddress: giesput@myweb.nl
.... use ?!Σ 0..1 code TelecomType / NumberType / EmailAddressType
Binding: ContactPointUse (required)
... address Σ 0..* nl-core-address(3.0.6) AddressInformation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.extension:role.​value[x]:valueCodeableConcept Base extensible RolCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
RelatedPerson.relationship Base extensible RelatieCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
RelatedPerson.name.extension:humannameAssemblyOrder.​valueCode:valueCode Base required HumanNameAssemblyOrder 📍3.0.2 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍3.0.2 FHIR Std.
RelatedPerson.name.given.​extension:iso21090EnQualifier.​valueCode:valueCode Base required EntityNamePartQualifier 📍3.0.2 FHIR Std.
RelatedPerson.telecom.​extension:TelecomType.​value[x]:valueCodeableConcept Base required TelecomTypeCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
RelatedPerson.telecom.​system Base required ContactPointSystem 📍3.0.2 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from nl-core-relatedperson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* nl-core-relatedperson(2.0.5) An person that is related to a patient, but who is not a direct target of care
... Slices for extension Content/Rules for all slices
.... extension:role 0..* nl core relatedperson role(2.0.1) Optional Extensions Element
... patient 1..1 Reference(Patient(1.0.0-alpha1)) The patient this person is related to
... relationship 0..1 CodeableConcept Relationship
.... use 0..1 code usual | official | temp | nickname | anonymous | old | maiden
.... family
..... Slices for extension Content/Rules for all slices
...... extension:humannameOwnPrefix 0..1 own-prefix Voorvoegsel derived from person's own surname
...... extension:humannameOwnName 0..1 own-name Portion derived from person's own surname
...... extension:humannamePartnerPrefix 0..1 partner-prefix Voorvoegsel derived from person's partner's surname
...... extension:humannamePartnerName 0..1 partner-name Portion derived from person's partner's surname
.... given 0..* string Given
... telecom 0..* nl-core-contactpoint(2.0.8) A contact detail for the person
.... Slices for extension Content/Rules for all slices
..... extension:TelecomType 0..1 Zib ContactInformation TelecomType(1.0.1) Provides the specific HCIM code for TelecomType
.... system 1..1 code TelecomType / EmailAddressType
.... value 0..1 string TelephoneNumber / EmailAddress
.... use 0..1 code TelecomType / NumberType / EmailAddressType
... address 0..* nl-core-address(3.0.6) AddressInformation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* nl-core-relatedperson(2.0.5) An person that is related to a patient, but who is not a direct target of care
... 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
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 Extension
Slice: Unordered, Open by value:url
.... extension:role 0..* (Complex) Optional Extensions Element
URL: http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role"
..... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept 1..1 CodeableConcept Role
Binding: RolCodelijst (2017-12-31T00:00:00) (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier A human identifier for this person
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient(1.0.0-alpha1)) The patient this person is related to
... relationship Σ 0..1 CodeableConcept Relationship
Binding: RelatieCodelijst (2017-12-31T00:00:00) (extensible)
... name Σ 0..* nl-core-humanname(2.0.10) NameInformation
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:humannameAssemblyOrder 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
...... Slices for valueCode Content/Rules for all slices
....... valueCode:valueCode 0..1 code Value of extension
Binding: HumanNameAssemblyOrder (required): A code that represents the preferred display order of the components of a human name
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Surname
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:humannameOwnPrefix 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
....... Slices for valueString Content/Rules for all slices
........ valueString:valueString 0..1 string Value of extension
...... extension:humannameOwnName 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
....... Slices for valueString Content/Rules for all slices
........ valueString:valueString 0..1 string Value of extension
...... extension:humannamePartnerPrefix 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
....... Slices for valueString Content/Rules for all slices
........ valueString:valueString 0..1 string Value of extension
...... extension:humannamePartnerName 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
....... Slices for valueString Content/Rules for all slices
........ valueString:valueString 0..1 string Value of extension
..... value 0..1 string Primitive value for string
Max Length:1048576
.... given Σ 0..* string Given
This repeating element order: Given Names appear in the correct order for presenting the name
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:iso21090EnQualifier 0..1 (Complex) LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
....... Slices for valueCode Content/Rules for all slices
........ valueCode:valueCode 0..1 code Value of extension
Binding: EntityNamePartQualifier (required): A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type
..... value 0..1 string Primitive value for string
Max Length:1048576
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom Σ 0..* nl-core-contactpoint(2.0.8) A contact detail for the person
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:TelecomType 0..1 (Complex) Provides the specific HCIM code for TelecomType
URL: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType
...... id 0..1 string xml:id (or equivalent in JSON)
...... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType"
...... Slices for value[x] 1..1 CodeableConcept Value of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 1..1 CodeableConcept Value of extension
Binding: TelecomTypeCodelijst (2017-12-31T00:00:00) (required): TelecomTypeCodelijst
.... system ΣC 1..1 code TelecomType / EmailAddressType
Binding: ContactPointSystem (required)
.... value Σ 0..1 string TelephoneNumber / EmailAddress
Example Example TelephoneNumber international: +31611234567
Example Example EmailAddress: giesput@myweb.nl
.... use ?!Σ 0..1 code TelecomType / NumberType / EmailAddressType
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the related person was born
... address Σ 0..* nl-core-address(3.0.6) AddressInformation
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base extensible Common Languages 📍3.0.2 FHIR Std.
RelatedPerson.extension:role.​value[x]:valueCodeableConcept Base extensible RolCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
RelatedPerson.relationship Base extensible RelatieCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
RelatedPerson.name.extension:humannameAssemblyOrder.​valueCode:valueCode Base required HumanNameAssemblyOrder 📍3.0.2 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍3.0.2 FHIR Std.
RelatedPerson.name.given.​extension:iso21090EnQualifier.​valueCode:valueCode Base required EntityNamePartQualifier 📍3.0.2 FHIR Std.
RelatedPerson.telecom.​extension:TelecomType.​value[x]:valueCodeableConcept Base required TelecomTypeCodelijst 📍2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.2
RelatedPerson.telecom.​system Base required ContactPointSystem 📍3.0.2 FHIR Std.
RelatedPerson.telecom.​use Base required ContactPointUse 📍3.0.2 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from nl-core-relatedperson

Summary

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron