ContactPerson

Profile	Description	Status	URL
HdBe-ContactPerson	A contact is a person not being a healthcare professional who is involved in the patient’s care, such as family members, caregivers, mental caretakers, guardians and legal representatives. In addition to identification information such as the name, address and contact information can also be entered. The relationship to the patient and the role this person has can be entered as well.	draft	https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson

Profile

Description

Status

URL

HdBe-ContactPerson

A contact is a person not being a healthcare professional who is involved in the patient’s care, such as family members, caregivers, mental caretakers, guardians and legal representatives.

In addition to identification information such as the name, address and contact information can also be entered. The relationship to the patient and the role this person has can be entered as well.

draft

https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson

Instructions

Instructions
Whereas the CBB ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons: The RelatedPerson resource, and therefore this profile, is used to capture information about any person that is related to the patient. Information about persons that should be contacted regarding the care for the patient is captured using the `Patient.contact` resource. If a person is both a related person and a contact person, then some data duplication is inevitable.

Whereas the CBB ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons:

The RelatedPerson resource, and therefore this profile, is used to capture information about any person that is related to the patient.
Information about persons that should be contacted regarding the care for the patient is captured using the Patient.contact resource.

If a person is both a related person and a contact person, then some data duplication is inevitable.

RelatedPerson	I		RelatedPerson	Element Id RelatedPerson Short description Contact Alternate names Contactpersoon Definition Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. Comments Whereas the CBB ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons: The RelatedPerson resource, and therefore this profile, is used to capture information about any person that is related to the patient. Information about persons that should be contacted regarding the care for the patient is captured using the `Patient.contact` resource. If a person is both a related person and a contact person, then some data duplication is inevitable. Data Type RelatedPerson Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: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-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 `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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:role zib-contactperson-v3.4-2020EN:NL-CM:3.1.1 HdBe-ContactPerson:contact
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id RelatedPerson.identifier Short description A human identifier for this person Definition Identifier for a person within a particular scope. Requirements People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier v2:NK1-33 rim:.id
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element Id RelatedPerson.active Short description Whether this related person's record is in active use Definition Whether this related person record is in active use. Requirements Need to be able to mark a related person record as not to be used, such as if it was created in error. Comments This element is labeled as a modifier because it may be used to mark that the resource was created in error. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:.statusCode
patient	Σ I	1..1	Reference(Patient\| HdBe Patient)	Element Id RelatedPerson.patient Short description The patient this person is related to Definition The patient this person is related to. Requirements We need to know which patient this RelatedPerson is related to. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(Patient\| HdBe Patient) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: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'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:PID-3 rim:scoper[classCode=PSN\|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id
relationship	Σ	0..*	CodeableConceptBinding	Element Id RelatedPerson.relationship Short description The nature of the relationship Definition The nature of the relationship between a patient and the related person. Requirements We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Sliced: Unordered, Open, by $this(Value) Binding The nature of the relationship between a patient and the related person. PatientRelationshipType (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class v2:NK1-3 rim:code
role	Σ	0..*	CodeableConceptBinding	Element Id RelatedPerson.relationship:role Short description Role Alternate names Rol Definition Defines the role of the contact in relation to the patient. Requirements We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding RolCodelijst Role (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class v2:NK1-3 rim:code zib-contactperson-v3.4-2020EN:NL-CM:3.1.2 HdBe-ContactPerson:role
relationship	Σ	0..*	CodeableConceptBinding	Element Id RelatedPerson.relationship:relationship Short description Relationship Alternate names Relatie Definition Defines the contact’s familial relationship to the patient. Requirements We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding RelatieCodelijst Relationship (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class v2:NK1-3 rim:code zib-contactperson-v3.4-2020EN:NL-CM:3.1.3 HdBe-ContactPerson:relationship
name	Σ I	0..*	HdBe NameInformation	Element Id RelatedPerson.name Short description NameInformation Alternate names Naamgegevens Definition Full name of the contact. Requirements Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Comments The cardinality mismatch between the CBB (0..1) and FHIR (0..) is explained by the presence of the HumanName.use element. A full name can be broken into parts using multiple instances of HumanName that have its own value for use. Data Type* HdBe NameInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a familiy name is specified, the family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2:If the prefix for a partner family name is specified, the partner family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` zib-NameInformation-3:If the name is specified as 'official' then the name is expected to contain only official parts `use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()` Examples Structured HumanName (preferred above unstructured) { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "text": "Irma Jongeneel-de Haas", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } Unstructured HumanName { "text": "Irma Jongeneel-de Haas" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:NK1-2 rim:name zib-nameinformation-v1.1-2020EN:NL-CM:20.4.1 HdBe-NameInformation:name_information zib-contactperson-v3.4-2020EN:NL-CM:3.1.4 HdBe-ContactInformation:name_information
telecom	Σ I	0..*	ContactPoint	Element Id RelatedPerson.telecom Short description ContactInformation Alternate names Contactgegevens Definition The contact’s telephone number and/or e-mail address. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The cardinality mismatch between the zib (0..1) and FHIR (0..) is explained by the containers TelephoneNumbers (0..) and EmailAddresses (0..) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. Data Type* ContactPoint Sliced: Unordered, Open, by $this(Profile) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5 / NK1-6 / NK1-40 rim:telecom zib-contactperson-v3.4-2020EN:NL-CM:3.1.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1 HdBe-ContactPerson:contact_information HdBe-ContactInformation:contact_information
telephoneNumbers	Σ I	0..*	HdBe ContactInformation TelephoneNumbers	Element Id RelatedPerson.telecom:telephoneNumbers Short description TelephoneNumbers Alternate names Telefoonnummers Definition Container of the TelephoneNumbers concept. This container contains all data elements of the TelephoneNumbers concept. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Implementation of the "TelephoneNumbers" concept of CBB ContactInformation. Please note that, although the concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the CBB uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the CBB code will need to be communicated using the codeSpecification extension. Data Type HdBe ContactInformation TelephoneNumbers Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5 / NK1-6 / NK1-40 rim:telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 HdBe-ContactInformation:telephone_numbers
emailAddresses	Σ I	0..*	HdBe ContactInformation EmailAddresses	Element Id RelatedPerson.telecom:emailAddresses Short description EmailAddresses Alternate names EmailAdressen Definition Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The "EmailAddresses" concept of CBB ContactInformation. Data Type HdBe ContactInformation EmailAddresses Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5 / NK1-6 / NK1-40 rim:telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:email_addresses
gender	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id RelatedPerson.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Requirements Needed for identification of the person, in combination with (at least) name and birth date. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:NK1-15 rim:administrativeGender
birthDate	Σ	0..1	date	There are no (further) constraints on this element Element Id RelatedPerson.birthDate Short description The date on which the related person was born Definition The date on which the related person was born. Data Type date Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:player.birthTime
address	Σ	0..*	HdBe AddressInformation	Element Id RelatedPerson.address Short description AddressInformation Alternate names Adresgegevens Definition Contact’s address information. Requirements Need to keep track where the related person can be contacted per postal mail or visited. Comments Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). Data Type HdBe AddressInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD rim:AD servd:Address v2:NK1-4 rim:addr zib-addressinformation-v1.1-2020EN:NL-CM:20.5.1 HdBe-AddressInformation:address_information zib-contactperson-v3.4-2020EN:NL-CM:3.1.5 HdBe-ContactInformation:address_information
photo	I	0..*	Attachment	There are no (further) constraints on this element Element Id RelatedPerson.photo Short description Image of the person Definition Image of the person. Requirements Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. Comments When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". Data Type Attachment Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` att-1:If the Attachment has data, it SHALL have a contentType `data.empty() or contentType.exists()` Mappings rim:n/a v2:ED/RP rim:ED v2:OBX-5 - needs a profile rim:player[classCode='PSN' and determinerCode='INSTANCE']/desc
period	I	0..1	Period	There are no (further) constraints on this element Element Id RelatedPerson.period Short description Period of time that this relationship is considered valid Definition The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5:FiveWs.done[x] rim:.effectiveTime
communication		0..*	BackboneElement	There are no (further) constraints on this element Element Id RelatedPerson.communication Short description A language which may be used to communicate with about the patient's health Definition A language which may be used to communicate with about the patient's health. Requirements If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. Comments If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:LanguageCommunication
language		1..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id RelatedPerson.communication.language Short description The language which can be used to communicate with the patient about his or her health Definition The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. Requirements Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. Comments The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Data Type CodeableConcept Binding A human language. CommonLanguages (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/languageCommunication/code
preferred		0..1	boolean	There are no (further) constraints on this element Element Id RelatedPerson.communication.preferred Short description Language preference indicator Definition Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). Requirements People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. Comments This language is specifically identified for communicating healthcare information. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:preferenceInd

RelatedPerson	I		RelatedPerson	Element Id RelatedPerson Short description Contact Alternate names Contactpersoon Definition Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. Comments Whereas the CBB ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons: The RelatedPerson resource, and therefore this profile, is used to capture information about any person that is related to the patient. Information about persons that should be contacted regarding the care for the patient is captured using the `Patient.contact` resource. If a person is both a related person and a contact person, then some data duplication is inevitable. Data Type RelatedPerson Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: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-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 `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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:role zib-contactperson-v3.4-2020EN:NL-CM:3.1.1 HdBe-ContactPerson:contact
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id RelatedPerson.identifier Short description A human identifier for this person Definition Identifier for a person within a particular scope. Requirements People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier v2:NK1-33 rim:.id
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element Id RelatedPerson.active Short description Whether this related person's record is in active use Definition Whether this related person record is in active use. Requirements Need to be able to mark a related person record as not to be used, such as if it was created in error. Comments This element is labeled as a modifier because it may be used to mark that the resource was created in error. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:.statusCode
patient	Σ I	1..1	Reference(Patient\| HdBe Patient)	Element Id RelatedPerson.patient Short description The patient this person is related to Definition The patient this person is related to. Requirements We need to know which patient this RelatedPerson is related to. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(Patient\| HdBe Patient) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: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'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:PID-3 rim:scoper[classCode=PSN\|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id
relationship	Σ	0..*	CodeableConceptBinding	Element Id RelatedPerson.relationship Short description The nature of the relationship Definition The nature of the relationship between a patient and the related person. Requirements We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Sliced: Unordered, Open, by $this(Value) Binding The nature of the relationship between a patient and the related person. PatientRelationshipType (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class v2:NK1-3 rim:code
role	Σ	0..*	CodeableConceptBinding	Element Id RelatedPerson.relationship:role Short description Role Alternate names Rol Definition Defines the role of the contact in relation to the patient. Requirements We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding RolCodelijst Role (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class v2:NK1-3 rim:code zib-contactperson-v3.4-2020EN:NL-CM:3.1.2 HdBe-ContactPerson:role
relationship	Σ	0..*	CodeableConceptBinding	Element Id RelatedPerson.relationship:relationship Short description Relationship Alternate names Relatie Definition Defines the contact’s familial relationship to the patient. Requirements We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding RelatieCodelijst Relationship (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class v2:NK1-3 rim:code zib-contactperson-v3.4-2020EN:NL-CM:3.1.3 HdBe-ContactPerson:relationship
name	Σ I	0..*	HdBe NameInformation	Element Id RelatedPerson.name Short description NameInformation Alternate names Naamgegevens Definition Full name of the contact. Requirements Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Comments The cardinality mismatch between the CBB (0..1) and FHIR (0..) is explained by the presence of the HumanName.use element. A full name can be broken into parts using multiple instances of HumanName that have its own value for use. Data Type* HdBe NameInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a familiy name is specified, the family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2:If the prefix for a partner family name is specified, the partner family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` zib-NameInformation-3:If the name is specified as 'official' then the name is expected to contain only official parts `use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()` Examples Structured HumanName (preferred above unstructured) { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "text": "Irma Jongeneel-de Haas", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } Unstructured HumanName { "text": "Irma Jongeneel-de Haas" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:NK1-2 rim:name zib-nameinformation-v1.1-2020EN:NL-CM:20.4.1 HdBe-NameInformation:name_information zib-contactperson-v3.4-2020EN:NL-CM:3.1.4 HdBe-ContactInformation:name_information
telecom	Σ I	0..*	ContactPoint	Element Id RelatedPerson.telecom Short description ContactInformation Alternate names Contactgegevens Definition The contact’s telephone number and/or e-mail address. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The cardinality mismatch between the zib (0..1) and FHIR (0..) is explained by the containers TelephoneNumbers (0..) and EmailAddresses (0..) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. Data Type* ContactPoint Sliced: Unordered, Open, by $this(Profile) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5 / NK1-6 / NK1-40 rim:telecom zib-contactperson-v3.4-2020EN:NL-CM:3.1.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1 HdBe-ContactPerson:contact_information HdBe-ContactInformation:contact_information
telephoneNumbers	Σ I	0..*	HdBe ContactInformation TelephoneNumbers	Element Id RelatedPerson.telecom:telephoneNumbers Short description TelephoneNumbers Alternate names Telefoonnummers Definition Container of the TelephoneNumbers concept. This container contains all data elements of the TelephoneNumbers concept. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Implementation of the "TelephoneNumbers" concept of CBB ContactInformation. Please note that, although the concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the CBB uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the CBB code will need to be communicated using the codeSpecification extension. Data Type HdBe ContactInformation TelephoneNumbers Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5 / NK1-6 / NK1-40 rim:telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 HdBe-ContactInformation:telephone_numbers
emailAddresses	Σ I	0..*	HdBe ContactInformation EmailAddresses	Element Id RelatedPerson.telecom:emailAddresses Short description EmailAddresses Alternate names EmailAdressen Definition Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The "EmailAddresses" concept of CBB ContactInformation. Data Type HdBe ContactInformation EmailAddresses Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5 / NK1-6 / NK1-40 rim:telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:email_addresses
gender	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id RelatedPerson.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Requirements Needed for identification of the person, in combination with (at least) name and birth date. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:NK1-15 rim:administrativeGender
birthDate	Σ	0..1	date	There are no (further) constraints on this element Element Id RelatedPerson.birthDate Short description The date on which the related person was born Definition The date on which the related person was born. Data Type date Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:player.birthTime
address	Σ	0..*	HdBe AddressInformation	Element Id RelatedPerson.address Short description AddressInformation Alternate names Adresgegevens Definition Contact’s address information. Requirements Need to keep track where the related person can be contacted per postal mail or visited. Comments Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). Data Type HdBe AddressInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD rim:AD servd:Address v2:NK1-4 rim:addr zib-addressinformation-v1.1-2020EN:NL-CM:20.5.1 HdBe-AddressInformation:address_information zib-contactperson-v3.4-2020EN:NL-CM:3.1.5 HdBe-ContactInformation:address_information
photo	I	0..*	Attachment	There are no (further) constraints on this element Element Id RelatedPerson.photo Short description Image of the person Definition Image of the person. Requirements Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. Comments When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". Data Type Attachment Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` att-1:If the Attachment has data, it SHALL have a contentType `data.empty() or contentType.exists()` Mappings rim:n/a v2:ED/RP rim:ED v2:OBX-5 - needs a profile rim:player[classCode='PSN' and determinerCode='INSTANCE']/desc
period	I	0..1	Period	There are no (further) constraints on this element Element Id RelatedPerson.period Short description Period of time that this relationship is considered valid Definition The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5:FiveWs.done[x] rim:.effectiveTime
communication		0..*	BackboneElement	There are no (further) constraints on this element Element Id RelatedPerson.communication Short description A language which may be used to communicate with about the patient's health Definition A language which may be used to communicate with about the patient's health. Requirements If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. Comments If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:LanguageCommunication
language		1..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id RelatedPerson.communication.language Short description The language which can be used to communicate with the patient about his or her health Definition The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. Requirements Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. Comments The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Data Type CodeableConcept Binding A human language. CommonLanguages (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/languageCommunication/code
preferred		0..1	boolean	There are no (further) constraints on this element Element Id RelatedPerson.communication.preferred Short description Language preference indicator Definition Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). Requirements People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. Comments This language is specifically identified for communicating healthcare information. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:preferenceInd

RelatedPerson	I		RelatedPerson	Element Id RelatedPerson Short description Contact Alternate names Contactpersoon Definition Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. Comments Whereas the CBB ContactPerson includes all (non-healthcare professional) persons that are involved in the care for a patient, FHIR distinguishes two use cases for these persons: The RelatedPerson resource, and therefore this profile, is used to capture information about any person that is related to the patient. Information about persons that should be contacted regarding the care for the patient is captured using the `Patient.contact` resource. If a person is both a related person and a contact person, then some data duplication is inevitable. Data Type RelatedPerson Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: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-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 `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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:role zib-contactperson-v3.4-2020EN:NL-CM:3.1.1 HdBe-ContactPerson:contact
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id RelatedPerson.identifier Short description A human identifier for this person Definition Identifier for a person within a particular scope. Requirements People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier v2:NK1-33 rim:.id
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element Id RelatedPerson.active Short description Whether this related person's record is in active use Definition Whether this related person record is in active use. Requirements Need to be able to mark a related person record as not to be used, such as if it was created in error. Comments This element is labeled as a modifier because it may be used to mark that the resource was created in error. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:.statusCode
patient	Σ I	1..1	Reference(Patient\| HdBe Patient)	Element Id RelatedPerson.patient Short description The patient this person is related to Definition The patient this person is related to. Requirements We need to know which patient this RelatedPerson is related to. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(Patient\| HdBe Patient) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: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'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:PID-3 rim:scoper[classCode=PSN\|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id
relationship	Σ	0..*	CodeableConceptBinding	Element Id RelatedPerson.relationship Short description The nature of the relationship Definition The nature of the relationship between a patient and the related person. Requirements We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Sliced: Unordered, Open, by $this(Value) Binding The nature of the relationship between a patient and the related person. PatientRelationshipType (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class v2:NK1-3 rim:code
role	Σ	0..*	CodeableConceptBinding	Element Id RelatedPerson.relationship:role Short description Role Alternate names Rol Definition Defines the role of the contact in relation to the patient. Requirements We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding RolCodelijst Role (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class v2:NK1-3 rim:code zib-contactperson-v3.4-2020EN:NL-CM:3.1.2 HdBe-ContactPerson:role
relationship	Σ	0..*	CodeableConceptBinding	Element Id RelatedPerson.relationship:relationship Short description Relationship Alternate names Relatie Definition Defines the contact’s familial relationship to the patient. Requirements We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding RelatieCodelijst Relationship (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class v2:NK1-3 rim:code zib-contactperson-v3.4-2020EN:NL-CM:3.1.3 HdBe-ContactPerson:relationship
name	Σ I	0..*	HdBe NameInformation	Element Id RelatedPerson.name Short description NameInformation Alternate names Naamgegevens Definition Full name of the contact. Requirements Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Comments The cardinality mismatch between the CBB (0..1) and FHIR (0..) is explained by the presence of the HumanName.use element. A full name can be broken into parts using multiple instances of HumanName that have its own value for use. Data Type* HdBe NameInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a familiy name is specified, the family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2:If the prefix for a partner family name is specified, the partner family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` zib-NameInformation-3:If the name is specified as 'official' then the name is expected to contain only official parts `use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()` Examples Structured HumanName (preferred above unstructured) { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "text": "Irma Jongeneel-de Haas", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } Unstructured HumanName { "text": "Irma Jongeneel-de Haas" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:NK1-2 rim:name zib-nameinformation-v1.1-2020EN:NL-CM:20.4.1 HdBe-NameInformation:name_information zib-contactperson-v3.4-2020EN:NL-CM:3.1.4 HdBe-ContactInformation:name_information
telecom	Σ I	0..*	ContactPoint	Element Id RelatedPerson.telecom Short description ContactInformation Alternate names Contactgegevens Definition The contact’s telephone number and/or e-mail address. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The cardinality mismatch between the zib (0..1) and FHIR (0..) is explained by the containers TelephoneNumbers (0..) and EmailAddresses (0..) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. Data Type* ContactPoint Sliced: Unordered, Open, by $this(Profile) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5 / NK1-6 / NK1-40 rim:telecom zib-contactperson-v3.4-2020EN:NL-CM:3.1.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1 HdBe-ContactPerson:contact_information HdBe-ContactInformation:contact_information
telephoneNumbers	Σ I	0..*	HdBe ContactInformation TelephoneNumbers	Element Id RelatedPerson.telecom:telephoneNumbers Short description TelephoneNumbers Alternate names Telefoonnummers Definition Container of the TelephoneNumbers concept. This container contains all data elements of the TelephoneNumbers concept. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Implementation of the "TelephoneNumbers" concept of CBB ContactInformation. Please note that, although the concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the CBB uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the CBB code will need to be communicated using the codeSpecification extension. Data Type HdBe ContactInformation TelephoneNumbers Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5 / NK1-6 / NK1-40 rim:telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 HdBe-ContactInformation:telephone_numbers
emailAddresses	Σ I	0..*	HdBe ContactInformation EmailAddresses	Element Id RelatedPerson.telecom:emailAddresses Short description EmailAddresses Alternate names EmailAdressen Definition Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The "EmailAddresses" concept of CBB ContactInformation. Data Type HdBe ContactInformation EmailAddresses Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5 / NK1-6 / NK1-40 rim:telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:email_addresses
gender	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id RelatedPerson.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Requirements Needed for identification of the person, in combination with (at least) name and birth date. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:NK1-15 rim:administrativeGender
birthDate	Σ	0..1	date	There are no (further) constraints on this element Element Id RelatedPerson.birthDate Short description The date on which the related person was born Definition The date on which the related person was born. Data Type date Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:player.birthTime
address	Σ	0..*	HdBe AddressInformation	Element Id RelatedPerson.address Short description AddressInformation Alternate names Adresgegevens Definition Contact’s address information. Requirements Need to keep track where the related person can be contacted per postal mail or visited. Comments Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). Data Type HdBe AddressInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD rim:AD servd:Address v2:NK1-4 rim:addr zib-addressinformation-v1.1-2020EN:NL-CM:20.5.1 HdBe-AddressInformation:address_information zib-contactperson-v3.4-2020EN:NL-CM:3.1.5 HdBe-ContactInformation:address_information
photo	I	0..*	Attachment	There are no (further) constraints on this element Element Id RelatedPerson.photo Short description Image of the person Definition Image of the person. Requirements Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. Comments When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". Data Type Attachment Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` att-1:If the Attachment has data, it SHALL have a contentType `data.empty() or contentType.exists()` Mappings rim:n/a v2:ED/RP rim:ED v2:OBX-5 - needs a profile rim:player[classCode='PSN' and determinerCode='INSTANCE']/desc
period	I	0..1	Period	There are no (further) constraints on this element Element Id RelatedPerson.period Short description Period of time that this relationship is considered valid Definition The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5:FiveWs.done[x] rim:.effectiveTime
communication		0..*	BackboneElement	There are no (further) constraints on this element Element Id RelatedPerson.communication Short description A language which may be used to communicate with about the patient's health Definition A language which may be used to communicate with about the patient's health. Requirements If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. Comments If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:LanguageCommunication
language		1..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id RelatedPerson.communication.language Short description The language which can be used to communicate with the patient about his or her health Definition The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. Requirements Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. Comments The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. Data Type CodeableConcept Binding A human language. CommonLanguages (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/languageCommunication/code
preferred		0..1	boolean	There are no (further) constraints on this element Element Id RelatedPerson.communication.preferred Short description Language preference indicator Definition Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). Requirements People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. Comments This language is specifically identified for communicating healthcare information. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:preferenceInd

Mapping FHIR profile to CBB

Path	map
RelatedPerson	contact
RelatedPerson.relationship:role	role
RelatedPerson.relationship:relationship	relationship
RelatedPerson.telecom	contact_information

zib ContactPerson difference

Concept	Category	Description
`relationship.role`	terminology	Replaced Role valueset values to a SNOMED descendent-of 125676002 (Person).
`relationship.relationship`	terminology	Replaced Relationship valueset values to a SNOMED descendent-of 303071001 (Person in the family).

Terminology Bindings

Path	Name	Strength	URL	ConceptMap
RelatedPerson.relationship	Role	required	https://fhir.healthdata.be/ValueSet/Role	No bound ConceptMap
RelatedPerson.relationship	Relationship	required	https://fhir.healthdata.be/ValueSet/Relationship	No bound ConceptMap