Important: This is a draft IG for trial use. Click here to give feedback.

HdBe-ContactPerson

Profile	Description	Status	URL
HdBe-ContactPerson	A contact person 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 person 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: ContactPerson
id	Σ	0..1	string	There are no (further) constraints on this element Element id RelatedPerson.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id RelatedPerson.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id RelatedPerson.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id RelatedPerson.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code 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
text		0..1	Narrative	There are no (further) constraints on this element Element id RelatedPerson.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id RelatedPerson.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id RelatedPerson.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id RelatedPerson.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
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. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element 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 person 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: ContactPerson.Role
relationship	Σ	0..*	CodeableConceptBinding	Element id RelatedPerson.relationship:relationship Short description Relationship Alternate names Relatie Definition Defines the contact person’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: ContactPerson.Relationship
name	Σ	0..*	HumanName	Element id RelatedPerson.name Short description NameInformation Alternate names Naamgegevens Definition Full name of the contact person. Requirements Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Comments Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. Data type HumanName Sliced: Unordered, Open, by use(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN rim: EN (actually, PN) servd: ProviderName v2: NK1-2 rim: name zib-contactperson-v3.4-2020EN: NL-CM:3.1.4 HdBe-ContactPerson: ContactPerson.NameInformation
nameInformation	Σ I	0..2	HdBe-NameInformation	Element id RelatedPerson.name:nameInformation Short description NameInformation Alternate names Naamgegevens Definition This slice represents the person's official name information, including given names, last name and possibly the partner's last name. Requirements Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Comments This `.name` element represents a Belgian name according to the CBB NameInformation (except for the GivenName concept). A Belgian name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Belgian rules. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Belgian context SHOULD support these extensions as specified here. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Belgian contexts. It is encouraged to provide a representation of the full name in the `.text` element. Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept. Note 2: This element should only contain a person's official names. The GivenName concept is represented in another `.name` element with `.name.use` = usual. Note 3: The examples illustrate how the CBB is mapped to FHIR. 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 family name is specified, the family name is expected as well `family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well `family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` 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: NameInformation
nameInformation-GivenName	Σ	0..*	HdBe-NameInformation.GivenName	Element id RelatedPerson.name:nameInformation-GivenName Short description Name of a human - parts and usage Definition This slice represents the name information normally used to address the person. Requirements Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Comments This `.name` element represents the Belgian given name ("roepnaam") according to the CBB NameInformation. Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other `.name` elements with `.name.use` = official. Note 2: The examples illustrate how the CBB is mapped to FHIR. Data type HdBe-NameInformation.GivenName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN rim: EN (actually, PN) servd: ProviderName v2: NK1-2 rim: name
telecom	Σ I	0..*	HdBe-ContactInformation	Element id RelatedPerson.telecom Short description ContactInformation Alternate names Contactpunten, Contactgegevens Definition The contact person’s telephone number and/or e-mail address. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps. Data type HdBe-ContactInformation 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 zib-contactinformation-v1.2-2020EN: NL-CM:20.6.3 HdBe-ContactInformation: ContactInformation zib-contactperson-v3.4-2020EN: NL-CM:3.1.6 HdBe-ContactPerson: ContactPerson.ContactInformation
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 person’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: AddressInformation zib-contactperson-v3.4-2020EN: NL-CM:3.1.5 HdBe-ContactPerson: ContactPerson.AddressInformation
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
id		0..1	string	There are no (further) constraints on this element Element id RelatedPerson.communication.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id RelatedPerson.communication.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id RelatedPerson.communication.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
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: ContactPerson
id	Σ	0..1	string	There are no (further) constraints on this element Element id RelatedPerson.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id RelatedPerson.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id RelatedPerson.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id RelatedPerson.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code 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
text		0..1	Narrative	There are no (further) constraints on this element Element id RelatedPerson.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id RelatedPerson.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id RelatedPerson.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id RelatedPerson.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
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. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element 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 person 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: ContactPerson.Role
relationship	Σ	0..*	CodeableConceptBinding	Element id RelatedPerson.relationship:relationship Short description Relationship Alternate names Relatie Definition Defines the contact person’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: ContactPerson.Relationship
name	Σ	0..*	HumanName	Element id RelatedPerson.name Short description NameInformation Alternate names Naamgegevens Definition Full name of the contact person. Requirements Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Comments Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. Data type HumanName Sliced: Unordered, Open, by use(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN rim: EN (actually, PN) servd: ProviderName v2: NK1-2 rim: name zib-contactperson-v3.4-2020EN: NL-CM:3.1.4 HdBe-ContactPerson: ContactPerson.NameInformation
nameInformation	Σ I	0..2	HdBe-NameInformation	Element id RelatedPerson.name:nameInformation Short description NameInformation Alternate names Naamgegevens Definition This slice represents the person's official name information, including given names, last name and possibly the partner's last name. Requirements Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Comments This `.name` element represents a Belgian name according to the CBB NameInformation (except for the GivenName concept). A Belgian name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Belgian rules. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Belgian context SHOULD support these extensions as specified here. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Belgian contexts. It is encouraged to provide a representation of the full name in the `.text` element. Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept. Note 2: This element should only contain a person's official names. The GivenName concept is represented in another `.name` element with `.name.use` = usual. Note 3: The examples illustrate how the CBB is mapped to FHIR. 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 family name is specified, the family name is expected as well `family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well `family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` 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: NameInformation
nameInformation-GivenName	Σ	0..*	HdBe-NameInformation.GivenName	Element id RelatedPerson.name:nameInformation-GivenName Short description Name of a human - parts and usage Definition This slice represents the name information normally used to address the person. Requirements Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Comments This `.name` element represents the Belgian given name ("roepnaam") according to the CBB NameInformation. Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other `.name` elements with `.name.use` = official. Note 2: The examples illustrate how the CBB is mapped to FHIR. Data type HdBe-NameInformation.GivenName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN rim: EN (actually, PN) servd: ProviderName v2: NK1-2 rim: name
telecom	Σ I	0..*	HdBe-ContactInformation	Element id RelatedPerson.telecom Short description ContactInformation Alternate names Contactpunten, Contactgegevens Definition The contact person’s telephone number and/or e-mail address. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps. Data type HdBe-ContactInformation 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 zib-contactinformation-v1.2-2020EN: NL-CM:20.6.3 HdBe-ContactInformation: ContactInformation zib-contactperson-v3.4-2020EN: NL-CM:3.1.6 HdBe-ContactPerson: ContactPerson.ContactInformation
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 person’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: AddressInformation zib-contactperson-v3.4-2020EN: NL-CM:3.1.5 HdBe-ContactPerson: ContactPerson.AddressInformation
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
id		0..1	string	There are no (further) constraints on this element Element id RelatedPerson.communication.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id RelatedPerson.communication.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id RelatedPerson.communication.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
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: ContactPerson
id	Σ	0..1	string	There are no (further) constraints on this element Element id RelatedPerson.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id RelatedPerson.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id RelatedPerson.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id RelatedPerson.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code 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
text		0..1	Narrative	There are no (further) constraints on this element Element id RelatedPerson.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id RelatedPerson.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id RelatedPerson.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id RelatedPerson.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
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. Meaning when missing This resource is generally assumed to be active if no value is provided for the active element 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 person 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: ContactPerson.Role
relationship	Σ	0..*	CodeableConceptBinding	Element id RelatedPerson.relationship:relationship Short description Relationship Alternate names Relatie Definition Defines the contact person’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: ContactPerson.Relationship
name	Σ	0..*	HumanName	Element id RelatedPerson.name Short description NameInformation Alternate names Naamgegevens Definition Full name of the contact person. Requirements Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Comments Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. Data type HumanName Sliced: Unordered, Open, by use(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN rim: EN (actually, PN) servd: ProviderName v2: NK1-2 rim: name zib-contactperson-v3.4-2020EN: NL-CM:3.1.4 HdBe-ContactPerson: ContactPerson.NameInformation
nameInformation	Σ I	0..2	HdBe-NameInformation	Element id RelatedPerson.name:nameInformation Short description NameInformation Alternate names Naamgegevens Definition This slice represents the person's official name information, including given names, last name and possibly the partner's last name. Requirements Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Comments This `.name` element represents a Belgian name according to the CBB NameInformation (except for the GivenName concept). A Belgian name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Belgian rules. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Belgian context SHOULD support these extensions as specified here. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Belgian contexts. It is encouraged to provide a representation of the full name in the `.text` element. Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept. Note 2: This element should only contain a person's official names. The GivenName concept is represented in another `.name` element with `.name.use` = usual. Note 3: The examples illustrate how the CBB is mapped to FHIR. 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 family name is specified, the family name is expected as well `family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2: If the prefix for a partner family name is specified, the partner family name is expected as well `family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` 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: NameInformation
nameInformation-GivenName	Σ	0..*	HdBe-NameInformation.GivenName	Element id RelatedPerson.name:nameInformation-GivenName Short description Name of a human - parts and usage Definition This slice represents the name information normally used to address the person. Requirements Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Comments This `.name` element represents the Belgian given name ("roepnaam") according to the CBB NameInformation. Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other `.name` elements with `.name.use` = official. Note 2: The examples illustrate how the CBB is mapped to FHIR. Data type HdBe-NameInformation.GivenName Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: XPN rim: EN (actually, PN) servd: ProviderName v2: NK1-2 rim: name
telecom	Σ I	0..*	HdBe-ContactInformation	Element id RelatedPerson.telecom Short description ContactInformation Alternate names Contactpunten, Contactgegevens Definition The contact person’s telephone number and/or e-mail address. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps. Data type HdBe-ContactInformation 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 zib-contactinformation-v1.2-2020EN: NL-CM:20.6.3 HdBe-ContactInformation: ContactInformation zib-contactperson-v3.4-2020EN: NL-CM:3.1.6 HdBe-ContactPerson: ContactPerson.ContactInformation
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 person’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: AddressInformation zib-contactperson-v3.4-2020EN: NL-CM:3.1.5 HdBe-ContactPerson: ContactPerson.AddressInformation
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
id		0..1	string	There are no (further) constraints on this element Element id RelatedPerson.communication.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id RelatedPerson.communication.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id RelatedPerson.communication.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
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	CBB
RelatedPerson	ContactPerson	HdBe-ContactPerson
RelatedPerson.relationship:role	ContactPerson.Role	HdBe-ContactPerson
RelatedPerson.relationship:relationship	ContactPerson.Relationship	HdBe-ContactPerson
RelatedPerson.name	ContactPerson.NameInformation	HdBe-ContactPerson
RelatedPerson.telecom	ContactPerson.ContactInformation	HdBe-ContactPerson
RelatedPerson.address	ContactPerson.AddressInformation	HdBe-ContactPerson

zib ContactPerson difference

Concept	Category	Description
...	textual	Replaced the term contact with the term contact person at several locations (zib ticket #1738).
`telecom`	reference	Added reference to HdBe-ContactInformation profile, which replaces the two separate HdBe-ContactInformation profiles.
`telecom`	slicing	Removed slicing as the two HdBe-ContactInformation profiles are replaced with one general HdBe-ContactInformation profile, which makes slicing unnecessary.
`relationship.role`	terminology	Replaced Role valueset values to a SNOMED descendent-of 125676002 (Person). Also included CodeSystem-Role into the valueset.
`relationship.relationship`	terminology	Replaced Relationship valueset values to a SNOMED descendent-of 303071001 (Person in the family). Also included CodeSystem-Relationship into the valueset.

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