Patient

Profile	Description	Status	URL
HdBe-Patient	A person who receives medical, psychological, paramedical or nursing care. In some care settings, the term client or participant is used instead of the term patient. Nationality is used as an indication of the country of citizenship. Marital status is a person’s formal position as defined by the Belgium civil code. There is a distinction between marriage and civil union.	draft	https://fhir.healthdata.be/StructureDefinition/HdBe-Patient

Introduction

This Patient profile contains mappings to the following CBBs:

Patient
Nationality
MaritalStatus
Command 'pagelink' could not render: Page not found.
ContactPerson

Patient	I		Patient	Element Id Patient Short description Patient Alternate names SubjectOfCare Client Resident, Patient Definition Demographics and other administrative information about an individual or animal receiving care or other health-related services. Data Type Patient 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:Patient[classCode=PAT] cda:ClinicalDocument.recordTarget.patientRole zib-patient-v3.2-2020EN:NL-CM:0.1.1 HdBe-Patient:patient
extension	I	0..*	Extension	Element Id Patient.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) 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
nationality	I	0..*	Extension(Complex)	Element Id Patient.extension:nationality Short description Nationality Alternate names extensions, user content Definition The nationality of the patient. Comments Due to the nature of the nationality core extension (which allows for a period to be placed next to the nationality and thus allows for different nationalities over time), the cardinality of the extension is left at 0..* instead of the CBB cardinality of 0..1. Data Type Extension(Complex) Extension URL http://hl7.org/fhir/StructureDefinition/patient-nationality 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
extension	I	0..*	Extension	Element Id Patient.extension:nationality.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) 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
code	I	0..1	Extension	There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:code Short description Nationality Code Alternate names extensions, user content Definition Code representing nationality of patient. 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
url		1..1	uriFixed Value	There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:code.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type uri Fixed Value code Mappings rim:N/A
value[x]		1..1	Binding	Element Id Patient.extension:nationality.extension:code.value[x] Short description Nationality Alternate names Nationaliteit Definition Indicates the country of citizenship. Binding Iso 3166 Part 1: 2 Letter Codes Iso3166-1-2 (extensible) 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 zib-nationality-v3.0-2020EN:NL-CM:7.6.3 HdBe-Nationality:nationality
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
period	I	0..1	Extension	There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:period Short description Nationality Period Alternate names extensions, user content Definition Period when nationality was effective. 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
url		1..1	uriFixed Value	There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:period.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type uri Fixed Value period Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:period.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). 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
valuePeriod			Period	There are no (further) constraints on this element Data Type Period
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.extension:nationality.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/patient-nationality Mappings rim:N/A
value[x]		0..0		There are no (further) constraints on this element Element Id Patient.extension:nationality.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). 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
identifier	Σ	0..*	Identifier	Element Id Patient.identifier Short description PatientIdentificationNumber Alternate names Identificatienummer Definition The patient’s identification number. Typically, when an social security identification number (NISS-INSZ), is available it is used. A local identifier may be provided when this is desired. Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier Sliced: Unordered, Open, by $this(Value) 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:PID-3 rim:id cda:.id HdBe-Patient:patient_identification_number zib-patient-v3.2-2020EN:NL-CM:0.1.7
SSIN	Σ	0..*	Identifier	Element Id Patient.identifier:SSIN Short description An identifier for this patient Definition An identifier for this patient according to SSIN (NISS-INSZ.) Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern { "system": "https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin" } 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:PID-3 rim:id cda:.id
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element Id Patient.active Short description Whether this patient's record is in active use Definition Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. Requirements Need to be able to mark a patient record as not to be used because it was created in error. Comments If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. 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 cda:n/a
name	Σ I	0..*	HdBe NameInformation	Element Id Patient.name Short description NameInformation Alternate names Naamgegevens Definition Patient's full name. The cardinality differs from the CBB to allow including several name elements with a different name.use each. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments The cardinality mismatch between the CBB (0..1) and FHIR (0..) is explained by the presence of the HumanName.use element. A full name can be broken into parts using multiple instances of HumanName that have its own value for use. Data Type* HdBe NameInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a familiy name is specified, the family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2:If the prefix for a partner family name is specified, the partner family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` zib-NameInformation-3:If the name is specified as 'official' then the name is expected to contain only official parts `use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()` Examples Structured HumanName (preferred above unstructured) { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "text": "Irma Jongeneel-de Haas", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } Unstructured HumanName { "text": "Irma Jongeneel-de Haas" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name zib-nameinformation-v1.1-2020EN:NL-CM:20.4.1 HdBe-NameInformation:name_information HdBe-Patient:name_information zib-patient-v3.2-2020EN:NL-CM:0.1.6
telecom	Σ I	0..*	ContactPoint	Element Id Patient.telecom Short description ContactInformation Alternate names Contactgegevens Definition Patient’s telephone number(s) or e-mail address(es). Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The cardinality mismatch between the CBB (0..1) and FHIR (0..) is explained by the containers inside the ContactInformation model which are 0... FHIR ContactPoint does not have these containers. Data Type ContactPoint Sliced: Unordered, Open, by $this(Profile) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom HdBe-Patient:contact_information zib-patient-v3.2-2020EN:NL-CM:0.1.5 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1
telephoneNumbers	Σ I	0..*	HdBe ContactInformation TelephoneNumbers	Element Id Patient.telecom:telephoneNumbers Short description TelephoneNumbers Alternate names Telefoonnummers Definition Container of the TelephoneNumbers concept. This container contains all data elements of the TelephoneNumbers concept. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Implementation of the "TelephoneNumbers" concept of CBB ContactInformation. Please note that, although the concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the CBB uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the CBB code will need to be communicated using the codeSpecification extension. Data Type HdBe ContactInformation TelephoneNumbers Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 HdBe-ContactInformation:telephone_numbers
emailAddresses	Σ I	0..*	HdBe ContactInformation EmailAddresses	Element Id Patient.telecom:emailAddresses Short description EmailAddresses Alternate names EmailAdressen Definition Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The "EmailAddresses" concept of CBB ContactInformation. Data Type HdBe ContactInformation EmailAddresses Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:email_addresses
gender	Σ	0..1	codeBinding	Element Id Patient.gender Short description Gender Alternate names Geslacht Definition Patient’s administrative gender. The gender that that the patient is considered to have for administration and record keeping purposes. Note that the gender might not match the biological sex as determined by genetics or the individual's preferred identification. The Observation resource can deal with specific sex or gender aspect of interest. Requirements Needed for identification of the individual, in combination with (at least) name and birth date. Comments The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. Data Type code Binding Use ConceptMap 'GenderCodelijst-to-AdministrativeGender' to translate CBB terminology to profile terminology in ValueSet 'AdministrativeGender' AdministrativeGender (required) Permitted Values Gender_to_AdministrativeGender Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-8 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender cda:.patient.administrativeGenderCode HdBe-Patient:gender zib-patient-v3.2-2020EN:NL-CM:0.1.9
extension	I	0..*	Extension	Element Id Patient.gender.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) 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
genderCodelist	I	0..1	Extension(CodeableConcept)	Element Id Patient.gender.extension:genderCodelist Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. 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(CodeableConcept) Extension URL https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification 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
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.gender.extension:genderCodelist.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification Mappings rim:N/A
value[x]		0..1	Binding	Element Id Patient.gender.extension:genderCodelist.value[x] Short description Gender Alternate names Geslacht Definition Patient’s administrative gender. Binding GenderCodelist Gender (required) 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 HdBe-Patient:gender zib-patient-v3.2-2020EN:NL-CM:0.1.9
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
birthDate	Σ	0..1	date	Element Id Patient.birthDate Short description DateOfBirth Alternate names Geboortedatum Definition Patient’s date of birth. The date of birth is mandatory for a patient. A vague date (such as only the year) is permitted. Requirements Age of the individual drives many clinical processes. Comments At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). 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 v2:PID-7 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/birthTime cda:.patient.birthTime loinc:21112-8 HdBe-Patient:date_of_birth zib-patient-v3.2-2020EN:NL-CM:0.1.10
deceased[x]	Σ ?!	0..1		Element Id Patient.deceased[x] Short description Indicates if the individual is deceased or not Definition Indicates if the individual is deceased or not. Requirements The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. Comments If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. Sliced: Unordered, Open, by $this(Type) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-30 (bool) and PID-29 (datetime) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime cda:n/a
deceasedBoolean	Σ ?!	0..1	boolean	Element Id Patient.deceased[x]:deceasedBoolean Short description DeathIndicator Alternate names OverlijdensIndicator Definition An indication stating whether the patient has died. Requirements The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. Comments If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. 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 v2:PID-30 (bool) and PID-29 (datetime) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime cda:n/a HdBe-Patient:death_indicator zib-patient-v3.2-2020EN:NL-CM:0.1.32
deceasedDateTime	Σ ?!	0..1	dateTime	Element Id Patient.deceased[x]:deceasedDateTime Short description DateOfDeath Alternate names DatumOverlijden, OverlijdensIndicator Definition The date on which the patient died. A ‘vague’ date, such as only the year, is permitted. Requirements The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. Comments The CBB recognizes both the DeathIndicator (boolean) and DateOfDeath (datetime) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if deceasedDateTime is present and has a value, its value can be mapped to DateOfDeath and DeathIndicator is assumed to be true. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-30 (bool) and PID-29 (datetime) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime cda:n/a HdBe-Patient:date_of_death HdBe-Patient:death_indicator zib-patient-v3.2-2020EN:NL-CM:0.1.33 zib-patient-v3.2-2020EN:NL-CM:0.1.32
address	Σ	0..*	HdBe AddressInformation	Element Id Patient.address Short description AddressInformation Alternate names Adresgegevens Definition Patient's address information. Requirements May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. 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:PID-11 rim:addr cda:.addr zib-addressinformation-v1.1-2020EN:NL-CM:20.5.1 HdBe-AddressInformation:address_information HdBe-Patient:address_information zib-patient-v3.2-2020EN:NL-CM:0.1.4
maritalStatus		0..1	CodeableConceptBinding	Element Id Patient.maritalStatus Short description MaritalStatus Alternate names BurgerlijkeStaat Definition A person’s marital status. Requirements Most, if not all systems capture it. 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 Use ConceptMap 'MaritalStatus-to-MaritalStatus' to translate CBB terminology to profile terminology in ValueSet 'MaritalStatus' Marital Status Codes (required) Permitted Values MaritalStatus_to_MaritalStatus 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 v2:PID-16 rim:player[classCode=PSN]/maritalStatusCode cda:.patient.maritalStatusCode HdBe-MaritalStatus:marital_status zib-maritalstatus-v3.1-2020EN:NL-CM:7.9.2
multipleBirth[x]		0..1		Element Id Patient.multipleBirth[x] Short description Whether patient is part of a multiple birth Definition Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Comments Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). Sliced: Unordered, Open, by $this(Type) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-24 (bool), PID-25 (integer) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda:n/a
multipleBirthBoolean		0..1	boolean	Element Id Patient.multipleBirth[x]:multipleBirthBoolean Short description MultipleBirthIndicator Alternate names MeerlingIndicator Definition An indication stating whether the patient is of a multiple birth. Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Comments Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). 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 v2:PID-24 (bool), PID-25 (integer) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda:n/a HdBe-Patient:multiple_birth_indicator zib-patient-v3.2-2020EN:NL-CM:0.1.31
multipleBirthInteger		0..1	integer	Element Id Patient.multipleBirth[x]:multipleBirthInteger Short description MultipleBirthOrder Definition An indication of the birth order in case the patient is of a multiple birth. Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Comments The CBB recognizes both the MultipleBirthIndicator (boolean) and MultipleBirthOrder (integer) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if multipleBirthInteger is present and has a value, its value can be mapped to MultipleBirthOrder and MultipleBirthIndicator is assumed to be true. Data Type integer Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-24 (bool), PID-25 (integer) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda:n/a HdBe-Patient:multiple_birth_order HdBe-Patient:multiple_birth_indicator
photo	I	0..*	Attachment	There are no (further) constraints on this element Element Id Patient.photo Short description Image of the patient Definition Image of the patient. Requirements Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Comments Guidelines: Use id photos, not clinical photos. Limit dimensions to thumbnail. Keep byte count low to ease resource updates. 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\|ANM and determinerCode=INSTANCE]/desc cda:n/a
contact	I	0..*	BackboneElement	Element Id Patient.contact Short description Contact Alternate names Contactpersoon Definition A contact party (e.g. guardian, partner, friend) for the patient. Requirements Need to track people you can contact about the patient. 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 is used to capture information about any person that is related to the patient, using the profile https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson. 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. The HdBe-ContactPerson can be referenced using the extension in `contact:contactPerson`. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` pat-1:SHALL at least contain a contact's details or a reference to an organization `name.exists() or telecom.exists() or address.exists() or organization.exists()` Mappings rim:n/a rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON] cda:n/a zib-contactperson-v3.4-2020EN:NL-CM:3.1.1 HdBe-ContactPerson:contact
extension	I	0..*	Extension	Element Id Patient.contact.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) 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
contactPerson	I	0..1	Extension(Reference(RelatedPerson))	Element Id Patient.contact.extension:contactPerson Short description This contact may have further details in this RelatedPerson Alternate names extensions, user content Definition In some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate. 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(Reference(RelatedPerson)) Extension URL http://hl7.org/fhir/StructureDefinition/patient-relatedPerson 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
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.extension:contactPerson.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/patient-relatedPerson Mappings rim:N/A
value[x]		1..1		Element Id Patient.contact.extension:contactPerson.value[x] Short description Contact Alternate names Contactpersoon Definition Reference to a HdBe-ContactPerson instance containing the full details for the current contact. 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 zib-contactperson-v3.4-2020EN:NL-CM:3.1.1 HdBe-ContactPerson:contact
valueReference			Reference(RelatedPerson\| HdBe ContactPerson)	Data Type Reference(RelatedPerson\| HdBe ContactPerson)
relationship		0..*	CodeableConceptBinding	Element Id Patient.contact.relationship Short description The kind of relationship Definition The nature of the relationship between the patient and the contact person. Requirements Used to determine which contact person is the most relevant to approach, depending on circumstances. 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 a contact person for that patient. PatientContactRelationship (extensible) 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 v2:NK1-7, NK1-3 rim:code cda:n/a
role		0..*	CodeableConceptBinding	Element Id Patient.contact.relationship:role Short description Role Alternate names Rol Definition Defines the role of the contact in relation to the patient. Requirements Used to determine which contact person is the most relevant to approach, depending on circumstances. 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 v2:NK1-7, NK1-3 rim:code cda:n/a zib-contactperson-v3.4-2020EN:NL-CM:3.1.2 HdBe-ContactPerson:role
relationship		0..*	CodeableConceptBinding	Element Id Patient.contact.relationship:relationship Short description Relationship Alternate names Relatie Definition Defines the contact’s familial relationship to the patient. Requirements Used to determine which contact person is the most relevant to approach, depending on circumstances. 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 v2:NK1-7, NK1-3 rim:code cda:n/a zib-contactperson-v3.4-2020EN:NL-CM:3.1.3 HdBe-ContactPerson:relationship
name	I	0..1	HdBe NameInformation	Element Id Patient.contact.name Short description NameInformation Alternate names Naamgegevens Definition Full name of the contact. Requirements Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. Comments The cardinality mismatch between the CBB (0..1) and FHIR (0..) is explained by the presence of the HumanName.use element. A full name can be broken into parts using multiple instances of HumanName that have its own value for use. Data Type* HdBe NameInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a familiy name is specified, the family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2:If the prefix for a partner family name is specified, the partner family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` zib-NameInformation-3:If the name is specified as 'official' then the name is expected to contain only official parts `use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()` Examples Structured HumanName (preferred above unstructured) { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "text": "Irma Jongeneel-de Haas", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } Unstructured HumanName { "text": "Irma Jongeneel-de Haas" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:NK1-2 rim:name cda:n/a zib-nameinformation-v1.1-2020EN:NL-CM:20.4.1 HdBe-NameInformation:name_information zib-contactperson-v3.4-2020EN:NL-CM:3.1.4 hdbe-ContactInformation:name_information
telecom	I	0..*	ContactPoint	Element Id Patient.contact.telecom Short description ContactInformation Alternate names Contactgegevens Definition The contact’s telephone number and/or e-mail address. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The cardinality mismatch between the zib (0..1) and FHIR (0..) is explained by the containers TelephoneNumbers (0..) and EmailAddresses (0..) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. Data Type* ContactPoint Sliced: Unordered, Open, by $this(Profile) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a zib-contactperson-v3.4-2020EN:NL-CM:3.1.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1 HdBe-ContactPerson:contact_information hdbe-ContactInformation:contact_information
telephoneNumbers	I	0..*	HdBe ContactInformation TelephoneNumbers	Element Id Patient.contact.telecom:telephoneNumbers Short description TelephoneNumbers Alternate names Telefoonnummers Definition Container of the TelephoneNumbers concept. This container contains all data elements of the TelephoneNumbers concept. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Implementation of the "TelephoneNumbers" concept of CBB ContactInformation. Please note that, although the concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the CBB uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the CBB code will need to be communicated using the codeSpecification extension. Data Type HdBe ContactInformation TelephoneNumbers Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 HdBe-ContactInformation:telephone_numbers
emailAddresses	I	0..*	HdBe ContactInformation EmailAddresses	Element Id Patient.contact.telecom:emailAddresses Short description EmailAddresses Alternate names EmailAdressen Definition Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The "EmailAddresses" concept of CBB ContactInformation. Data Type HdBe ContactInformation EmailAddresses Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:email_addresses
address		0..1	HdBe AddressInformation	Element Id Patient.contact.address Short description AddressInformation Alternate names Adresgegevens Definition Contact’s address information. Requirements Need to keep track where the contact person can be contacted per postal mail or visited. Comments This element can and should not completely capture the AddressInformation concept from CBB ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full address information should instead be captured using an instance of HdBe-ContactPerson, which can then be referenced from this resource. See the comment on `Patient.contact` for more information. 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 cda:n/a zib-addressinformation-v1.1-2020EN:NL-CM:20.5.1 HdBe-AddressInformation:address_information zib-contactperson-v3.4-2020EN:NL-CM:3.1.5 HdBe-ContactPerson:address_information
gender		0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. 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:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender cda:n/a
organization	I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.contact.organization Short description Organization that is associated with the contact Definition Organization on behalf of which the contact is acting or for which the contact is working. Requirements For guardians or business related contacts, the organization is relevant. 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(Organization) 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:NK1-13, NK1-30, NK1-31, NK1-32, NK1-41 rim:scoper cda:n/a
period	I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.period Short description The period during which this contact person or organization is valid to be contacted relating to this patient Definition The period during which this contact person or organization is valid to be contacted relating to this patient. 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"] rim:effectiveTime cda:n/a
communication		0..*	BackboneElement	There are no (further) constraints on this element Element Id Patient.communication Short description A language which may be used to communicate with the patient about his or her health Definition A language which may be used to communicate with the patient about his or her health. Requirements If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are 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 Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient 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 cda:patient.languageCommunication
language		1..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Patient.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 v2:PID-15, LAN-2 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/languageCommunication/code cda:.languageCode
preferred		0..1	boolean	There are no (further) constraints on this element Element Id Patient.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 v2:PID-15 rim:preferenceInd cda:.preferenceInd
generalPractitioner	I	0..*	Reference(Organization\| Practitioner\| PractitionerRole)	There are no (further) constraints on this element Element Id Patient.generalPractitioner Short description Patient's nominated primary care provider Alternate names careProvider Definition Patient's nominated care provider. Comments This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. Data Type Reference(Organization\| Practitioner\| PractitionerRole) 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:PD1-4 rim:subjectOf.CareEvent.performer.AssignedEntity cda:n/a
managingOrganization	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.managingOrganization Short description Organization that is the custodian of the patient record Definition Organization that is the custodian of the patient record. Requirements Need to know who recognizes this patient record, manages and updates it. Comments There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). Data Type Reference(Organization) 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) rim:scoper cda:.providerOrganization
link	Σ ?!	0..*	BackboneElement	There are no (further) constraints on this element Element Id Patient.link Short description Link to another patient resource that concerns the same actual person Definition Link to another patient resource that concerns the same actual patient. Requirements There are multiple use cases: Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and Distribution of patient information across multiple servers. Comments There is no assumption that linked patient records have mutual links. 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:outboundLink cda:n/a
other	Σ I	1..1	Reference(Patient\| RelatedPerson)	There are no (further) constraints on this element Element Id Patient.link.other Short description The other patient or related person resource that the link refers to Definition The other patient resource that the link refers to. Comments Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Data Type Reference(Patient\| RelatedPerson) 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, MRG-1 rim:id cda:n/a
type	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Patient.link.type Short description replaced-by \| replaces \| refer \| seealso Definition The type of link between this patient resource and another patient resource. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The type of link between this patient resource and another patient resource. LinkType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:typeCode cda:n/a

Patient	I		Patient	Element Id Patient Short description Patient Alternate names SubjectOfCare Client Resident, Patient Definition Demographics and other administrative information about an individual or animal receiving care or other health-related services. Data Type Patient 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:Patient[classCode=PAT] cda:ClinicalDocument.recordTarget.patientRole zib-patient-v3.2-2020EN:NL-CM:0.1.1 HdBe-Patient:patient
extension	I	0..*	Extension	Element Id Patient.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) 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
nationality	I	0..*	Extension(Complex)	Element Id Patient.extension:nationality Short description Nationality Alternate names extensions, user content Definition The nationality of the patient. Comments Due to the nature of the nationality core extension (which allows for a period to be placed next to the nationality and thus allows for different nationalities over time), the cardinality of the extension is left at 0..* instead of the CBB cardinality of 0..1. Data Type Extension(Complex) Extension URL http://hl7.org/fhir/StructureDefinition/patient-nationality 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
extension	I	0..*	Extension	Element Id Patient.extension:nationality.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) 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
code	I	0..1	Extension	There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:code Short description Nationality Code Alternate names extensions, user content Definition Code representing nationality of patient. 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
url		1..1	uriFixed Value	There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:code.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type uri Fixed Value code Mappings rim:N/A
value[x]		1..1	Binding	Element Id Patient.extension:nationality.extension:code.value[x] Short description Nationality Alternate names Nationaliteit Definition Indicates the country of citizenship. Binding Iso 3166 Part 1: 2 Letter Codes Iso3166-1-2 (extensible) 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 zib-nationality-v3.0-2020EN:NL-CM:7.6.3 HdBe-Nationality:nationality
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
period	I	0..1	Extension	There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:period Short description Nationality Period Alternate names extensions, user content Definition Period when nationality was effective. 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
url		1..1	uriFixed Value	There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:period.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type uri Fixed Value period Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:period.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). 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
valuePeriod			Period	There are no (further) constraints on this element Data Type Period
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.extension:nationality.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/patient-nationality Mappings rim:N/A
value[x]		0..0		There are no (further) constraints on this element Element Id Patient.extension:nationality.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). 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
identifier	Σ	0..*	Identifier	Element Id Patient.identifier Short description PatientIdentificationNumber Alternate names Identificatienummer Definition The patient’s identification number. Typically, when an social security identification number (NISS-INSZ), is available it is used. A local identifier may be provided when this is desired. Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier Sliced: Unordered, Open, by $this(Value) 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:PID-3 rim:id cda:.id HdBe-Patient:patient_identification_number zib-patient-v3.2-2020EN:NL-CM:0.1.7
SSIN	Σ	0..*	Identifier	Element Id Patient.identifier:SSIN Short description An identifier for this patient Definition An identifier for this patient according to SSIN (NISS-INSZ.) Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern { "system": "https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin" } 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:PID-3 rim:id cda:.id
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element Id Patient.active Short description Whether this patient's record is in active use Definition Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. Requirements Need to be able to mark a patient record as not to be used because it was created in error. Comments If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. 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 cda:n/a
name	Σ I	0..*	HdBe NameInformation	Element Id Patient.name Short description NameInformation Alternate names Naamgegevens Definition Patient's full name. The cardinality differs from the CBB to allow including several name elements with a different name.use each. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments The cardinality mismatch between the CBB (0..1) and FHIR (0..) is explained by the presence of the HumanName.use element. A full name can be broken into parts using multiple instances of HumanName that have its own value for use. Data Type* HdBe NameInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a familiy name is specified, the family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2:If the prefix for a partner family name is specified, the partner family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` zib-NameInformation-3:If the name is specified as 'official' then the name is expected to contain only official parts `use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()` Examples Structured HumanName (preferred above unstructured) { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "text": "Irma Jongeneel-de Haas", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } Unstructured HumanName { "text": "Irma Jongeneel-de Haas" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name zib-nameinformation-v1.1-2020EN:NL-CM:20.4.1 HdBe-NameInformation:name_information HdBe-Patient:name_information zib-patient-v3.2-2020EN:NL-CM:0.1.6
telecom	Σ I	0..*	ContactPoint	Element Id Patient.telecom Short description ContactInformation Alternate names Contactgegevens Definition Patient’s telephone number(s) or e-mail address(es). Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The cardinality mismatch between the CBB (0..1) and FHIR (0..) is explained by the containers inside the ContactInformation model which are 0... FHIR ContactPoint does not have these containers. Data Type ContactPoint Sliced: Unordered, Open, by $this(Profile) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom HdBe-Patient:contact_information zib-patient-v3.2-2020EN:NL-CM:0.1.5 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1
telephoneNumbers	Σ I	0..*	HdBe ContactInformation TelephoneNumbers	Element Id Patient.telecom:telephoneNumbers Short description TelephoneNumbers Alternate names Telefoonnummers Definition Container of the TelephoneNumbers concept. This container contains all data elements of the TelephoneNumbers concept. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Implementation of the "TelephoneNumbers" concept of CBB ContactInformation. Please note that, although the concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the CBB uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the CBB code will need to be communicated using the codeSpecification extension. Data Type HdBe ContactInformation TelephoneNumbers Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 HdBe-ContactInformation:telephone_numbers
emailAddresses	Σ I	0..*	HdBe ContactInformation EmailAddresses	Element Id Patient.telecom:emailAddresses Short description EmailAddresses Alternate names EmailAdressen Definition Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The "EmailAddresses" concept of CBB ContactInformation. Data Type HdBe ContactInformation EmailAddresses Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:email_addresses
gender	Σ	0..1	codeBinding	Element Id Patient.gender Short description Gender Alternate names Geslacht Definition Patient’s administrative gender. The gender that that the patient is considered to have for administration and record keeping purposes. Note that the gender might not match the biological sex as determined by genetics or the individual's preferred identification. The Observation resource can deal with specific sex or gender aspect of interest. Requirements Needed for identification of the individual, in combination with (at least) name and birth date. Comments The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. Data Type code Binding Use ConceptMap 'GenderCodelijst-to-AdministrativeGender' to translate CBB terminology to profile terminology in ValueSet 'AdministrativeGender' AdministrativeGender (required) Permitted Values Gender_to_AdministrativeGender Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-8 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender cda:.patient.administrativeGenderCode HdBe-Patient:gender zib-patient-v3.2-2020EN:NL-CM:0.1.9
extension	I	0..*	Extension	Element Id Patient.gender.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) 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
genderCodelist	I	0..1	Extension(CodeableConcept)	Element Id Patient.gender.extension:genderCodelist Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. 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(CodeableConcept) Extension URL https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification 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
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.gender.extension:genderCodelist.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification Mappings rim:N/A
value[x]		0..1	Binding	Element Id Patient.gender.extension:genderCodelist.value[x] Short description Gender Alternate names Geslacht Definition Patient’s administrative gender. Binding GenderCodelist Gender (required) 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 HdBe-Patient:gender zib-patient-v3.2-2020EN:NL-CM:0.1.9
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
birthDate	Σ	0..1	date	Element Id Patient.birthDate Short description DateOfBirth Alternate names Geboortedatum Definition Patient’s date of birth. The date of birth is mandatory for a patient. A vague date (such as only the year) is permitted. Requirements Age of the individual drives many clinical processes. Comments At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). 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 v2:PID-7 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/birthTime cda:.patient.birthTime loinc:21112-8 HdBe-Patient:date_of_birth zib-patient-v3.2-2020EN:NL-CM:0.1.10
deceased[x]	Σ ?!	0..1		Element Id Patient.deceased[x] Short description Indicates if the individual is deceased or not Definition Indicates if the individual is deceased or not. Requirements The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. Comments If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. Sliced: Unordered, Open, by $this(Type) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-30 (bool) and PID-29 (datetime) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime cda:n/a
deceasedBoolean	Σ ?!	0..1	boolean	Element Id Patient.deceased[x]:deceasedBoolean Short description DeathIndicator Alternate names OverlijdensIndicator Definition An indication stating whether the patient has died. Requirements The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. Comments If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. 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 v2:PID-30 (bool) and PID-29 (datetime) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime cda:n/a HdBe-Patient:death_indicator zib-patient-v3.2-2020EN:NL-CM:0.1.32
deceasedDateTime	Σ ?!	0..1	dateTime	Element Id Patient.deceased[x]:deceasedDateTime Short description DateOfDeath Alternate names DatumOverlijden, OverlijdensIndicator Definition The date on which the patient died. A ‘vague’ date, such as only the year, is permitted. Requirements The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. Comments The CBB recognizes both the DeathIndicator (boolean) and DateOfDeath (datetime) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if deceasedDateTime is present and has a value, its value can be mapped to DateOfDeath and DeathIndicator is assumed to be true. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-30 (bool) and PID-29 (datetime) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime cda:n/a HdBe-Patient:date_of_death HdBe-Patient:death_indicator zib-patient-v3.2-2020EN:NL-CM:0.1.33 zib-patient-v3.2-2020EN:NL-CM:0.1.32
address	Σ	0..*	HdBe AddressInformation	Element Id Patient.address Short description AddressInformation Alternate names Adresgegevens Definition Patient's address information. Requirements May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. 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:PID-11 rim:addr cda:.addr zib-addressinformation-v1.1-2020EN:NL-CM:20.5.1 HdBe-AddressInformation:address_information HdBe-Patient:address_information zib-patient-v3.2-2020EN:NL-CM:0.1.4
maritalStatus		0..1	CodeableConceptBinding	Element Id Patient.maritalStatus Short description MaritalStatus Alternate names BurgerlijkeStaat Definition A person’s marital status. Requirements Most, if not all systems capture it. 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 Use ConceptMap 'MaritalStatus-to-MaritalStatus' to translate CBB terminology to profile terminology in ValueSet 'MaritalStatus' Marital Status Codes (required) Permitted Values MaritalStatus_to_MaritalStatus 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 v2:PID-16 rim:player[classCode=PSN]/maritalStatusCode cda:.patient.maritalStatusCode HdBe-MaritalStatus:marital_status zib-maritalstatus-v3.1-2020EN:NL-CM:7.9.2
multipleBirth[x]		0..1		Element Id Patient.multipleBirth[x] Short description Whether patient is part of a multiple birth Definition Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Comments Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). Sliced: Unordered, Open, by $this(Type) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-24 (bool), PID-25 (integer) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda:n/a
multipleBirthBoolean		0..1	boolean	Element Id Patient.multipleBirth[x]:multipleBirthBoolean Short description MultipleBirthIndicator Alternate names MeerlingIndicator Definition An indication stating whether the patient is of a multiple birth. Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Comments Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). 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 v2:PID-24 (bool), PID-25 (integer) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda:n/a HdBe-Patient:multiple_birth_indicator zib-patient-v3.2-2020EN:NL-CM:0.1.31
multipleBirthInteger		0..1	integer	Element Id Patient.multipleBirth[x]:multipleBirthInteger Short description MultipleBirthOrder Definition An indication of the birth order in case the patient is of a multiple birth. Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Comments The CBB recognizes both the MultipleBirthIndicator (boolean) and MultipleBirthOrder (integer) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if multipleBirthInteger is present and has a value, its value can be mapped to MultipleBirthOrder and MultipleBirthIndicator is assumed to be true. Data Type integer Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-24 (bool), PID-25 (integer) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda:n/a HdBe-Patient:multiple_birth_order HdBe-Patient:multiple_birth_indicator
photo	I	0..*	Attachment	There are no (further) constraints on this element Element Id Patient.photo Short description Image of the patient Definition Image of the patient. Requirements Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Comments Guidelines: Use id photos, not clinical photos. Limit dimensions to thumbnail. Keep byte count low to ease resource updates. 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\|ANM and determinerCode=INSTANCE]/desc cda:n/a
contact	I	0..*	BackboneElement	Element Id Patient.contact Short description Contact Alternate names Contactpersoon Definition A contact party (e.g. guardian, partner, friend) for the patient. Requirements Need to track people you can contact about the patient. 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 is used to capture information about any person that is related to the patient, using the profile https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson. 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. The HdBe-ContactPerson can be referenced using the extension in `contact:contactPerson`. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` pat-1:SHALL at least contain a contact's details or a reference to an organization `name.exists() or telecom.exists() or address.exists() or organization.exists()` Mappings rim:n/a rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON] cda:n/a zib-contactperson-v3.4-2020EN:NL-CM:3.1.1 HdBe-ContactPerson:contact
extension	I	0..*	Extension	Element Id Patient.contact.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) 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
contactPerson	I	0..1	Extension(Reference(RelatedPerson))	Element Id Patient.contact.extension:contactPerson Short description This contact may have further details in this RelatedPerson Alternate names extensions, user content Definition In some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate. 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(Reference(RelatedPerson)) Extension URL http://hl7.org/fhir/StructureDefinition/patient-relatedPerson 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
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.extension:contactPerson.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/patient-relatedPerson Mappings rim:N/A
value[x]		1..1		Element Id Patient.contact.extension:contactPerson.value[x] Short description Contact Alternate names Contactpersoon Definition Reference to a HdBe-ContactPerson instance containing the full details for the current contact. 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 zib-contactperson-v3.4-2020EN:NL-CM:3.1.1 HdBe-ContactPerson:contact
valueReference			Reference(RelatedPerson\| HdBe ContactPerson)	Data Type Reference(RelatedPerson\| HdBe ContactPerson)
relationship		0..*	CodeableConceptBinding	Element Id Patient.contact.relationship Short description The kind of relationship Definition The nature of the relationship between the patient and the contact person. Requirements Used to determine which contact person is the most relevant to approach, depending on circumstances. 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 a contact person for that patient. PatientContactRelationship (extensible) 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 v2:NK1-7, NK1-3 rim:code cda:n/a
role		0..*	CodeableConceptBinding	Element Id Patient.contact.relationship:role Short description Role Alternate names Rol Definition Defines the role of the contact in relation to the patient. Requirements Used to determine which contact person is the most relevant to approach, depending on circumstances. 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 v2:NK1-7, NK1-3 rim:code cda:n/a zib-contactperson-v3.4-2020EN:NL-CM:3.1.2 HdBe-ContactPerson:role
relationship		0..*	CodeableConceptBinding	Element Id Patient.contact.relationship:relationship Short description Relationship Alternate names Relatie Definition Defines the contact’s familial relationship to the patient. Requirements Used to determine which contact person is the most relevant to approach, depending on circumstances. 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 v2:NK1-7, NK1-3 rim:code cda:n/a zib-contactperson-v3.4-2020EN:NL-CM:3.1.3 HdBe-ContactPerson:relationship
name	I	0..1	HdBe NameInformation	Element Id Patient.contact.name Short description NameInformation Alternate names Naamgegevens Definition Full name of the contact. Requirements Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. Comments The cardinality mismatch between the CBB (0..1) and FHIR (0..) is explained by the presence of the HumanName.use element. A full name can be broken into parts using multiple instances of HumanName that have its own value for use. Data Type* HdBe NameInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a familiy name is specified, the family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2:If the prefix for a partner family name is specified, the partner family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` zib-NameInformation-3:If the name is specified as 'official' then the name is expected to contain only official parts `use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()` Examples Structured HumanName (preferred above unstructured) { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "text": "Irma Jongeneel-de Haas", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } Unstructured HumanName { "text": "Irma Jongeneel-de Haas" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:NK1-2 rim:name cda:n/a zib-nameinformation-v1.1-2020EN:NL-CM:20.4.1 HdBe-NameInformation:name_information zib-contactperson-v3.4-2020EN:NL-CM:3.1.4 hdbe-ContactInformation:name_information
telecom	I	0..*	ContactPoint	Element Id Patient.contact.telecom Short description ContactInformation Alternate names Contactgegevens Definition The contact’s telephone number and/or e-mail address. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The cardinality mismatch between the zib (0..1) and FHIR (0..) is explained by the containers TelephoneNumbers (0..) and EmailAddresses (0..) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. Data Type* ContactPoint Sliced: Unordered, Open, by $this(Profile) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a zib-contactperson-v3.4-2020EN:NL-CM:3.1.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1 HdBe-ContactPerson:contact_information hdbe-ContactInformation:contact_information
telephoneNumbers	I	0..*	HdBe ContactInformation TelephoneNumbers	Element Id Patient.contact.telecom:telephoneNumbers Short description TelephoneNumbers Alternate names Telefoonnummers Definition Container of the TelephoneNumbers concept. This container contains all data elements of the TelephoneNumbers concept. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Implementation of the "TelephoneNumbers" concept of CBB ContactInformation. Please note that, although the concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the CBB uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the CBB code will need to be communicated using the codeSpecification extension. Data Type HdBe ContactInformation TelephoneNumbers Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 HdBe-ContactInformation:telephone_numbers
emailAddresses	I	0..*	HdBe ContactInformation EmailAddresses	Element Id Patient.contact.telecom:emailAddresses Short description EmailAddresses Alternate names EmailAdressen Definition Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The "EmailAddresses" concept of CBB ContactInformation. Data Type HdBe ContactInformation EmailAddresses Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:email_addresses
address		0..1	HdBe AddressInformation	Element Id Patient.contact.address Short description AddressInformation Alternate names Adresgegevens Definition Contact’s address information. Requirements Need to keep track where the contact person can be contacted per postal mail or visited. Comments This element can and should not completely capture the AddressInformation concept from CBB ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full address information should instead be captured using an instance of HdBe-ContactPerson, which can then be referenced from this resource. See the comment on `Patient.contact` for more information. 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 cda:n/a zib-addressinformation-v1.1-2020EN:NL-CM:20.5.1 HdBe-AddressInformation:address_information zib-contactperson-v3.4-2020EN:NL-CM:3.1.5 HdBe-ContactPerson:address_information
gender		0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. 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:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender cda:n/a
organization	I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.contact.organization Short description Organization that is associated with the contact Definition Organization on behalf of which the contact is acting or for which the contact is working. Requirements For guardians or business related contacts, the organization is relevant. 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(Organization) 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:NK1-13, NK1-30, NK1-31, NK1-32, NK1-41 rim:scoper cda:n/a
period	I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.period Short description The period during which this contact person or organization is valid to be contacted relating to this patient Definition The period during which this contact person or organization is valid to be contacted relating to this patient. 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"] rim:effectiveTime cda:n/a
communication		0..*	BackboneElement	There are no (further) constraints on this element Element Id Patient.communication Short description A language which may be used to communicate with the patient about his or her health Definition A language which may be used to communicate with the patient about his or her health. Requirements If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are 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 Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient 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 cda:patient.languageCommunication
language		1..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Patient.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 v2:PID-15, LAN-2 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/languageCommunication/code cda:.languageCode
preferred		0..1	boolean	There are no (further) constraints on this element Element Id Patient.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 v2:PID-15 rim:preferenceInd cda:.preferenceInd
generalPractitioner	I	0..*	Reference(Organization\| Practitioner\| PractitionerRole)	There are no (further) constraints on this element Element Id Patient.generalPractitioner Short description Patient's nominated primary care provider Alternate names careProvider Definition Patient's nominated care provider. Comments This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. Data Type Reference(Organization\| Practitioner\| PractitionerRole) 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:PD1-4 rim:subjectOf.CareEvent.performer.AssignedEntity cda:n/a
managingOrganization	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.managingOrganization Short description Organization that is the custodian of the patient record Definition Organization that is the custodian of the patient record. Requirements Need to know who recognizes this patient record, manages and updates it. Comments There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). Data Type Reference(Organization) 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) rim:scoper cda:.providerOrganization
link	Σ ?!	0..*	BackboneElement	There are no (further) constraints on this element Element Id Patient.link Short description Link to another patient resource that concerns the same actual person Definition Link to another patient resource that concerns the same actual patient. Requirements There are multiple use cases: Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and Distribution of patient information across multiple servers. Comments There is no assumption that linked patient records have mutual links. 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:outboundLink cda:n/a
other	Σ I	1..1	Reference(Patient\| RelatedPerson)	There are no (further) constraints on this element Element Id Patient.link.other Short description The other patient or related person resource that the link refers to Definition The other patient resource that the link refers to. Comments Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Data Type Reference(Patient\| RelatedPerson) 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, MRG-1 rim:id cda:n/a
type	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Patient.link.type Short description replaced-by \| replaces \| refer \| seealso Definition The type of link between this patient resource and another patient resource. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The type of link between this patient resource and another patient resource. LinkType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:typeCode cda:n/a

Patient	I		Patient	Element Id Patient Short description Patient Alternate names SubjectOfCare Client Resident, Patient Definition Demographics and other administrative information about an individual or animal receiving care or other health-related services. Data Type Patient 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:Patient[classCode=PAT] cda:ClinicalDocument.recordTarget.patientRole zib-patient-v3.2-2020EN:NL-CM:0.1.1 HdBe-Patient:patient
extension	I	0..*	Extension	Element Id Patient.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) 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
nationality	I	0..*	Extension(Complex)	Element Id Patient.extension:nationality Short description Nationality Alternate names extensions, user content Definition The nationality of the patient. Comments Due to the nature of the nationality core extension (which allows for a period to be placed next to the nationality and thus allows for different nationalities over time), the cardinality of the extension is left at 0..* instead of the CBB cardinality of 0..1. Data Type Extension(Complex) Extension URL http://hl7.org/fhir/StructureDefinition/patient-nationality 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
extension	I	0..*	Extension	Element Id Patient.extension:nationality.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) 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
code	I	0..1	Extension	There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:code Short description Nationality Code Alternate names extensions, user content Definition Code representing nationality of patient. 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
url		1..1	uriFixed Value	There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:code.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type uri Fixed Value code Mappings rim:N/A
value[x]		1..1	Binding	Element Id Patient.extension:nationality.extension:code.value[x] Short description Nationality Alternate names Nationaliteit Definition Indicates the country of citizenship. Binding Iso 3166 Part 1: 2 Letter Codes Iso3166-1-2 (extensible) 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 zib-nationality-v3.0-2020EN:NL-CM:7.6.3 HdBe-Nationality:nationality
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
period	I	0..1	Extension	There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:period Short description Nationality Period Alternate names extensions, user content Definition Period when nationality was effective. 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
url		1..1	uriFixed Value	There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:period.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type uri Fixed Value period Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.extension:nationality.extension:period.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). 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
valuePeriod			Period	There are no (further) constraints on this element Data Type Period
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.extension:nationality.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/patient-nationality Mappings rim:N/A
value[x]		0..0		There are no (further) constraints on this element Element Id Patient.extension:nationality.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). 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
identifier	Σ	0..*	Identifier	Element Id Patient.identifier Short description PatientIdentificationNumber Alternate names Identificatienummer Definition The patient’s identification number. Typically, when an social security identification number (NISS-INSZ), is available it is used. A local identifier may be provided when this is desired. Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier Sliced: Unordered, Open, by $this(Value) 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:PID-3 rim:id cda:.id HdBe-Patient:patient_identification_number zib-patient-v3.2-2020EN:NL-CM:0.1.7
SSIN	Σ	0..*	Identifier	Element Id Patient.identifier:SSIN Short description An identifier for this patient Definition An identifier for this patient according to SSIN (NISS-INSZ.) Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern { "system": "https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin" } 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:PID-3 rim:id cda:.id
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element Id Patient.active Short description Whether this patient's record is in active use Definition Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. Requirements Need to be able to mark a patient record as not to be used because it was created in error. Comments If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. 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 cda:n/a
name	Σ I	0..*	HdBe NameInformation	Element Id Patient.name Short description NameInformation Alternate names Naamgegevens Definition Patient's full name. The cardinality differs from the CBB to allow including several name elements with a different name.use each. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments The cardinality mismatch between the CBB (0..1) and FHIR (0..) is explained by the presence of the HumanName.use element. A full name can be broken into parts using multiple instances of HumanName that have its own value for use. Data Type* HdBe NameInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a familiy name is specified, the family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2:If the prefix for a partner family name is specified, the partner family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` zib-NameInformation-3:If the name is specified as 'official' then the name is expected to contain only official parts `use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()` Examples Structured HumanName (preferred above unstructured) { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "text": "Irma Jongeneel-de Haas", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } Unstructured HumanName { "text": "Irma Jongeneel-de Haas" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name zib-nameinformation-v1.1-2020EN:NL-CM:20.4.1 HdBe-NameInformation:name_information HdBe-Patient:name_information zib-patient-v3.2-2020EN:NL-CM:0.1.6
telecom	Σ I	0..*	ContactPoint	Element Id Patient.telecom Short description ContactInformation Alternate names Contactgegevens Definition Patient’s telephone number(s) or e-mail address(es). Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The cardinality mismatch between the CBB (0..1) and FHIR (0..) is explained by the containers inside the ContactInformation model which are 0... FHIR ContactPoint does not have these containers. Data Type ContactPoint Sliced: Unordered, Open, by $this(Profile) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom HdBe-Patient:contact_information zib-patient-v3.2-2020EN:NL-CM:0.1.5 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1
telephoneNumbers	Σ I	0..*	HdBe ContactInformation TelephoneNumbers	Element Id Patient.telecom:telephoneNumbers Short description TelephoneNumbers Alternate names Telefoonnummers Definition Container of the TelephoneNumbers concept. This container contains all data elements of the TelephoneNumbers concept. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Implementation of the "TelephoneNumbers" concept of CBB ContactInformation. Please note that, although the concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the CBB uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the CBB code will need to be communicated using the codeSpecification extension. Data Type HdBe ContactInformation TelephoneNumbers Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 HdBe-ContactInformation:telephone_numbers
emailAddresses	Σ I	0..*	HdBe ContactInformation EmailAddresses	Element Id Patient.telecom:emailAddresses Short description EmailAddresses Alternate names EmailAdressen Definition Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The "EmailAddresses" concept of CBB ContactInformation. Data Type HdBe ContactInformation EmailAddresses Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:email_addresses
gender	Σ	0..1	codeBinding	Element Id Patient.gender Short description Gender Alternate names Geslacht Definition Patient’s administrative gender. The gender that that the patient is considered to have for administration and record keeping purposes. Note that the gender might not match the biological sex as determined by genetics or the individual's preferred identification. The Observation resource can deal with specific sex or gender aspect of interest. Requirements Needed for identification of the individual, in combination with (at least) name and birth date. Comments The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. Data Type code Binding Use ConceptMap 'GenderCodelijst-to-AdministrativeGender' to translate CBB terminology to profile terminology in ValueSet 'AdministrativeGender' AdministrativeGender (required) Permitted Values Gender_to_AdministrativeGender Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-8 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender cda:.patient.administrativeGenderCode HdBe-Patient:gender zib-patient-v3.2-2020EN:NL-CM:0.1.9
extension	I	0..*	Extension	Element Id Patient.gender.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) 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
genderCodelist	I	0..1	Extension(CodeableConcept)	Element Id Patient.gender.extension:genderCodelist Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. 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(CodeableConcept) Extension URL https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification 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
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.gender.extension:genderCodelist.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value https://fhir.healthdata.be/StructureDefinition/ext-CodeSpecification Mappings rim:N/A
value[x]		0..1	Binding	Element Id Patient.gender.extension:genderCodelist.value[x] Short description Gender Alternate names Geslacht Definition Patient’s administrative gender. Binding GenderCodelist Gender (required) 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 HdBe-Patient:gender zib-patient-v3.2-2020EN:NL-CM:0.1.9
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
birthDate	Σ	0..1	date	Element Id Patient.birthDate Short description DateOfBirth Alternate names Geboortedatum Definition Patient’s date of birth. The date of birth is mandatory for a patient. A vague date (such as only the year) is permitted. Requirements Age of the individual drives many clinical processes. Comments At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). 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 v2:PID-7 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/birthTime cda:.patient.birthTime loinc:21112-8 HdBe-Patient:date_of_birth zib-patient-v3.2-2020EN:NL-CM:0.1.10
deceased[x]	Σ ?!	0..1		Element Id Patient.deceased[x] Short description Indicates if the individual is deceased or not Definition Indicates if the individual is deceased or not. Requirements The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. Comments If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. Sliced: Unordered, Open, by $this(Type) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-30 (bool) and PID-29 (datetime) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime cda:n/a
deceasedBoolean	Σ ?!	0..1	boolean	Element Id Patient.deceased[x]:deceasedBoolean Short description DeathIndicator Alternate names OverlijdensIndicator Definition An indication stating whether the patient has died. Requirements The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. Comments If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. 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 v2:PID-30 (bool) and PID-29 (datetime) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime cda:n/a HdBe-Patient:death_indicator zib-patient-v3.2-2020EN:NL-CM:0.1.32
deceasedDateTime	Σ ?!	0..1	dateTime	Element Id Patient.deceased[x]:deceasedDateTime Short description DateOfDeath Alternate names DatumOverlijden, OverlijdensIndicator Definition The date on which the patient died. A ‘vague’ date, such as only the year, is permitted. Requirements The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. Comments The CBB recognizes both the DeathIndicator (boolean) and DateOfDeath (datetime) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if deceasedDateTime is present and has a value, its value can be mapped to DateOfDeath and DeathIndicator is assumed to be true. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-30 (bool) and PID-29 (datetime) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime cda:n/a HdBe-Patient:date_of_death HdBe-Patient:death_indicator zib-patient-v3.2-2020EN:NL-CM:0.1.33 zib-patient-v3.2-2020EN:NL-CM:0.1.32
address	Σ	0..*	HdBe AddressInformation	Element Id Patient.address Short description AddressInformation Alternate names Adresgegevens Definition Patient's address information. Requirements May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. 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:PID-11 rim:addr cda:.addr zib-addressinformation-v1.1-2020EN:NL-CM:20.5.1 HdBe-AddressInformation:address_information HdBe-Patient:address_information zib-patient-v3.2-2020EN:NL-CM:0.1.4
maritalStatus		0..1	CodeableConceptBinding	Element Id Patient.maritalStatus Short description MaritalStatus Alternate names BurgerlijkeStaat Definition A person’s marital status. Requirements Most, if not all systems capture it. 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 Use ConceptMap 'MaritalStatus-to-MaritalStatus' to translate CBB terminology to profile terminology in ValueSet 'MaritalStatus' Marital Status Codes (required) Permitted Values MaritalStatus_to_MaritalStatus 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 v2:PID-16 rim:player[classCode=PSN]/maritalStatusCode cda:.patient.maritalStatusCode HdBe-MaritalStatus:marital_status zib-maritalstatus-v3.1-2020EN:NL-CM:7.9.2
multipleBirth[x]		0..1		Element Id Patient.multipleBirth[x] Short description Whether patient is part of a multiple birth Definition Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Comments Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). Sliced: Unordered, Open, by $this(Type) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-24 (bool), PID-25 (integer) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda:n/a
multipleBirthBoolean		0..1	boolean	Element Id Patient.multipleBirth[x]:multipleBirthBoolean Short description MultipleBirthIndicator Alternate names MeerlingIndicator Definition An indication stating whether the patient is of a multiple birth. Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Comments Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). 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 v2:PID-24 (bool), PID-25 (integer) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda:n/a HdBe-Patient:multiple_birth_indicator zib-patient-v3.2-2020EN:NL-CM:0.1.31
multipleBirthInteger		0..1	integer	Element Id Patient.multipleBirth[x]:multipleBirthInteger Short description MultipleBirthOrder Definition An indication of the birth order in case the patient is of a multiple birth. Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Comments The CBB recognizes both the MultipleBirthIndicator (boolean) and MultipleBirthOrder (integer) concepts, whereas in FHIR only one of these concepts may be present. Therefore, if multipleBirthInteger is present and has a value, its value can be mapped to MultipleBirthOrder and MultipleBirthIndicator is assumed to be true. Data Type integer Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-24 (bool), PID-25 (integer) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda:n/a HdBe-Patient:multiple_birth_order HdBe-Patient:multiple_birth_indicator
photo	I	0..*	Attachment	There are no (further) constraints on this element Element Id Patient.photo Short description Image of the patient Definition Image of the patient. Requirements Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Comments Guidelines: Use id photos, not clinical photos. Limit dimensions to thumbnail. Keep byte count low to ease resource updates. 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\|ANM and determinerCode=INSTANCE]/desc cda:n/a
contact	I	0..*	BackboneElement	Element Id Patient.contact Short description Contact Alternate names Contactpersoon Definition A contact party (e.g. guardian, partner, friend) for the patient. Requirements Need to track people you can contact about the patient. 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 is used to capture information about any person that is related to the patient, using the profile https://fhir.healthdata.be/StructureDefinition/HdBe-ContactPerson. 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. The HdBe-ContactPerson can be referenced using the extension in `contact:contactPerson`. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` pat-1:SHALL at least contain a contact's details or a reference to an organization `name.exists() or telecom.exists() or address.exists() or organization.exists()` Mappings rim:n/a rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON] cda:n/a zib-contactperson-v3.4-2020EN:NL-CM:3.1.1 HdBe-ContactPerson:contact
extension	I	0..*	Extension	Element Id Patient.contact.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) 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
contactPerson	I	0..1	Extension(Reference(RelatedPerson))	Element Id Patient.contact.extension:contactPerson Short description This contact may have further details in this RelatedPerson Alternate names extensions, user content Definition In some cases a Patient.contact will also be populated as a RelatedPerson resource. This linkage permits the linkage between the 2 resources to be able to accurately indicate a representation of the same individual, and updating details between could be appropriate. 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(Reference(RelatedPerson)) Extension URL http://hl7.org/fhir/StructureDefinition/patient-relatedPerson 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
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.extension:contactPerson.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value http://hl7.org/fhir/StructureDefinition/patient-relatedPerson Mappings rim:N/A
value[x]		1..1		Element Id Patient.contact.extension:contactPerson.value[x] Short description Contact Alternate names Contactpersoon Definition Reference to a HdBe-ContactPerson instance containing the full details for the current contact. 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 zib-contactperson-v3.4-2020EN:NL-CM:3.1.1 HdBe-ContactPerson:contact
valueReference			Reference(RelatedPerson\| HdBe ContactPerson)	Data Type Reference(RelatedPerson\| HdBe ContactPerson)
relationship		0..*	CodeableConceptBinding	Element Id Patient.contact.relationship Short description The kind of relationship Definition The nature of the relationship between the patient and the contact person. Requirements Used to determine which contact person is the most relevant to approach, depending on circumstances. 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 a contact person for that patient. PatientContactRelationship (extensible) 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 v2:NK1-7, NK1-3 rim:code cda:n/a
role		0..*	CodeableConceptBinding	Element Id Patient.contact.relationship:role Short description Role Alternate names Rol Definition Defines the role of the contact in relation to the patient. Requirements Used to determine which contact person is the most relevant to approach, depending on circumstances. 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 v2:NK1-7, NK1-3 rim:code cda:n/a zib-contactperson-v3.4-2020EN:NL-CM:3.1.2 HdBe-ContactPerson:role
relationship		0..*	CodeableConceptBinding	Element Id Patient.contact.relationship:relationship Short description Relationship Alternate names Relatie Definition Defines the contact’s familial relationship to the patient. Requirements Used to determine which contact person is the most relevant to approach, depending on circumstances. 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 v2:NK1-7, NK1-3 rim:code cda:n/a zib-contactperson-v3.4-2020EN:NL-CM:3.1.3 HdBe-ContactPerson:relationship
name	I	0..1	HdBe NameInformation	Element Id Patient.contact.name Short description NameInformation Alternate names Naamgegevens Definition Full name of the contact. Requirements Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. Comments The cardinality mismatch between the CBB (0..1) and FHIR (0..) is explained by the presence of the HumanName.use element. A full name can be broken into parts using multiple instances of HumanName that have its own value for use. Data Type* HdBe NameInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a familiy name is specified, the family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()` zib-NameInformation-2:If the prefix for a partner family name is specified, the partner family name is expected as well `name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()` zib-NameInformation-3:If the name is specified as 'official' then the name is expected to contain only official parts `use.where(value = 'official').exists() implies given.extension('http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value = 'CL').exists().not()` Examples Structured HumanName (preferred above unstructured) { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "text": "Irma Jongeneel-de Haas", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } Unstructured HumanName { "text": "Irma Jongeneel-de Haas" } Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:NK1-2 rim:name cda:n/a zib-nameinformation-v1.1-2020EN:NL-CM:20.4.1 HdBe-NameInformation:name_information zib-contactperson-v3.4-2020EN:NL-CM:3.1.4 hdbe-ContactInformation:name_information
telecom	I	0..*	ContactPoint	Element Id Patient.contact.telecom Short description ContactInformation Alternate names Contactgegevens Definition The contact’s telephone number and/or e-mail address. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The cardinality mismatch between the zib (0..1) and FHIR (0..) is explained by the containers TelephoneNumbers (0..) and EmailAddresses (0..) inside the ContactInformation model. The FHIR datatype ContactPoint does not have these containers. Data Type* ContactPoint Sliced: Unordered, Open, by $this(Profile) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a zib-contactperson-v3.4-2020EN:NL-CM:3.1.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1 HdBe-ContactPerson:contact_information hdbe-ContactInformation:contact_information
telephoneNumbers	I	0..*	HdBe ContactInformation TelephoneNumbers	Element Id Patient.contact.telecom:telephoneNumbers Short description TelephoneNumbers Alternate names Telefoonnummers Definition Container of the TelephoneNumbers concept. This container contains all data elements of the TelephoneNumbers concept. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments Implementation of the "TelephoneNumbers" concept of CBB ContactInformation. Please note that, although the concepts TelecomType and NumberType are functionally equivalent to the FHIR concepts `ContactPoint.system` and `ContactPoint.use` respectively, a mismatch occurs on the concept of mobile phone numbers; the CBB uses the first concept and FHIR the second. For this reason, the ValueSet on `ContactPoint.system` is too narrow and the CBB code will need to be communicated using the codeSpecification extension. Data Type HdBe ContactInformation TelephoneNumbers Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 HdBe-ContactInformation:telephone_numbers
emailAddresses	I	0..*	HdBe ContactInformation EmailAddresses	Element Id Patient.contact.telecom:emailAddresses Short description EmailAddresses Alternate names EmailAdressen Definition Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments The "EmailAddresses" concept of CBB ContactInformation. Data Type HdBe ContactInformation EmailAddresses Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:email_addresses
address		0..1	HdBe AddressInformation	Element Id Patient.contact.address Short description AddressInformation Alternate names Adresgegevens Definition Contact’s address information. Requirements Need to keep track where the contact person can be contacted per postal mail or visited. Comments This element can and should not completely capture the AddressInformation concept from CBB ContactPerson; it should just be used for the information that is needed for contacting the person in relation to care of the patient. The full address information should instead be captured using an instance of HdBe-ContactPerson, which can then be referenced from this resource. See the comment on `Patient.contact` for more information. 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 cda:n/a zib-addressinformation-v1.1-2020EN:NL-CM:20.5.1 HdBe-AddressInformation:address_information zib-contactperson-v3.4-2020EN:NL-CM:3.1.5 HdBe-ContactPerson:address_information
gender		0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. 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:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender cda:n/a
organization	I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.contact.organization Short description Organization that is associated with the contact Definition Organization on behalf of which the contact is acting or for which the contact is working. Requirements For guardians or business related contacts, the organization is relevant. 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(Organization) 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:NK1-13, NK1-30, NK1-31, NK1-32, NK1-41 rim:scoper cda:n/a
period	I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.period Short description The period during which this contact person or organization is valid to be contacted relating to this patient Definition The period during which this contact person or organization is valid to be contacted relating to this patient. 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"] rim:effectiveTime cda:n/a
communication		0..*	BackboneElement	There are no (further) constraints on this element Element Id Patient.communication Short description A language which may be used to communicate with the patient about his or her health Definition A language which may be used to communicate with the patient about his or her health. Requirements If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are 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 Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient 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 cda:patient.languageCommunication
language		1..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Patient.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 v2:PID-15, LAN-2 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/languageCommunication/code cda:.languageCode
preferred		0..1	boolean	There are no (further) constraints on this element Element Id Patient.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 v2:PID-15 rim:preferenceInd cda:.preferenceInd
generalPractitioner	I	0..*	Reference(Organization\| Practitioner\| PractitionerRole)	There are no (further) constraints on this element Element Id Patient.generalPractitioner Short description Patient's nominated primary care provider Alternate names careProvider Definition Patient's nominated care provider. Comments This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. Data Type Reference(Organization\| Practitioner\| PractitionerRole) 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:PD1-4 rim:subjectOf.CareEvent.performer.AssignedEntity cda:n/a
managingOrganization	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.managingOrganization Short description Organization that is the custodian of the patient record Definition Organization that is the custodian of the patient record. Requirements Need to know who recognizes this patient record, manages and updates it. Comments There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). Data Type Reference(Organization) 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) rim:scoper cda:.providerOrganization
link	Σ ?!	0..*	BackboneElement	There are no (further) constraints on this element Element Id Patient.link Short description Link to another patient resource that concerns the same actual person Definition Link to another patient resource that concerns the same actual patient. Requirements There are multiple use cases: Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and Distribution of patient information across multiple servers. Comments There is no assumption that linked patient records have mutual links. 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:outboundLink cda:n/a
other	Σ I	1..1	Reference(Patient\| RelatedPerson)	There are no (further) constraints on this element Element Id Patient.link.other Short description The other patient or related person resource that the link refers to Definition The other patient resource that the link refers to. Comments Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Data Type Reference(Patient\| RelatedPerson) 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, MRG-1 rim:id cda:n/a
type	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Patient.link.type Short description replaced-by \| replaces \| refer \| seealso Definition The type of link between this patient resource and another patient resource. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The type of link between this patient resource and another patient resource. LinkType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:typeCode cda:n/a

Mapping FHIR profile to CBB

Path	map	CBB
Patient	patient	HdBe-Patient
Patient.extension:nationality.extension:code.value[x]	nationality	HdBe-Nationality
Patient.identifier	patient_identification_number	HdBe-Patient
Patient.name	name_information	HdBe-Patient
Patient.telecom	contact_information	HdBe-Patient
Patient.gender	gender	HdBe-Patient
Patient.gender.extension:genderCodelist.value[x]	gender	HdBe-Patient
Patient.birthDate	date_of_birth	HdBe-Patient
Patient.deceased[x]:deceasedBoolean	death_indicator	HdBe-Patient
Patient.deceased[x]:deceasedDateTime	date_of_death	HdBe-Patient
Patient.deceased[x]:deceasedDateTime	death_indicator	HdBe-Patient
Patient.address	address_information	HdBe-Patient
Patient.maritalStatus	marital_status	HdBe-MaritalStatus
Patient.multipleBirth[x]:multipleBirthBoolean	multiple_birth_indicator	HdBe-Patient
Patient.multipleBirth[x]:multipleBirthInteger	multiple_birth_order	HdBe-Patient
Patient.multipleBirth[x]:multipleBirthInteger	multiple_birth_indicator	HdBe-Patient
Patient.contact	contact	HdBe-ContactPerson
Patient.contact.extension:contactPerson.value[x]	contact	HdBe-ContactPerson
Patient.contact.relationship:role	role	HdBe-ContactPerson
Patient.contact.relationship:relationship	relationship	HdBe-ContactPerson
Patient.contact.telecom	contact_information	HdBe-ContactPerson
Patient.contact.address	address_information	HdBe-ContactPerson

zib Patient difference

Concept	Category	Description
`patient_identification_number`	textual	Replaced the Dutch context (BSN) with the Belgian equivalent (NISS-INSZ).
`patient_identification_number`	mapping	Moved mapping from the slice definition to the root identifier. Nictiz ticket #230
`gender`	textual	Extended definition to clarify that the concept is about administrative gender rather then the patient's identified sex.
`maritalStatus`	terminology	Added ConceptMap to translate SNOMED codes as defined by the CBB to the FHIR ValueSet MaritalStatus.
`multiple_birth_order`	element	Added mapping to mulitple birth order.
`extension:nationality.extension:code`	terminology	Replaced GBA Nationaliteitentabel with ISO 3166.

Terminology Bindings

Path	Name	Strength	URL	ConceptMap
Patient.extension.extension.value[x]	iso3166-1-2	extensible	http://hl7.org/fhir/ValueSet/iso3166-1-2	No bound ConceptMap
Patient.gender	administrative-gender\|4.0.1	required	http://hl7.org/fhir/ValueSet/administrative-gender\|4.0.1	https://fhir.healthdata.be/ConceptMap/Gender-to-AdministrativeGender
Patient.gender.extension.value[x]	Gender	required	https://fhir.healthdata.be/ValueSet/Gender	No bound ConceptMap
Patient.maritalStatus	marital-status	required	http://hl7.org/fhir/ValueSet/marital-status	https://fhir.healthdata.be/ConceptMap/MaritalStatus-to-MaritalStatus
Patient.contact.relationship	Role	required	https://fhir.healthdata.be/ValueSet/Role	No bound ConceptMap
Patient.contact.relationship	Relationship	required	https://fhir.healthdata.be/ValueSet/Relationship	No bound ConceptMap