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

HdBe-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 Belgian 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	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	There are no (further) constraints on this element 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	There are no (further) constraints on this element 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 CountryISO (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:NationalityRC.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.PatientIdentificationNumber zib-patient-v3.2-2020EN:NL-CM:0.1.7
SSIN	Σ	0..*	IdentifierPattern	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/core/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. Meaning When Missing This resource is generally assumed to be active if no value is provided for the active element Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:statusCode cda:n/a
name	Σ	0..*	HumanName	Element Id Patient.name Short description NameInformation Alternate names Naamgegevens Definition Patient's full name. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Data Type HumanName Sliced: Unordered, Open, by use(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name zib-patient-v3.2-2020EN:NL-CM:0.1.6 HdBe-Patient:Patient.NameInformation
nameInformation	Σ I	0..2	HdBe-NameInformation	Element Id Patient.name:nameInformation Short description NameInformation Alternate names Naamgegevens Definition This slice represents the person's official name information, including given names, last name and possibly the partner's last name. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments This `.name` element represents a Belgian name according to the CBB NameInformation (except for the GivenName concept). A Belgian name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Belgian rules. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Belgian context SHOULD support these extensions as specified here. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Belgian contexts. It is encouraged to provide a representation of the full name in the `.text` element. Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept. Note 2: This element should only contain a person's official names. The GivenName concept is represented in another `.name` element with `.name.use` = usual. Note 3: The examples illustrate how the CBB is mapped to FHIR. Data Type HdBe-NameInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a 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()` 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:NameInformation
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.name:nameInformation.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
nameUsage	I	0..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.extension:nameUsage Short description Preferred display order of name parts Alternate names extensions, user content Definition A code that represents the preferred display order of the components of this human name. 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(code) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-assembly-order 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.name:nameInformation.extension:nameUsage.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/humanname-assembly-order Mappings rim:N/A
value[x]		1..1	Binding	There are no (further) constraints on this element Element Id Patient.name:nameInformation.extension:nameUsage.value[x] Short description NameUsage Alternate names Naamgebruik Definition This concept indicates the last name or order of last names with which the person is to be addressed. Binding Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder HumanNameAssemblyOrder (required) Permitted Values NameUsage_to_HumanNameAssemblyOrder 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-nameinformation-v1.1-2020EN:NL-CM:20.4.7 HdBe-NameInformation:NameInformation.NameUsage
valueCode			code	There are no (further) constraints on this element Data Type code
use	Σ ?!	1..1	codeBindingFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value official Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.text Short description Text representation of the full name Definition Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family Short description Family name (often called 'Surname') Alternate names surname Definition The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.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
prefix	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:prefix Short description Voorvoegsel derived from person's own surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-prefix 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 v2:FN.2 rim:ENXP where Qualifiers = (VV, R)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:prefix.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/humanname-own-prefix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:prefix.value[x] Short description Prefix Alternate names Voorvoegsels Definition Prefix to the person’s own last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.11 HdBe-NameInformation:NameInformation.LastName.Prefix
valueString			string	There are no (further) constraints on this element Data Type string
lastName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:lastName Short description Portion derived from person's own surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-name 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 v2:FN.3 rim:ENXP where Qualifiers = (BR)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:lastName.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/humanname-own-name Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:lastName.value[x] Short description LastName Alternate names Achternaam Definition The person’s official last name 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-nameinformation-v1.1-2020EN:NL-CM:20.4.10 HdBe-NameInformation:NameInformation.LastName.LastName
valueString			string	There are no (further) constraints on this element Data Type string
partnerPrefix	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerPrefix Short description Voorvoegsel derived from person's partner's surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix 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 v2:FN.4 rim:ENXP where Qualifiers = (VV, SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerPrefix.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/humanname-partner-prefix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerPrefix.value[x] Short description PartnerPrefix Alternate names VoorvoegselsPartner Definition Prefix to the partner’s last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.9 HdBe-NameInformation:NameInformation.LastNamePartner.PartnerPrefix
valueString			string	There are no (further) constraints on this element Data Type string
partnerLastName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerLastName Short description Portion derived from person's partner's surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-name 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 v2:FN.5 rim:ENXP where Qualifiers = (SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerLastName.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/humanname-partner-name Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerLastName.value[x] Short description PartnerLastName Alternate names AchternaamPartner Definition Partner’s official last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.8 HdBe-NameInformation:NameInformation.LastNamePartner.PartnerLastName
valueString			string	There are no (further) constraints on this element Data Type string
given	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.given Short description FirstName / Initial Alternate names first name, middle name, Voornaam, Initiaal Definition One of a person’s official first names or the initial if the full name is not known. Comments This element represents the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately. Therefore, the zib concepts are implemented here in the following way: Systems SHOULD use a `.given` element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR). Each of these elements: SHOULD be populated with the complete name if it is known, or with the initial if no more information is available. SHALL be augmented with `extension:givenOrInitial` with code BR when it represents a full name or code IN when it represents an initial. Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed. If a system does however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional `.name` instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance. Note 1: The GivenName concept should not be included here but in a separate `.name` instance where `.use` = usual. Note 2: As specified by FHIR, multiple official first names MAY be combined in a single `.given` element (separated by spaces), as long as the `.given` elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.4 HdBe-NameInformation:NameInformation.FirstNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.5 HdBe-NameInformation:NameInformation.Initials
extension	I	1..*	Extension	There are no (further) constraints on this element Element Id Patient.name:nameInformation.given.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
givenOrInitial	I	1..*	Extension(code)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.given.extension:givenOrInitial Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier 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 rim:ENXP.qualifier
prefix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.prefix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:NameInformation.Titles
suffix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.suffix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX] zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:NameInformation.Titles
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.name:nameInformation.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. 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"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
nameInformation-GivenName	Σ	0..*	HdBe-NameInformation.GivenName	Element Id Patient.name:nameInformation-GivenName Short description Name of a human - parts and usage Definition This slice represents the name information normally used to address the person. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments This `.name` element represents the Belgian given name ("roepnaam") according to the CBB NameInformation. Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other `.name` elements with `.name.use` = official. Note 2: The examples illustrate how the CBB is mapped to FHIR. Data Type HdBe-NameInformation.GivenName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name
telecom	Σ I	0..*	HdBe-ContactInformation	Element Id Patient.telecom Short description ContactInformation Alternate names Contactpunten, 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 Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps. Data Type HdBe-ContactInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:ContactInformation HdBe-Patient:Patient.ContactInformation zib-patient-v3.2-2020EN:NL-CM:0.1.5 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.telecom.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
comment	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.telecom.extension:comment 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(string) Extension URL https://fhir.healthdata.be/StructureDefinition/ext-Comment 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.telecom.extension:comment.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-Comment Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Patient.telecom.extension:comment.value[x] Short description Comment Alternate names Toelichting Definition Explanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionals) or that availability by phone is only possible during a specified part of the day. 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-contactinformation-v1.2-2020EN:NL-CM:20.6.9 HdBe-ContactInformation:ContactInformation.Comment
valueString			string	There are no (further) constraints on this element Data Type string
system	Σ I	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.telecom.system Short description Type Alternate names Type Definition The type of contact information. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.3 rim:./scheme servd:./ContactPointType zib-contactinformation-v1.2-2020EN:NL-CM:20.6.5 HdBe-ContactInformation:ContactInformation.Type
value	Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.telecom.value Short description Value Alternate names Waarde Definition The actual contact information details. Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.1 (or XTN.12) rim:./url servd:./Value zib-contactinformation-v1.2-2020EN:NL-CM:20.6.4 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.7 HdBe-ContactInformation:ContactInformation.Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.telecom.use Short description Use Alternate names Gebruik Definition Purpose or use of the contact information. For example whether it is a private or business telephone number. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data Type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.2 - but often indicated by field rim:unique(./use) servd:./ContactPointPurpose zib-contactinformation-v1.2-2020EN:NL-CM:20.6.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.8 HdBe-ContactInformation:ContactInformation.Use
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element Id Patient.telecom.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data Type positiveInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:n/a
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.telecom.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. 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"] v2:N/A rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
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:Patient.Gender zib-patient-v3.2-2020EN:NL-CM:0.1.9
extension	I	0..*	Extension	There are no (further) constraints on this element 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: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:Patient.DateOfBirth 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:Patient.DeathIndicator 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:Patient.DateOfDeath HdBe-Patient:Patient.DeathIndicator 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:AddressInformation HdBe-Patient:Patient.AddressInformation zib-patient-v3.2-2020EN:NL-CM:0.1.4
extension	I	1..*	Extension	There are no (further) constraints on this element Element Id Patient.address.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
language	I	1..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.address.extension:language Short description Human Language for the item Alternate names extensions, user content Definition The Human Language of the item. Comments This is used where an item may repeat to indicate the language of each repeat. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/language 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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.address.use Short description AddressType Alternate names AdresSoort Definition The type of address in question, such as a home address or mailing address. Requirements Allows an appropriate address to be chosen from a list of many. Comments Applications can assume that an address is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of an address. AddressUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General home Mappings rim:n/a v2:XAD.7 rim:unique(./use) servd:./AddressPurpose zib-addressinformation-v1.1-2020EN:NL-CM:20.5.8 HdBe-AddressInformation:AddressInformation.AddressUse
type	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.address.type Short description AddressType Alternate names AdresSoort Definition The type of address in question, such as a home address or mailing address. Comments The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). Data Type code Binding The type of an address (physical / postal). AddressType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General both Mappings rim:n/a v2:XAD.18 rim:unique(./use) vcard:address type parameter zib-addressinformation-v1.1-2020EN:NL-CM:20.5.8 HdBe-AddressInformation:AddressInformation.AddressType
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.text Short description Text representation of the address Definition Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street, Erewhon 9132 Mappings rim:n/a v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim:./formatted vcard:address label parameter
line	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.address.line Short description Street name, number, direction & P.O. Box etc. Definition This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Comments The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the `Address.line` to which they are attached. The value of `Address.line` should be populated with a complete string representation of all the separate extension values, like: "[Street] [HouseNumberIndication] [HouseNumber] [HouseNumberLetter] [HouseNumberAddition]". Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street Mappings rim:n/a v2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim:AD.part[parttype = AL] vcard:street servd:./StreetAddress (newline delimitted)
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.address.line.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
streetName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:streetName Short description streetName Alternate names extensions, user content Definition streetName. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName 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 rim:ADXP[partType=STR]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:streetName.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/iso21090-ADXP-streetName Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:streetName.value[x] Short description Street Alternate names Straat Definition Street name of the address. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.2 HdBe-AddressInformation:AddressInformation.Street
valueString			string	There are no (further) constraints on this element Data Type string
houseNumber	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumber Short description houseNumber Alternate names extensions, user content Definition The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber 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 rim:ADXP[partType=BNR]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumber.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/iso21090-ADXP-houseNumber Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumber.value[x] Short description HouseNumber Alternate names Huisnummer Definition House number of the address. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.12 HdBe-AddressInformation:AddressInformation.HouseNumber
valueString			string	There are no (further) constraints on this element Data Type string
houseNumberLetter-houseNumberAddition	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberLetter-houseNumberAddition Short description buildingNumberSuffix Alternate names extensions, user content Definition Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix 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 rim:ADXP[partType=BNS]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberLetter-houseNumberAddition.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/iso21090-ADXP-buildingNumberSuffix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberLetter-houseNumberAddition.value[x] Short description HouseNumberLetter / HouseNumberAddition Alternate names Huisnummerletter, Huisnummertoevoeging Definition Export: If a HouseNumberLetter as well as a HouseNumberAddition is known: HouseNumberLetter first, followed by a space and finally the HouseNumberAddition. If only a HouseNumberLetter is known, send just that. No trailing space is required. If only a HouseNumberAddition is known, communicate that with a leading space. Import If the value of buildingNumberSuffix contains no space, then the whole value is considered to be the HouseNumberLetter. If the value of buildingNumberSuffix contains a space, then everything before the first space is considered to be the HouseNumberLetter, and the everything trailing the first space is considered to be the HouseNumberAddition. Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.11 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.10 HdBe-AddressInformation:AddressInformation.HouseNumberLetter HdBe-AddressInformation:AddressInformation.HouseNumberAddition
valueString			string	There are no (further) constraints on this element Data Type string
houseNumberIndication	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberIndication Short description additionalLocator Alternate names extensions, user content Definition This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator 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 rim:ADXP[partType=ADL]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberIndication.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/iso21090-ADXP-additionalLocator Mappings rim:N/A
value[x]	I	1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberIndication.value[x] Short description HouseNumberIndication Alternate names AanduidingBijNummer Definition The indication used for addresses which do not consist of the usual street name and house number. Comments The coded HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to'). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` houseNumberIndication:Must have value 'by' or 'to' `value in ('by' \| 'to')` Mappings rim:n/a rim:N/A zib-addressinformation-v1.1-2020EN:NL-CM:20.5.9 HdBe-AddressInformation:AddressInformation.HouseNumberIndication
valueString			string	There are no (further) constraints on this element Data Type string
additionalInformation	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:additionalInformation Short description unitID Alternate names extensions, user content Definition The number or name of a specific unit contained within a building or complex, as assigned by that building or complex. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID 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 rim:ADXP[partType=UNID]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:additionalInformation.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/iso21090-ADXP-unitID Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:additionalInformation.value[x] Short description AdditionalInformation Alternate names AdditioneleInformatie 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 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.7 HdBe-AddressInformation:AddressInformation.AdditionalInformation
valueString			string	There are no (further) constraints on this element Data Type string
city	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.city Short description PlaceOfResidence Alternate names Municpality, Woonplaats Definition A geographically determined area which forms part of the municipal area. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Erewhon Mappings rim:n/a v2:XAD.3 rim:AD.part[parttype = CTY] vcard:locality servd:./Jurisdiction zib-addressinformation-v1.1-2020EN:NL-CM:20.5.3 HdBe-AddressInformation:AddressInformation.PlaceOfResidence
district	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.district Short description Municipality Alternate names County, Gemeente Definition Municipality of residence. Comments District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Madison Mappings rim:n/a v2:XAD.9 rim:AD.part[parttype = CNT \| CPA] zib-addressinformation-v1.1-2020EN:NL-CM:20.5.4 HdBe-AddressInformation:AddressInformation.Municipality
state	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.state Short description Sub-unit of country (abbreviations ok) Alternate names Province, Territory Definition Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.4 rim:AD.part[parttype = STA] vcard:region servd:./Region
postalCode	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.postalCode Short description Postcode Alternate names Zip, Postcode Definition Postcode of the address. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 9132 Mappings rim:n/a v2:XAD.5 rim:AD.part[parttype = ZIP] vcard:code servd:./PostalIdentificationCode zib-addressinformation-v1.1-2020EN:NL-CM:20.5.6 HdBe-AddressInformation:AddressInformation.Postcode
country	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.country Short description Country (e.g. can be ISO 3166 2 or 3 letter code) Definition Country - a nation as commonly understood or generally accepted. Comments The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the CodeSpecification extension under `Address.country.extension:countryCode`. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.6 rim:AD.part[parttype = CNT] vcard:country servd:./Country
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.address.country.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
countryCode	I	0..1	Extension(CodeableConcept)	There are no (further) constraints on this element Element Id Patient.address.country.extension:countryCode 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.address.country.extension:countryCode.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	There are no (further) constraints on this element Element Id Patient.address.country.extension:countryCode.value[x] Short description Country Alternate names Land Definition Country in which the address is located. Binding Iso 3166 Part 1: 2 Letter Codes CountryISO (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 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.5 HdBe-AddressInformation:AddressInformation.Country
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.address.period Short description Time period when address was/is in use Definition Time period when address was/is in use. Requirements Allows addresses to be placed in historical context. 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)` Examples General { "start": "2010-03-23", "end": "2010-07-01" } Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XAD.12 / XAD.13 + XAD.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
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 'BeCivilstate-to-MaritalStatus' to translate CBB terminology to profile terminology in ValueSet 'MaritalStatus' BeCivilstate (required) Permitted Values BeCivilstate_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:MaritalStatusRC.MaritalStatus 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:Patient.MultipleBirthIndicator 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:Patient.MultipleBirthOrder HdBe-Patient:Patient.MultipleBirthIndicator
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	There are no (further) constraints on this element 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 This element can and should not completely capture the NameInformation concept from the 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 name 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-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()` 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:NameInformation zib-contactperson-v3.4-2020EN:NL-CM:3.1.4 HdBe-ContactPerson:NameInformation
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.name.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
nameUsage	I	0..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.contact.name.extension:nameUsage Short description Preferred display order of name parts Alternate names extensions, user content Definition A code that represents the preferred display order of the components of this human name. 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(code) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-assembly-order 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.name.extension:nameUsage.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/humanname-assembly-order Mappings rim:N/A
value[x]		1..1	Binding	There are no (further) constraints on this element Element Id Patient.contact.name.extension:nameUsage.value[x] Short description NameUsage Alternate names Naamgebruik Definition This concept indicates the last name or order of last names with which the person is to be addressed. Binding Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder HumanNameAssemblyOrder (required) Permitted Values NameUsage_to_HumanNameAssemblyOrder 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-nameinformation-v1.1-2020EN:NL-CM:20.4.7 HdBe-NameInformation:NameInformation.NameUsage
valueCode			code	There are no (further) constraints on this element Data Type code
use	Σ ?!	1..1	codeBindingFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value official Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.name.text Short description Text representation of the full name Definition Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.name.family Short description Family name (often called 'Surname') Alternate names surname Definition The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.name.family.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
prefix	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:prefix Short description Voorvoegsel derived from person's own surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-prefix 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 v2:FN.2 rim:ENXP where Qualifiers = (VV, R)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:prefix.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/humanname-own-prefix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:prefix.value[x] Short description Prefix Alternate names Voorvoegsels Definition Prefix to the person’s own last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.11 HdBe-NameInformation:NameInformation.LastName.Prefix
valueString			string	There are no (further) constraints on this element Data Type string
lastName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:lastName Short description Portion derived from person's own surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-name 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 v2:FN.3 rim:ENXP where Qualifiers = (BR)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:lastName.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/humanname-own-name Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:lastName.value[x] Short description LastName Alternate names Achternaam Definition The person’s official last name 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-nameinformation-v1.1-2020EN:NL-CM:20.4.10 HdBe-NameInformation:NameInformation.LastName.LastName
valueString			string	There are no (further) constraints on this element Data Type string
partnerPrefix	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerPrefix Short description Voorvoegsel derived from person's partner's surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix 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 v2:FN.4 rim:ENXP where Qualifiers = (VV, SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerPrefix.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/humanname-partner-prefix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerPrefix.value[x] Short description PartnerPrefix Alternate names VoorvoegselsPartner Definition Prefix to the partner’s last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.9 HdBe-NameInformation:NameInformation.LastNamePartner.PartnerPrefix
valueString			string	There are no (further) constraints on this element Data Type string
partnerLastName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerLastName Short description Portion derived from person's partner's surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-name 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 v2:FN.5 rim:ENXP where Qualifiers = (SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerLastName.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/humanname-partner-name Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerLastName.value[x] Short description PartnerLastName Alternate names AchternaamPartner Definition Partner’s official last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.8 HdBe-NameInformation:NameInformation.LastNamePartner.PartnerLastName
valueString			string	There are no (further) constraints on this element Data Type string
given	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.contact.name.given Short description FirstName / Initial Alternate names first name, middle name, Voornaam, Initiaal Definition One of a person’s official first names or the initial if the full name is not known. Comments This element represents the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately. Therefore, the zib concepts are implemented here in the following way: Systems SHOULD use a `.given` element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR). Each of these elements: SHOULD be populated with the complete name if it is known, or with the initial if no more information is available. SHALL be augmented with `extension:givenOrInitial` with code BR when it represents a full name or code IN when it represents an initial. Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed. If a system does however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional `.name` instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance. Note 1: The GivenName concept should not be included here but in a separate `.name` instance where `.use` = usual. Note 2: As specified by FHIR, multiple official first names MAY be combined in a single `.given` element (separated by spaces), as long as the `.given` elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.4 HdBe-NameInformation:NameInformation.FirstNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.5 HdBe-NameInformation:NameInformation.Initials
extension	I	1..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.name.given.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
givenOrInitial	I	1..*	Extension(code)	There are no (further) constraints on this element Element Id Patient.contact.name.given.extension:givenOrInitial Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier 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 rim:ENXP.qualifier
prefix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.contact.name.prefix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:NameInformation.Titles
suffix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.contact.name.suffix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX] zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:NameInformation.Titles
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.name.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. 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"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
telecom	I	0..*	HdBe-ContactInformation	Element Id Patient.contact.telecom Short description ContactInformation Alternate names Contactpunten, 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 Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps. Data Type HdBe-ContactInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:ContactInformation zib-contactperson-v3.4-2020EN:NL-CM:3.1.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1 HdBe-ContactPerson:ContactInformation
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.telecom.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
comment	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.telecom.extension:comment 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(string) Extension URL https://fhir.healthdata.be/StructureDefinition/ext-Comment 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.telecom.extension:comment.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-Comment Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Patient.contact.telecom.extension:comment.value[x] Short description Comment Alternate names Toelichting Definition Explanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionals) or that availability by phone is only possible during a specified part of the day. 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-contactinformation-v1.2-2020EN:NL-CM:20.6.9 HdBe-ContactInformation:ContactInformation.Comment
valueString			string	There are no (further) constraints on this element Data Type string
system	Σ I	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.telecom.system Short description Type Alternate names Type Definition The type of contact information. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.3 rim:./scheme servd:./ContactPointType zib-contactinformation-v1.2-2020EN:NL-CM:20.6.5 HdBe-ContactInformation:ContactInformation.Type
value	Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.contact.telecom.value Short description Value Alternate names Waarde Definition The actual contact information details. Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.1 (or XTN.12) rim:./url servd:./Value zib-contactinformation-v1.2-2020EN:NL-CM:20.6.4 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.7 HdBe-ContactInformation:ContactInformation.Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.telecom.use Short description Use Alternate names Gebruik Definition Purpose or use of the contact information. For example whether it is a private or business telephone number. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data Type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.2 - but often indicated by field rim:unique(./use) servd:./ContactPointPurpose zib-contactinformation-v1.2-2020EN:NL-CM:20.6.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.8 HdBe-ContactInformation:ContactInformation.Use
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element Id Patient.contact.telecom.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data Type positiveInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:n/a
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.telecom.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. 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"] v2:N/A rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
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:AddressInformation zib-contactperson-v3.4-2020EN:NL-CM:3.1.5 HdBe-ContactPerson:AddressInformation
extension	I	1..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.address.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
language	I	1..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.contact.address.extension:language Short description Human Language for the item Alternate names extensions, user content Definition The Human Language of the item. Comments This is used where an item may repeat to indicate the language of each repeat. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/language 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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.address.use Short description AddressType Alternate names AdresSoort Definition The type of address in question, such as a home address or mailing address. Requirements Allows an appropriate address to be chosen from a list of many. Comments Applications can assume that an address is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of an address. AddressUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General home Mappings rim:n/a v2:XAD.7 rim:unique(./use) servd:./AddressPurpose zib-addressinformation-v1.1-2020EN:NL-CM:20.5.8 HdBe-AddressInformation:AddressInformation.AddressUse
type	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.address.type Short description AddressType Alternate names AdresSoort Definition The type of address in question, such as a home address or mailing address. Comments The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). Data Type code Binding The type of an address (physical / postal). AddressType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General both Mappings rim:n/a v2:XAD.18 rim:unique(./use) vcard:address type parameter zib-addressinformation-v1.1-2020EN:NL-CM:20.5.8 HdBe-AddressInformation:AddressInformation.AddressType
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.text Short description Text representation of the address Definition Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street, Erewhon 9132 Mappings rim:n/a v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim:./formatted vcard:address label parameter
line	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.contact.address.line Short description Street name, number, direction & P.O. Box etc. Definition This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Comments The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the `Address.line` to which they are attached. The value of `Address.line` should be populated with a complete string representation of all the separate extension values, like: "[Street] [HouseNumberIndication] [HouseNumber] [HouseNumberLetter] [HouseNumberAddition]". Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street Mappings rim:n/a v2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim:AD.part[parttype = AL] vcard:street servd:./StreetAddress (newline delimitted)
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.address.line.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
streetName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:streetName Short description streetName Alternate names extensions, user content Definition streetName. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName 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 rim:ADXP[partType=STR]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:streetName.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/iso21090-ADXP-streetName Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:streetName.value[x] Short description Street Alternate names Straat Definition Street name of the address. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.2 HdBe-AddressInformation:AddressInformation.Street
valueString			string	There are no (further) constraints on this element Data Type string
houseNumber	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumber Short description houseNumber Alternate names extensions, user content Definition The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber 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 rim:ADXP[partType=BNR]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumber.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/iso21090-ADXP-houseNumber Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumber.value[x] Short description HouseNumber Alternate names Huisnummer Definition House number of the address. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.12 HdBe-AddressInformation:AddressInformation.HouseNumber
valueString			string	There are no (further) constraints on this element Data Type string
houseNumberLetter-houseNumberAddition	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberLetter-houseNumberAddition Short description buildingNumberSuffix Alternate names extensions, user content Definition Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix 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 rim:ADXP[partType=BNS]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberLetter-houseNumberAddition.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/iso21090-ADXP-buildingNumberSuffix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberLetter-houseNumberAddition.value[x] Short description HouseNumberLetter / HouseNumberAddition Alternate names Huisnummerletter, Huisnummertoevoeging Definition Export: If a HouseNumberLetter as well as a HouseNumberAddition is known: HouseNumberLetter first, followed by a space and finally the HouseNumberAddition. If only a HouseNumberLetter is known, send just that. No trailing space is required. If only a HouseNumberAddition is known, communicate that with a leading space. Import If the value of buildingNumberSuffix contains no space, then the whole value is considered to be the HouseNumberLetter. If the value of buildingNumberSuffix contains a space, then everything before the first space is considered to be the HouseNumberLetter, and the everything trailing the first space is considered to be the HouseNumberAddition. Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.11 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.10 HdBe-AddressInformation:AddressInformation.HouseNumberLetter HdBe-AddressInformation:AddressInformation.HouseNumberAddition
valueString			string	There are no (further) constraints on this element Data Type string
houseNumberIndication	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberIndication Short description additionalLocator Alternate names extensions, user content Definition This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator 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 rim:ADXP[partType=ADL]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberIndication.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/iso21090-ADXP-additionalLocator Mappings rim:N/A
value[x]	I	1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberIndication.value[x] Short description HouseNumberIndication Alternate names AanduidingBijNummer Definition The indication used for addresses which do not consist of the usual street name and house number. Comments The coded HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to'). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` houseNumberIndication:Must have value 'by' or 'to' `value in ('by' \| 'to')` Mappings rim:n/a rim:N/A zib-addressinformation-v1.1-2020EN:NL-CM:20.5.9 HdBe-AddressInformation:AddressInformation.HouseNumberIndication
valueString			string	There are no (further) constraints on this element Data Type string
additionalInformation	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:additionalInformation Short description unitID Alternate names extensions, user content Definition The number or name of a specific unit contained within a building or complex, as assigned by that building or complex. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID 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 rim:ADXP[partType=UNID]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:additionalInformation.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/iso21090-ADXP-unitID Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:additionalInformation.value[x] Short description AdditionalInformation Alternate names AdditioneleInformatie 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 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.7 HdBe-AddressInformation:AddressInformation.AdditionalInformation
valueString			string	There are no (further) constraints on this element Data Type string
city	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.city Short description PlaceOfResidence Alternate names Municpality, Woonplaats Definition A geographically determined area which forms part of the municipal area. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Erewhon Mappings rim:n/a v2:XAD.3 rim:AD.part[parttype = CTY] vcard:locality servd:./Jurisdiction zib-addressinformation-v1.1-2020EN:NL-CM:20.5.3 HdBe-AddressInformation:AddressInformation.PlaceOfResidence
district	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.district Short description Municipality Alternate names County, Gemeente Definition Municipality of residence. Comments District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Madison Mappings rim:n/a v2:XAD.9 rim:AD.part[parttype = CNT \| CPA] zib-addressinformation-v1.1-2020EN:NL-CM:20.5.4 HdBe-AddressInformation:AddressInformation.Municipality
state	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.state Short description Sub-unit of country (abbreviations ok) Alternate names Province, Territory Definition Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.4 rim:AD.part[parttype = STA] vcard:region servd:./Region
postalCode	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.postalCode Short description Postcode Alternate names Zip, Postcode Definition Postcode of the address. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 9132 Mappings rim:n/a v2:XAD.5 rim:AD.part[parttype = ZIP] vcard:code servd:./PostalIdentificationCode zib-addressinformation-v1.1-2020EN:NL-CM:20.5.6 HdBe-AddressInformation:AddressInformation.Postcode
country	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.country Short description Country (e.g. can be ISO 3166 2 or 3 letter code) Definition Country - a nation as commonly understood or generally accepted. Comments The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the CodeSpecification extension under `Address.country.extension:countryCode`. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.6 rim:AD.part[parttype = CNT] vcard:country servd:./Country
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.address.country.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
countryCode	I	0..1	Extension(CodeableConcept)	There are no (further) constraints on this element Element Id Patient.contact.address.country.extension:countryCode 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.contact.address.country.extension:countryCode.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	There are no (further) constraints on this element Element Id Patient.contact.address.country.extension:countryCode.value[x] Short description Country Alternate names Land Definition Country in which the address is located. Binding Iso 3166 Part 1: 2 Letter Codes CountryISO (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 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.5 HdBe-AddressInformation:AddressInformation.Country
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.address.period Short description Time period when address was/is in use Definition Time period when address was/is in use. Requirements Allows addresses to be placed in historical context. 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)` Examples General { "start": "2010-03-23", "end": "2010-07-01" } Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XAD.12 / XAD.13 + XAD.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
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	There are no (further) constraints on this element 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	There are no (further) constraints on this element 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 CountryISO (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:NationalityRC.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.PatientIdentificationNumber zib-patient-v3.2-2020EN:NL-CM:0.1.7
SSIN	Σ	0..*	IdentifierPattern	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/core/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. Meaning When Missing This resource is generally assumed to be active if no value is provided for the active element Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:statusCode cda:n/a
name	Σ	0..*	HumanName	Element Id Patient.name Short description NameInformation Alternate names Naamgegevens Definition Patient's full name. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Data Type HumanName Sliced: Unordered, Open, by use(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name zib-patient-v3.2-2020EN:NL-CM:0.1.6 HdBe-Patient:Patient.NameInformation
nameInformation	Σ I	0..2	HdBe-NameInformation	Element Id Patient.name:nameInformation Short description NameInformation Alternate names Naamgegevens Definition This slice represents the person's official name information, including given names, last name and possibly the partner's last name. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments This `.name` element represents a Belgian name according to the CBB NameInformation (except for the GivenName concept). A Belgian name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Belgian rules. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Belgian context SHOULD support these extensions as specified here. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Belgian contexts. It is encouraged to provide a representation of the full name in the `.text` element. Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept. Note 2: This element should only contain a person's official names. The GivenName concept is represented in another `.name` element with `.name.use` = usual. Note 3: The examples illustrate how the CBB is mapped to FHIR. Data Type HdBe-NameInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a 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()` 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:NameInformation
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.name:nameInformation.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
nameUsage	I	0..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.extension:nameUsage Short description Preferred display order of name parts Alternate names extensions, user content Definition A code that represents the preferred display order of the components of this human name. 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(code) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-assembly-order 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.name:nameInformation.extension:nameUsage.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/humanname-assembly-order Mappings rim:N/A
value[x]		1..1	Binding	There are no (further) constraints on this element Element Id Patient.name:nameInformation.extension:nameUsage.value[x] Short description NameUsage Alternate names Naamgebruik Definition This concept indicates the last name or order of last names with which the person is to be addressed. Binding Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder HumanNameAssemblyOrder (required) Permitted Values NameUsage_to_HumanNameAssemblyOrder 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-nameinformation-v1.1-2020EN:NL-CM:20.4.7 HdBe-NameInformation:NameInformation.NameUsage
valueCode			code	There are no (further) constraints on this element Data Type code
use	Σ ?!	1..1	codeBindingFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value official Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.text Short description Text representation of the full name Definition Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family Short description Family name (often called 'Surname') Alternate names surname Definition The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.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
prefix	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:prefix Short description Voorvoegsel derived from person's own surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-prefix 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 v2:FN.2 rim:ENXP where Qualifiers = (VV, R)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:prefix.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/humanname-own-prefix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:prefix.value[x] Short description Prefix Alternate names Voorvoegsels Definition Prefix to the person’s own last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.11 HdBe-NameInformation:NameInformation.LastName.Prefix
valueString			string	There are no (further) constraints on this element Data Type string
lastName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:lastName Short description Portion derived from person's own surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-name 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 v2:FN.3 rim:ENXP where Qualifiers = (BR)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:lastName.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/humanname-own-name Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:lastName.value[x] Short description LastName Alternate names Achternaam Definition The person’s official last name 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-nameinformation-v1.1-2020EN:NL-CM:20.4.10 HdBe-NameInformation:NameInformation.LastName.LastName
valueString			string	There are no (further) constraints on this element Data Type string
partnerPrefix	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerPrefix Short description Voorvoegsel derived from person's partner's surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix 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 v2:FN.4 rim:ENXP where Qualifiers = (VV, SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerPrefix.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/humanname-partner-prefix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerPrefix.value[x] Short description PartnerPrefix Alternate names VoorvoegselsPartner Definition Prefix to the partner’s last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.9 HdBe-NameInformation:NameInformation.LastNamePartner.PartnerPrefix
valueString			string	There are no (further) constraints on this element Data Type string
partnerLastName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerLastName Short description Portion derived from person's partner's surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-name 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 v2:FN.5 rim:ENXP where Qualifiers = (SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerLastName.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/humanname-partner-name Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerLastName.value[x] Short description PartnerLastName Alternate names AchternaamPartner Definition Partner’s official last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.8 HdBe-NameInformation:NameInformation.LastNamePartner.PartnerLastName
valueString			string	There are no (further) constraints on this element Data Type string
given	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.given Short description FirstName / Initial Alternate names first name, middle name, Voornaam, Initiaal Definition One of a person’s official first names or the initial if the full name is not known. Comments This element represents the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately. Therefore, the zib concepts are implemented here in the following way: Systems SHOULD use a `.given` element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR). Each of these elements: SHOULD be populated with the complete name if it is known, or with the initial if no more information is available. SHALL be augmented with `extension:givenOrInitial` with code BR when it represents a full name or code IN when it represents an initial. Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed. If a system does however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional `.name` instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance. Note 1: The GivenName concept should not be included here but in a separate `.name` instance where `.use` = usual. Note 2: As specified by FHIR, multiple official first names MAY be combined in a single `.given` element (separated by spaces), as long as the `.given` elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.4 HdBe-NameInformation:NameInformation.FirstNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.5 HdBe-NameInformation:NameInformation.Initials
extension	I	1..*	Extension	There are no (further) constraints on this element Element Id Patient.name:nameInformation.given.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
givenOrInitial	I	1..*	Extension(code)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.given.extension:givenOrInitial Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier 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 rim:ENXP.qualifier
prefix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.prefix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:NameInformation.Titles
suffix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.suffix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX] zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:NameInformation.Titles
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.name:nameInformation.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. 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"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
nameInformation-GivenName	Σ	0..*	HdBe-NameInformation.GivenName	Element Id Patient.name:nameInformation-GivenName Short description Name of a human - parts and usage Definition This slice represents the name information normally used to address the person. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments This `.name` element represents the Belgian given name ("roepnaam") according to the CBB NameInformation. Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other `.name` elements with `.name.use` = official. Note 2: The examples illustrate how the CBB is mapped to FHIR. Data Type HdBe-NameInformation.GivenName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name
telecom	Σ I	0..*	HdBe-ContactInformation	Element Id Patient.telecom Short description ContactInformation Alternate names Contactpunten, 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 Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps. Data Type HdBe-ContactInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:ContactInformation HdBe-Patient:Patient.ContactInformation zib-patient-v3.2-2020EN:NL-CM:0.1.5 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.telecom.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
comment	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.telecom.extension:comment 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(string) Extension URL https://fhir.healthdata.be/StructureDefinition/ext-Comment 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.telecom.extension:comment.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-Comment Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Patient.telecom.extension:comment.value[x] Short description Comment Alternate names Toelichting Definition Explanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionals) or that availability by phone is only possible during a specified part of the day. 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-contactinformation-v1.2-2020EN:NL-CM:20.6.9 HdBe-ContactInformation:ContactInformation.Comment
valueString			string	There are no (further) constraints on this element Data Type string
system	Σ I	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.telecom.system Short description Type Alternate names Type Definition The type of contact information. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.3 rim:./scheme servd:./ContactPointType zib-contactinformation-v1.2-2020EN:NL-CM:20.6.5 HdBe-ContactInformation:ContactInformation.Type
value	Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.telecom.value Short description Value Alternate names Waarde Definition The actual contact information details. Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.1 (or XTN.12) rim:./url servd:./Value zib-contactinformation-v1.2-2020EN:NL-CM:20.6.4 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.7 HdBe-ContactInformation:ContactInformation.Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.telecom.use Short description Use Alternate names Gebruik Definition Purpose or use of the contact information. For example whether it is a private or business telephone number. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data Type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.2 - but often indicated by field rim:unique(./use) servd:./ContactPointPurpose zib-contactinformation-v1.2-2020EN:NL-CM:20.6.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.8 HdBe-ContactInformation:ContactInformation.Use
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element Id Patient.telecom.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data Type positiveInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:n/a
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.telecom.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. 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"] v2:N/A rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
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:Patient.Gender zib-patient-v3.2-2020EN:NL-CM:0.1.9
extension	I	0..*	Extension	There are no (further) constraints on this element 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: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:Patient.DateOfBirth 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:Patient.DeathIndicator 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:Patient.DateOfDeath HdBe-Patient:Patient.DeathIndicator 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:AddressInformation HdBe-Patient:Patient.AddressInformation zib-patient-v3.2-2020EN:NL-CM:0.1.4
extension	I	1..*	Extension	There are no (further) constraints on this element Element Id Patient.address.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
language	I	1..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.address.extension:language Short description Human Language for the item Alternate names extensions, user content Definition The Human Language of the item. Comments This is used where an item may repeat to indicate the language of each repeat. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/language 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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.address.use Short description AddressType Alternate names AdresSoort Definition The type of address in question, such as a home address or mailing address. Requirements Allows an appropriate address to be chosen from a list of many. Comments Applications can assume that an address is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of an address. AddressUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General home Mappings rim:n/a v2:XAD.7 rim:unique(./use) servd:./AddressPurpose zib-addressinformation-v1.1-2020EN:NL-CM:20.5.8 HdBe-AddressInformation:AddressInformation.AddressUse
type	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.address.type Short description AddressType Alternate names AdresSoort Definition The type of address in question, such as a home address or mailing address. Comments The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). Data Type code Binding The type of an address (physical / postal). AddressType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General both Mappings rim:n/a v2:XAD.18 rim:unique(./use) vcard:address type parameter zib-addressinformation-v1.1-2020EN:NL-CM:20.5.8 HdBe-AddressInformation:AddressInformation.AddressType
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.text Short description Text representation of the address Definition Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street, Erewhon 9132 Mappings rim:n/a v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim:./formatted vcard:address label parameter
line	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.address.line Short description Street name, number, direction & P.O. Box etc. Definition This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Comments The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the `Address.line` to which they are attached. The value of `Address.line` should be populated with a complete string representation of all the separate extension values, like: "[Street] [HouseNumberIndication] [HouseNumber] [HouseNumberLetter] [HouseNumberAddition]". Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street Mappings rim:n/a v2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim:AD.part[parttype = AL] vcard:street servd:./StreetAddress (newline delimitted)
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.address.line.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
streetName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:streetName Short description streetName Alternate names extensions, user content Definition streetName. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName 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 rim:ADXP[partType=STR]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:streetName.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/iso21090-ADXP-streetName Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:streetName.value[x] Short description Street Alternate names Straat Definition Street name of the address. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.2 HdBe-AddressInformation:AddressInformation.Street
valueString			string	There are no (further) constraints on this element Data Type string
houseNumber	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumber Short description houseNumber Alternate names extensions, user content Definition The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber 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 rim:ADXP[partType=BNR]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumber.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/iso21090-ADXP-houseNumber Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumber.value[x] Short description HouseNumber Alternate names Huisnummer Definition House number of the address. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.12 HdBe-AddressInformation:AddressInformation.HouseNumber
valueString			string	There are no (further) constraints on this element Data Type string
houseNumberLetter-houseNumberAddition	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberLetter-houseNumberAddition Short description buildingNumberSuffix Alternate names extensions, user content Definition Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix 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 rim:ADXP[partType=BNS]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberLetter-houseNumberAddition.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/iso21090-ADXP-buildingNumberSuffix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberLetter-houseNumberAddition.value[x] Short description HouseNumberLetter / HouseNumberAddition Alternate names Huisnummerletter, Huisnummertoevoeging Definition Export: If a HouseNumberLetter as well as a HouseNumberAddition is known: HouseNumberLetter first, followed by a space and finally the HouseNumberAddition. If only a HouseNumberLetter is known, send just that. No trailing space is required. If only a HouseNumberAddition is known, communicate that with a leading space. Import If the value of buildingNumberSuffix contains no space, then the whole value is considered to be the HouseNumberLetter. If the value of buildingNumberSuffix contains a space, then everything before the first space is considered to be the HouseNumberLetter, and the everything trailing the first space is considered to be the HouseNumberAddition. Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.11 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.10 HdBe-AddressInformation:AddressInformation.HouseNumberLetter HdBe-AddressInformation:AddressInformation.HouseNumberAddition
valueString			string	There are no (further) constraints on this element Data Type string
houseNumberIndication	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberIndication Short description additionalLocator Alternate names extensions, user content Definition This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator 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 rim:ADXP[partType=ADL]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberIndication.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/iso21090-ADXP-additionalLocator Mappings rim:N/A
value[x]	I	1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberIndication.value[x] Short description HouseNumberIndication Alternate names AanduidingBijNummer Definition The indication used for addresses which do not consist of the usual street name and house number. Comments The coded HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to'). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` houseNumberIndication:Must have value 'by' or 'to' `value in ('by' \| 'to')` Mappings rim:n/a rim:N/A zib-addressinformation-v1.1-2020EN:NL-CM:20.5.9 HdBe-AddressInformation:AddressInformation.HouseNumberIndication
valueString			string	There are no (further) constraints on this element Data Type string
additionalInformation	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:additionalInformation Short description unitID Alternate names extensions, user content Definition The number or name of a specific unit contained within a building or complex, as assigned by that building or complex. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID 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 rim:ADXP[partType=UNID]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:additionalInformation.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/iso21090-ADXP-unitID Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:additionalInformation.value[x] Short description AdditionalInformation Alternate names AdditioneleInformatie 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 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.7 HdBe-AddressInformation:AddressInformation.AdditionalInformation
valueString			string	There are no (further) constraints on this element Data Type string
city	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.city Short description PlaceOfResidence Alternate names Municpality, Woonplaats Definition A geographically determined area which forms part of the municipal area. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Erewhon Mappings rim:n/a v2:XAD.3 rim:AD.part[parttype = CTY] vcard:locality servd:./Jurisdiction zib-addressinformation-v1.1-2020EN:NL-CM:20.5.3 HdBe-AddressInformation:AddressInformation.PlaceOfResidence
district	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.district Short description Municipality Alternate names County, Gemeente Definition Municipality of residence. Comments District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Madison Mappings rim:n/a v2:XAD.9 rim:AD.part[parttype = CNT \| CPA] zib-addressinformation-v1.1-2020EN:NL-CM:20.5.4 HdBe-AddressInformation:AddressInformation.Municipality
state	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.state Short description Sub-unit of country (abbreviations ok) Alternate names Province, Territory Definition Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.4 rim:AD.part[parttype = STA] vcard:region servd:./Region
postalCode	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.postalCode Short description Postcode Alternate names Zip, Postcode Definition Postcode of the address. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 9132 Mappings rim:n/a v2:XAD.5 rim:AD.part[parttype = ZIP] vcard:code servd:./PostalIdentificationCode zib-addressinformation-v1.1-2020EN:NL-CM:20.5.6 HdBe-AddressInformation:AddressInformation.Postcode
country	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.country Short description Country (e.g. can be ISO 3166 2 or 3 letter code) Definition Country - a nation as commonly understood or generally accepted. Comments The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the CodeSpecification extension under `Address.country.extension:countryCode`. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.6 rim:AD.part[parttype = CNT] vcard:country servd:./Country
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.address.country.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
countryCode	I	0..1	Extension(CodeableConcept)	There are no (further) constraints on this element Element Id Patient.address.country.extension:countryCode 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.address.country.extension:countryCode.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	There are no (further) constraints on this element Element Id Patient.address.country.extension:countryCode.value[x] Short description Country Alternate names Land Definition Country in which the address is located. Binding Iso 3166 Part 1: 2 Letter Codes CountryISO (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 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.5 HdBe-AddressInformation:AddressInformation.Country
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.address.period Short description Time period when address was/is in use Definition Time period when address was/is in use. Requirements Allows addresses to be placed in historical context. 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)` Examples General { "start": "2010-03-23", "end": "2010-07-01" } Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XAD.12 / XAD.13 + XAD.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
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 'BeCivilstate-to-MaritalStatus' to translate CBB terminology to profile terminology in ValueSet 'MaritalStatus' BeCivilstate (required) Permitted Values BeCivilstate_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:MaritalStatusRC.MaritalStatus 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:Patient.MultipleBirthIndicator 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:Patient.MultipleBirthOrder HdBe-Patient:Patient.MultipleBirthIndicator
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	There are no (further) constraints on this element 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 This element can and should not completely capture the NameInformation concept from the 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 name 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-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()` 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:NameInformation zib-contactperson-v3.4-2020EN:NL-CM:3.1.4 HdBe-ContactPerson:NameInformation
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.name.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
nameUsage	I	0..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.contact.name.extension:nameUsage Short description Preferred display order of name parts Alternate names extensions, user content Definition A code that represents the preferred display order of the components of this human name. 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(code) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-assembly-order 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.name.extension:nameUsage.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/humanname-assembly-order Mappings rim:N/A
value[x]		1..1	Binding	There are no (further) constraints on this element Element Id Patient.contact.name.extension:nameUsage.value[x] Short description NameUsage Alternate names Naamgebruik Definition This concept indicates the last name or order of last names with which the person is to be addressed. Binding Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder HumanNameAssemblyOrder (required) Permitted Values NameUsage_to_HumanNameAssemblyOrder 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-nameinformation-v1.1-2020EN:NL-CM:20.4.7 HdBe-NameInformation:NameInformation.NameUsage
valueCode			code	There are no (further) constraints on this element Data Type code
use	Σ ?!	1..1	codeBindingFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value official Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.name.text Short description Text representation of the full name Definition Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.name.family Short description Family name (often called 'Surname') Alternate names surname Definition The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.name.family.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
prefix	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:prefix Short description Voorvoegsel derived from person's own surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-prefix 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 v2:FN.2 rim:ENXP where Qualifiers = (VV, R)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:prefix.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/humanname-own-prefix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:prefix.value[x] Short description Prefix Alternate names Voorvoegsels Definition Prefix to the person’s own last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.11 HdBe-NameInformation:NameInformation.LastName.Prefix
valueString			string	There are no (further) constraints on this element Data Type string
lastName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:lastName Short description Portion derived from person's own surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-name 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 v2:FN.3 rim:ENXP where Qualifiers = (BR)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:lastName.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/humanname-own-name Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:lastName.value[x] Short description LastName Alternate names Achternaam Definition The person’s official last name 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-nameinformation-v1.1-2020EN:NL-CM:20.4.10 HdBe-NameInformation:NameInformation.LastName.LastName
valueString			string	There are no (further) constraints on this element Data Type string
partnerPrefix	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerPrefix Short description Voorvoegsel derived from person's partner's surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix 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 v2:FN.4 rim:ENXP where Qualifiers = (VV, SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerPrefix.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/humanname-partner-prefix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerPrefix.value[x] Short description PartnerPrefix Alternate names VoorvoegselsPartner Definition Prefix to the partner’s last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.9 HdBe-NameInformation:NameInformation.LastNamePartner.PartnerPrefix
valueString			string	There are no (further) constraints on this element Data Type string
partnerLastName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerLastName Short description Portion derived from person's partner's surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-name 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 v2:FN.5 rim:ENXP where Qualifiers = (SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerLastName.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/humanname-partner-name Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerLastName.value[x] Short description PartnerLastName Alternate names AchternaamPartner Definition Partner’s official last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.8 HdBe-NameInformation:NameInformation.LastNamePartner.PartnerLastName
valueString			string	There are no (further) constraints on this element Data Type string
given	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.contact.name.given Short description FirstName / Initial Alternate names first name, middle name, Voornaam, Initiaal Definition One of a person’s official first names or the initial if the full name is not known. Comments This element represents the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately. Therefore, the zib concepts are implemented here in the following way: Systems SHOULD use a `.given` element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR). Each of these elements: SHOULD be populated with the complete name if it is known, or with the initial if no more information is available. SHALL be augmented with `extension:givenOrInitial` with code BR when it represents a full name or code IN when it represents an initial. Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed. If a system does however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional `.name` instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance. Note 1: The GivenName concept should not be included here but in a separate `.name` instance where `.use` = usual. Note 2: As specified by FHIR, multiple official first names MAY be combined in a single `.given` element (separated by spaces), as long as the `.given` elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.4 HdBe-NameInformation:NameInformation.FirstNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.5 HdBe-NameInformation:NameInformation.Initials
extension	I	1..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.name.given.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
givenOrInitial	I	1..*	Extension(code)	There are no (further) constraints on this element Element Id Patient.contact.name.given.extension:givenOrInitial Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier 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 rim:ENXP.qualifier
prefix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.contact.name.prefix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:NameInformation.Titles
suffix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.contact.name.suffix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX] zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:NameInformation.Titles
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.name.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. 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"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
telecom	I	0..*	HdBe-ContactInformation	Element Id Patient.contact.telecom Short description ContactInformation Alternate names Contactpunten, 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 Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps. Data Type HdBe-ContactInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:ContactInformation zib-contactperson-v3.4-2020EN:NL-CM:3.1.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1 HdBe-ContactPerson:ContactInformation
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.telecom.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
comment	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.telecom.extension:comment 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(string) Extension URL https://fhir.healthdata.be/StructureDefinition/ext-Comment 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.telecom.extension:comment.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-Comment Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Patient.contact.telecom.extension:comment.value[x] Short description Comment Alternate names Toelichting Definition Explanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionals) or that availability by phone is only possible during a specified part of the day. 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-contactinformation-v1.2-2020EN:NL-CM:20.6.9 HdBe-ContactInformation:ContactInformation.Comment
valueString			string	There are no (further) constraints on this element Data Type string
system	Σ I	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.telecom.system Short description Type Alternate names Type Definition The type of contact information. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.3 rim:./scheme servd:./ContactPointType zib-contactinformation-v1.2-2020EN:NL-CM:20.6.5 HdBe-ContactInformation:ContactInformation.Type
value	Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.contact.telecom.value Short description Value Alternate names Waarde Definition The actual contact information details. Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.1 (or XTN.12) rim:./url servd:./Value zib-contactinformation-v1.2-2020EN:NL-CM:20.6.4 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.7 HdBe-ContactInformation:ContactInformation.Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.telecom.use Short description Use Alternate names Gebruik Definition Purpose or use of the contact information. For example whether it is a private or business telephone number. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data Type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.2 - but often indicated by field rim:unique(./use) servd:./ContactPointPurpose zib-contactinformation-v1.2-2020EN:NL-CM:20.6.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.8 HdBe-ContactInformation:ContactInformation.Use
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element Id Patient.contact.telecom.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data Type positiveInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:n/a
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.telecom.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. 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"] v2:N/A rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
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:AddressInformation zib-contactperson-v3.4-2020EN:NL-CM:3.1.5 HdBe-ContactPerson:AddressInformation
extension	I	1..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.address.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
language	I	1..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.contact.address.extension:language Short description Human Language for the item Alternate names extensions, user content Definition The Human Language of the item. Comments This is used where an item may repeat to indicate the language of each repeat. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/language 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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.address.use Short description AddressType Alternate names AdresSoort Definition The type of address in question, such as a home address or mailing address. Requirements Allows an appropriate address to be chosen from a list of many. Comments Applications can assume that an address is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of an address. AddressUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General home Mappings rim:n/a v2:XAD.7 rim:unique(./use) servd:./AddressPurpose zib-addressinformation-v1.1-2020EN:NL-CM:20.5.8 HdBe-AddressInformation:AddressInformation.AddressUse
type	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.address.type Short description AddressType Alternate names AdresSoort Definition The type of address in question, such as a home address or mailing address. Comments The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). Data Type code Binding The type of an address (physical / postal). AddressType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General both Mappings rim:n/a v2:XAD.18 rim:unique(./use) vcard:address type parameter zib-addressinformation-v1.1-2020EN:NL-CM:20.5.8 HdBe-AddressInformation:AddressInformation.AddressType
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.text Short description Text representation of the address Definition Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street, Erewhon 9132 Mappings rim:n/a v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim:./formatted vcard:address label parameter
line	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.contact.address.line Short description Street name, number, direction & P.O. Box etc. Definition This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Comments The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the `Address.line` to which they are attached. The value of `Address.line` should be populated with a complete string representation of all the separate extension values, like: "[Street] [HouseNumberIndication] [HouseNumber] [HouseNumberLetter] [HouseNumberAddition]". Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street Mappings rim:n/a v2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim:AD.part[parttype = AL] vcard:street servd:./StreetAddress (newline delimitted)
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.address.line.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
streetName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:streetName Short description streetName Alternate names extensions, user content Definition streetName. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName 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 rim:ADXP[partType=STR]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:streetName.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/iso21090-ADXP-streetName Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:streetName.value[x] Short description Street Alternate names Straat Definition Street name of the address. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.2 HdBe-AddressInformation:AddressInformation.Street
valueString			string	There are no (further) constraints on this element Data Type string
houseNumber	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumber Short description houseNumber Alternate names extensions, user content Definition The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber 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 rim:ADXP[partType=BNR]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumber.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/iso21090-ADXP-houseNumber Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumber.value[x] Short description HouseNumber Alternate names Huisnummer Definition House number of the address. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.12 HdBe-AddressInformation:AddressInformation.HouseNumber
valueString			string	There are no (further) constraints on this element Data Type string
houseNumberLetter-houseNumberAddition	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberLetter-houseNumberAddition Short description buildingNumberSuffix Alternate names extensions, user content Definition Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix 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 rim:ADXP[partType=BNS]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberLetter-houseNumberAddition.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/iso21090-ADXP-buildingNumberSuffix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberLetter-houseNumberAddition.value[x] Short description HouseNumberLetter / HouseNumberAddition Alternate names Huisnummerletter, Huisnummertoevoeging Definition Export: If a HouseNumberLetter as well as a HouseNumberAddition is known: HouseNumberLetter first, followed by a space and finally the HouseNumberAddition. If only a HouseNumberLetter is known, send just that. No trailing space is required. If only a HouseNumberAddition is known, communicate that with a leading space. Import If the value of buildingNumberSuffix contains no space, then the whole value is considered to be the HouseNumberLetter. If the value of buildingNumberSuffix contains a space, then everything before the first space is considered to be the HouseNumberLetter, and the everything trailing the first space is considered to be the HouseNumberAddition. Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.11 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.10 HdBe-AddressInformation:AddressInformation.HouseNumberLetter HdBe-AddressInformation:AddressInformation.HouseNumberAddition
valueString			string	There are no (further) constraints on this element Data Type string
houseNumberIndication	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberIndication Short description additionalLocator Alternate names extensions, user content Definition This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator 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 rim:ADXP[partType=ADL]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberIndication.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/iso21090-ADXP-additionalLocator Mappings rim:N/A
value[x]	I	1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberIndication.value[x] Short description HouseNumberIndication Alternate names AanduidingBijNummer Definition The indication used for addresses which do not consist of the usual street name and house number. Comments The coded HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to'). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` houseNumberIndication:Must have value 'by' or 'to' `value in ('by' \| 'to')` Mappings rim:n/a rim:N/A zib-addressinformation-v1.1-2020EN:NL-CM:20.5.9 HdBe-AddressInformation:AddressInformation.HouseNumberIndication
valueString			string	There are no (further) constraints on this element Data Type string
additionalInformation	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:additionalInformation Short description unitID Alternate names extensions, user content Definition The number or name of a specific unit contained within a building or complex, as assigned by that building or complex. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID 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 rim:ADXP[partType=UNID]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:additionalInformation.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/iso21090-ADXP-unitID Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:additionalInformation.value[x] Short description AdditionalInformation Alternate names AdditioneleInformatie 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 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.7 HdBe-AddressInformation:AddressInformation.AdditionalInformation
valueString			string	There are no (further) constraints on this element Data Type string
city	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.city Short description PlaceOfResidence Alternate names Municpality, Woonplaats Definition A geographically determined area which forms part of the municipal area. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Erewhon Mappings rim:n/a v2:XAD.3 rim:AD.part[parttype = CTY] vcard:locality servd:./Jurisdiction zib-addressinformation-v1.1-2020EN:NL-CM:20.5.3 HdBe-AddressInformation:AddressInformation.PlaceOfResidence
district	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.district Short description Municipality Alternate names County, Gemeente Definition Municipality of residence. Comments District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Madison Mappings rim:n/a v2:XAD.9 rim:AD.part[parttype = CNT \| CPA] zib-addressinformation-v1.1-2020EN:NL-CM:20.5.4 HdBe-AddressInformation:AddressInformation.Municipality
state	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.state Short description Sub-unit of country (abbreviations ok) Alternate names Province, Territory Definition Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.4 rim:AD.part[parttype = STA] vcard:region servd:./Region
postalCode	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.postalCode Short description Postcode Alternate names Zip, Postcode Definition Postcode of the address. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 9132 Mappings rim:n/a v2:XAD.5 rim:AD.part[parttype = ZIP] vcard:code servd:./PostalIdentificationCode zib-addressinformation-v1.1-2020EN:NL-CM:20.5.6 HdBe-AddressInformation:AddressInformation.Postcode
country	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.country Short description Country (e.g. can be ISO 3166 2 or 3 letter code) Definition Country - a nation as commonly understood or generally accepted. Comments The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the CodeSpecification extension under `Address.country.extension:countryCode`. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.6 rim:AD.part[parttype = CNT] vcard:country servd:./Country
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.address.country.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
countryCode	I	0..1	Extension(CodeableConcept)	There are no (further) constraints on this element Element Id Patient.contact.address.country.extension:countryCode 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.contact.address.country.extension:countryCode.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	There are no (further) constraints on this element Element Id Patient.contact.address.country.extension:countryCode.value[x] Short description Country Alternate names Land Definition Country in which the address is located. Binding Iso 3166 Part 1: 2 Letter Codes CountryISO (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 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.5 HdBe-AddressInformation:AddressInformation.Country
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.address.period Short description Time period when address was/is in use Definition Time period when address was/is in use. Requirements Allows addresses to be placed in historical context. 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)` Examples General { "start": "2010-03-23", "end": "2010-07-01" } Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XAD.12 / XAD.13 + XAD.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
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	There are no (further) constraints on this element 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	There are no (further) constraints on this element 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 CountryISO (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:NationalityRC.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.PatientIdentificationNumber zib-patient-v3.2-2020EN:NL-CM:0.1.7
SSIN	Σ	0..*	IdentifierPattern	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/core/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. Meaning When Missing This resource is generally assumed to be active if no value is provided for the active element Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:statusCode cda:n/a
name	Σ	0..*	HumanName	Element Id Patient.name Short description NameInformation Alternate names Naamgegevens Definition Patient's full name. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Data Type HumanName Sliced: Unordered, Open, by use(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name zib-patient-v3.2-2020EN:NL-CM:0.1.6 HdBe-Patient:Patient.NameInformation
nameInformation	Σ I	0..2	HdBe-NameInformation	Element Id Patient.name:nameInformation Short description NameInformation Alternate names Naamgegevens Definition This slice represents the person's official name information, including given names, last name and possibly the partner's last name. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments This `.name` element represents a Belgian name according to the CBB NameInformation (except for the GivenName concept). A Belgian name is represented in FHIR as an ordinary international name, but is augmented using extensions to specify how the last name is built up according to the Belgian rules. See the guidance on `.family` and on `.extension:nameUsage` for more information. Systems that need to work in a Belgian context SHOULD support these extensions as specified here. In addition, systems SHOULD use the core elements according to the FHIR specifications to provide compatibility outside Belgian contexts. It is encouraged to provide a representation of the full name in the `.text` element. Note 1: The CBB cannot be represented straightforward in FHIR. Especially note the guidance on `.given` on how to map the FirstNames and Initials concepts, and on `.prefix`/`.suffix` on how to map the Titles concept. Note 2: This element should only contain a person's official names. The GivenName concept is represented in another `.name` element with `.name.use` = usual. Note 3: The examples illustrate how the CBB is mapped to FHIR. Data Type HdBe-NameInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` zib-NameInformation-1:If a prefix for a 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()` 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:NameInformation
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.name:nameInformation.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
nameUsage	I	0..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.extension:nameUsage Short description Preferred display order of name parts Alternate names extensions, user content Definition A code that represents the preferred display order of the components of this human name. 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(code) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-assembly-order 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.name:nameInformation.extension:nameUsage.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/humanname-assembly-order Mappings rim:N/A
value[x]		1..1	Binding	There are no (further) constraints on this element Element Id Patient.name:nameInformation.extension:nameUsage.value[x] Short description NameUsage Alternate names Naamgebruik Definition This concept indicates the last name or order of last names with which the person is to be addressed. Binding Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder HumanNameAssemblyOrder (required) Permitted Values NameUsage_to_HumanNameAssemblyOrder 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-nameinformation-v1.1-2020EN:NL-CM:20.4.7 HdBe-NameInformation:NameInformation.NameUsage
valueCode			code	There are no (further) constraints on this element Data Type code
use	Σ ?!	1..1	codeBindingFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value official Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.text Short description Text representation of the full name Definition Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family Short description Family name (often called 'Surname') Alternate names surname Definition The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.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
prefix	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:prefix Short description Voorvoegsel derived from person's own surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-prefix 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 v2:FN.2 rim:ENXP where Qualifiers = (VV, R)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:prefix.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/humanname-own-prefix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:prefix.value[x] Short description Prefix Alternate names Voorvoegsels Definition Prefix to the person’s own last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.11 HdBe-NameInformation:NameInformation.LastName.Prefix
valueString			string	There are no (further) constraints on this element Data Type string
lastName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:lastName Short description Portion derived from person's own surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-name 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 v2:FN.3 rim:ENXP where Qualifiers = (BR)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:lastName.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/humanname-own-name Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:lastName.value[x] Short description LastName Alternate names Achternaam Definition The person’s official last name 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-nameinformation-v1.1-2020EN:NL-CM:20.4.10 HdBe-NameInformation:NameInformation.LastName.LastName
valueString			string	There are no (further) constraints on this element Data Type string
partnerPrefix	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerPrefix Short description Voorvoegsel derived from person's partner's surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix 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 v2:FN.4 rim:ENXP where Qualifiers = (VV, SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerPrefix.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/humanname-partner-prefix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerPrefix.value[x] Short description PartnerPrefix Alternate names VoorvoegselsPartner Definition Prefix to the partner’s last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.9 HdBe-NameInformation:NameInformation.LastNamePartner.PartnerPrefix
valueString			string	There are no (further) constraints on this element Data Type string
partnerLastName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerLastName Short description Portion derived from person's partner's surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-name 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 v2:FN.5 rim:ENXP where Qualifiers = (SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerLastName.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/humanname-partner-name Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.name:nameInformation.family.extension:partnerLastName.value[x] Short description PartnerLastName Alternate names AchternaamPartner Definition Partner’s official last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.8 HdBe-NameInformation:NameInformation.LastNamePartner.PartnerLastName
valueString			string	There are no (further) constraints on this element Data Type string
given	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.given Short description FirstName / Initial Alternate names first name, middle name, Voornaam, Initiaal Definition One of a person’s official first names or the initial if the full name is not known. Comments This element represents the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately. Therefore, the zib concepts are implemented here in the following way: Systems SHOULD use a `.given` element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR). Each of these elements: SHOULD be populated with the complete name if it is known, or with the initial if no more information is available. SHALL be augmented with `extension:givenOrInitial` with code BR when it represents a full name or code IN when it represents an initial. Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed. If a system does however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional `.name` instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance. Note 1: The GivenName concept should not be included here but in a separate `.name` instance where `.use` = usual. Note 2: As specified by FHIR, multiple official first names MAY be combined in a single `.given` element (separated by spaces), as long as the `.given` elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.4 HdBe-NameInformation:NameInformation.FirstNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.5 HdBe-NameInformation:NameInformation.Initials
extension	I	1..*	Extension	There are no (further) constraints on this element Element Id Patient.name:nameInformation.given.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
givenOrInitial	I	1..*	Extension(code)	There are no (further) constraints on this element Element Id Patient.name:nameInformation.given.extension:givenOrInitial Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier 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 rim:ENXP.qualifier
prefix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.prefix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:NameInformation.Titles
suffix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name:nameInformation.suffix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX] zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:NameInformation.Titles
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.name:nameInformation.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. 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"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
nameInformation-GivenName	Σ	0..*	HdBe-NameInformation.GivenName	Element Id Patient.name:nameInformation-GivenName Short description Name of a human - parts and usage Definition This slice represents the name information normally used to address the person. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Comments This `.name` element represents the Belgian given name ("roepnaam") according to the CBB NameInformation. Note 1: This element should only contain a person's unofficial name. The official names are represented in one or more other `.name` elements with `.name.use` = official. Note 2: The examples illustrate how the CBB is mapped to FHIR. Data Type HdBe-NameInformation.GivenName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name
telecom	Σ I	0..*	HdBe-ContactInformation	Element Id Patient.telecom Short description ContactInformation Alternate names Contactpunten, 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 Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps. Data Type HdBe-ContactInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:ContactInformation HdBe-Patient:Patient.ContactInformation zib-patient-v3.2-2020EN:NL-CM:0.1.5 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.telecom.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
comment	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.telecom.extension:comment 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(string) Extension URL https://fhir.healthdata.be/StructureDefinition/ext-Comment 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.telecom.extension:comment.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-Comment Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Patient.telecom.extension:comment.value[x] Short description Comment Alternate names Toelichting Definition Explanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionals) or that availability by phone is only possible during a specified part of the day. 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-contactinformation-v1.2-2020EN:NL-CM:20.6.9 HdBe-ContactInformation:ContactInformation.Comment
valueString			string	There are no (further) constraints on this element Data Type string
system	Σ I	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.telecom.system Short description Type Alternate names Type Definition The type of contact information. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.3 rim:./scheme servd:./ContactPointType zib-contactinformation-v1.2-2020EN:NL-CM:20.6.5 HdBe-ContactInformation:ContactInformation.Type
value	Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.telecom.value Short description Value Alternate names Waarde Definition The actual contact information details. Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.1 (or XTN.12) rim:./url servd:./Value zib-contactinformation-v1.2-2020EN:NL-CM:20.6.4 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.7 HdBe-ContactInformation:ContactInformation.Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.telecom.use Short description Use Alternate names Gebruik Definition Purpose or use of the contact information. For example whether it is a private or business telephone number. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data Type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.2 - but often indicated by field rim:unique(./use) servd:./ContactPointPurpose zib-contactinformation-v1.2-2020EN:NL-CM:20.6.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.8 HdBe-ContactInformation:ContactInformation.Use
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element Id Patient.telecom.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data Type positiveInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:n/a
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.telecom.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. 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"] v2:N/A rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
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:Patient.Gender zib-patient-v3.2-2020EN:NL-CM:0.1.9
extension	I	0..*	Extension	There are no (further) constraints on this element 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: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:Patient.DateOfBirth 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:Patient.DeathIndicator 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:Patient.DateOfDeath HdBe-Patient:Patient.DeathIndicator 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:AddressInformation HdBe-Patient:Patient.AddressInformation zib-patient-v3.2-2020EN:NL-CM:0.1.4
extension	I	1..*	Extension	There are no (further) constraints on this element Element Id Patient.address.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
language	I	1..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.address.extension:language Short description Human Language for the item Alternate names extensions, user content Definition The Human Language of the item. Comments This is used where an item may repeat to indicate the language of each repeat. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/language 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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.address.use Short description AddressType Alternate names AdresSoort Definition The type of address in question, such as a home address or mailing address. Requirements Allows an appropriate address to be chosen from a list of many. Comments Applications can assume that an address is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of an address. AddressUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General home Mappings rim:n/a v2:XAD.7 rim:unique(./use) servd:./AddressPurpose zib-addressinformation-v1.1-2020EN:NL-CM:20.5.8 HdBe-AddressInformation:AddressInformation.AddressUse
type	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.address.type Short description AddressType Alternate names AdresSoort Definition The type of address in question, such as a home address or mailing address. Comments The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). Data Type code Binding The type of an address (physical / postal). AddressType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General both Mappings rim:n/a v2:XAD.18 rim:unique(./use) vcard:address type parameter zib-addressinformation-v1.1-2020EN:NL-CM:20.5.8 HdBe-AddressInformation:AddressInformation.AddressType
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.text Short description Text representation of the address Definition Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street, Erewhon 9132 Mappings rim:n/a v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim:./formatted vcard:address label parameter
line	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.address.line Short description Street name, number, direction & P.O. Box etc. Definition This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Comments The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the `Address.line` to which they are attached. The value of `Address.line` should be populated with a complete string representation of all the separate extension values, like: "[Street] [HouseNumberIndication] [HouseNumber] [HouseNumberLetter] [HouseNumberAddition]". Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street Mappings rim:n/a v2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim:AD.part[parttype = AL] vcard:street servd:./StreetAddress (newline delimitted)
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.address.line.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
streetName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:streetName Short description streetName Alternate names extensions, user content Definition streetName. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName 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 rim:ADXP[partType=STR]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:streetName.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/iso21090-ADXP-streetName Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:streetName.value[x] Short description Street Alternate names Straat Definition Street name of the address. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.2 HdBe-AddressInformation:AddressInformation.Street
valueString			string	There are no (further) constraints on this element Data Type string
houseNumber	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumber Short description houseNumber Alternate names extensions, user content Definition The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber 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 rim:ADXP[partType=BNR]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumber.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/iso21090-ADXP-houseNumber Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumber.value[x] Short description HouseNumber Alternate names Huisnummer Definition House number of the address. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.12 HdBe-AddressInformation:AddressInformation.HouseNumber
valueString			string	There are no (further) constraints on this element Data Type string
houseNumberLetter-houseNumberAddition	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberLetter-houseNumberAddition Short description buildingNumberSuffix Alternate names extensions, user content Definition Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix 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 rim:ADXP[partType=BNS]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberLetter-houseNumberAddition.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/iso21090-ADXP-buildingNumberSuffix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberLetter-houseNumberAddition.value[x] Short description HouseNumberLetter / HouseNumberAddition Alternate names Huisnummerletter, Huisnummertoevoeging Definition Export: If a HouseNumberLetter as well as a HouseNumberAddition is known: HouseNumberLetter first, followed by a space and finally the HouseNumberAddition. If only a HouseNumberLetter is known, send just that. No trailing space is required. If only a HouseNumberAddition is known, communicate that with a leading space. Import If the value of buildingNumberSuffix contains no space, then the whole value is considered to be the HouseNumberLetter. If the value of buildingNumberSuffix contains a space, then everything before the first space is considered to be the HouseNumberLetter, and the everything trailing the first space is considered to be the HouseNumberAddition. Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.11 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.10 HdBe-AddressInformation:AddressInformation.HouseNumberLetter HdBe-AddressInformation:AddressInformation.HouseNumberAddition
valueString			string	There are no (further) constraints on this element Data Type string
houseNumberIndication	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberIndication Short description additionalLocator Alternate names extensions, user content Definition This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator 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 rim:ADXP[partType=ADL]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberIndication.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/iso21090-ADXP-additionalLocator Mappings rim:N/A
value[x]	I	1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:houseNumberIndication.value[x] Short description HouseNumberIndication Alternate names AanduidingBijNummer Definition The indication used for addresses which do not consist of the usual street name and house number. Comments The coded HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to'). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` houseNumberIndication:Must have value 'by' or 'to' `value in ('by' \| 'to')` Mappings rim:n/a rim:N/A zib-addressinformation-v1.1-2020EN:NL-CM:20.5.9 HdBe-AddressInformation:AddressInformation.HouseNumberIndication
valueString			string	There are no (further) constraints on this element Data Type string
additionalInformation	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.address.line.extension:additionalInformation Short description unitID Alternate names extensions, user content Definition The number or name of a specific unit contained within a building or complex, as assigned by that building or complex. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID 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 rim:ADXP[partType=UNID]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.address.line.extension:additionalInformation.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/iso21090-ADXP-unitID Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.address.line.extension:additionalInformation.value[x] Short description AdditionalInformation Alternate names AdditioneleInformatie 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 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.7 HdBe-AddressInformation:AddressInformation.AdditionalInformation
valueString			string	There are no (further) constraints on this element Data Type string
city	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.city Short description PlaceOfResidence Alternate names Municpality, Woonplaats Definition A geographically determined area which forms part of the municipal area. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Erewhon Mappings rim:n/a v2:XAD.3 rim:AD.part[parttype = CTY] vcard:locality servd:./Jurisdiction zib-addressinformation-v1.1-2020EN:NL-CM:20.5.3 HdBe-AddressInformation:AddressInformation.PlaceOfResidence
district	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.district Short description Municipality Alternate names County, Gemeente Definition Municipality of residence. Comments District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Madison Mappings rim:n/a v2:XAD.9 rim:AD.part[parttype = CNT \| CPA] zib-addressinformation-v1.1-2020EN:NL-CM:20.5.4 HdBe-AddressInformation:AddressInformation.Municipality
state	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.state Short description Sub-unit of country (abbreviations ok) Alternate names Province, Territory Definition Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.4 rim:AD.part[parttype = STA] vcard:region servd:./Region
postalCode	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.postalCode Short description Postcode Alternate names Zip, Postcode Definition Postcode of the address. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 9132 Mappings rim:n/a v2:XAD.5 rim:AD.part[parttype = ZIP] vcard:code servd:./PostalIdentificationCode zib-addressinformation-v1.1-2020EN:NL-CM:20.5.6 HdBe-AddressInformation:AddressInformation.Postcode
country	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.address.country Short description Country (e.g. can be ISO 3166 2 or 3 letter code) Definition Country - a nation as commonly understood or generally accepted. Comments The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the CodeSpecification extension under `Address.country.extension:countryCode`. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.6 rim:AD.part[parttype = CNT] vcard:country servd:./Country
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.address.country.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
countryCode	I	0..1	Extension(CodeableConcept)	There are no (further) constraints on this element Element Id Patient.address.country.extension:countryCode 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.address.country.extension:countryCode.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	There are no (further) constraints on this element Element Id Patient.address.country.extension:countryCode.value[x] Short description Country Alternate names Land Definition Country in which the address is located. Binding Iso 3166 Part 1: 2 Letter Codes CountryISO (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 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.5 HdBe-AddressInformation:AddressInformation.Country
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.address.period Short description Time period when address was/is in use Definition Time period when address was/is in use. Requirements Allows addresses to be placed in historical context. 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)` Examples General { "start": "2010-03-23", "end": "2010-07-01" } Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XAD.12 / XAD.13 + XAD.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
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 'BeCivilstate-to-MaritalStatus' to translate CBB terminology to profile terminology in ValueSet 'MaritalStatus' BeCivilstate (required) Permitted Values BeCivilstate_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:MaritalStatusRC.MaritalStatus 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:Patient.MultipleBirthIndicator 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:Patient.MultipleBirthOrder HdBe-Patient:Patient.MultipleBirthIndicator
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	There are no (further) constraints on this element 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 This element can and should not completely capture the NameInformation concept from the 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 name 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-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()` 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:NameInformation zib-contactperson-v3.4-2020EN:NL-CM:3.1.4 HdBe-ContactPerson:NameInformation
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.name.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
nameUsage	I	0..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.contact.name.extension:nameUsage Short description Preferred display order of name parts Alternate names extensions, user content Definition A code that represents the preferred display order of the components of this human name. 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(code) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-assembly-order 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.name.extension:nameUsage.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/humanname-assembly-order Mappings rim:N/A
value[x]		1..1	Binding	There are no (further) constraints on this element Element Id Patient.contact.name.extension:nameUsage.value[x] Short description NameUsage Alternate names Naamgebruik Definition This concept indicates the last name or order of last names with which the person is to be addressed. Binding Use ConceptMap NameUsageCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder HumanNameAssemblyOrder (required) Permitted Values NameUsage_to_HumanNameAssemblyOrder 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-nameinformation-v1.1-2020EN:NL-CM:20.4.7 HdBe-NameInformation:NameInformation.NameUsage
valueCode			code	There are no (further) constraints on this element Data Type code
use	Σ ?!	1..1	codeBindingFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value official Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.name.text Short description Text representation of the full name Definition Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.name.family Short description Family name (often called 'Surname') Alternate names surname Definition The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.name.family.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
prefix	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:prefix Short description Voorvoegsel derived from person's own surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-prefix 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 v2:FN.2 rim:ENXP where Qualifiers = (VV, R)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:prefix.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/humanname-own-prefix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:prefix.value[x] Short description Prefix Alternate names Voorvoegsels Definition Prefix to the person’s own last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.11 HdBe-NameInformation:NameInformation.LastName.Prefix
valueString			string	There are no (further) constraints on this element Data Type string
lastName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:lastName Short description Portion derived from person's own surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-own-name 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 v2:FN.3 rim:ENXP where Qualifiers = (BR)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:lastName.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/humanname-own-name Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:lastName.value[x] Short description LastName Alternate names Achternaam Definition The person’s official last name 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-nameinformation-v1.1-2020EN:NL-CM:20.4.10 HdBe-NameInformation:NameInformation.LastName.LastName
valueString			string	There are no (further) constraints on this element Data Type string
partnerPrefix	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerPrefix Short description Voorvoegsel derived from person's partner's surname Alternate names extensions, user content Definition The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own. Comments An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to identify it as a separate sub-component. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix 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 v2:FN.4 rim:ENXP where Qualifiers = (VV, SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerPrefix.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/humanname-partner-prefix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerPrefix.value[x] Short description PartnerPrefix Alternate names VoorvoegselsPartner Definition Prefix to the partner’s last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.9 HdBe-NameInformation:NameInformation.LastNamePartner.PartnerPrefix
valueString			string	There are no (further) constraints on this element Data Type string
partnerLastName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerLastName Short description Portion derived from person's partner's surname Alternate names extensions, user content Definition The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Comments If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name". Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/humanname-partner-name 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 v2:FN.5 rim:ENXP where Qualifiers = (SP)
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerLastName.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/humanname-partner-name Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.name.family.extension:partnerLastName.value[x] Short description PartnerLastName Alternate names AchternaamPartner Definition Partner’s official last name. 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-nameinformation-v1.1-2020EN:NL-CM:20.4.8 HdBe-NameInformation:NameInformation.LastNamePartner.PartnerLastName
valueString			string	There are no (further) constraints on this element Data Type string
given	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.contact.name.given Short description FirstName / Initial Alternate names first name, middle name, Voornaam, Initiaal Definition One of a person’s official first names or the initial if the full name is not known. Comments This element represents the FirstNames and Initials concepts of zib NameInformation, but the FHIR implementation deviates from the zib model. The zib defines these concepts as a list of official first names (as a single string) and a list of initials (as a single string), both optional. They both represent the official name(s) of a person and thus represent the same concept. In FHIR however, each first name is either a complete name or an initial, but not both. In addition, each name may be defined separately. Therefore, the zib concepts are implemented here in the following way: Systems SHOULD use a `.given` element for each official first name that they know of (either as a full name or an initial), in order of appearance (as specified by FHIR). Each of these elements: SHOULD be populated with the complete name if it is known, or with the initial if no more information is available. SHALL be augmented with `extension:givenOrInitial` with code BR when it represents a full name or code IN when it represents an initial. Initials should thus not be communicated for each complete first name that is known, in contrast to what is specified by the zib. Receiving systems can recreate initials from the full names if needed. If a system does however only have a list of official first names and a separate list of official initials, without knowing the relationship between these two, only the full names SHOULD be communicated, while an additional `.name` instance MAY be used to communicate the initials. It is expected that the second instance just contains the initials and no other information from the zib. Receiving systems MAY ignore the second instance. Note 1: The GivenName concept should not be included here but in a separate `.name` instance where `.use` = usual. Note 2: As specified by FHIR, multiple official first names MAY be combined in a single `.given` element (separated by spaces), as long as the `.given` elements can be concatenated to form the full first name representation, and the 'extension:givenOrInitial` is used to mark the element as containing either full names or the initials. This pattern is strongly discouraged as it is hard to determine if the value pertains multiple names or a single combined name containing spaces. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.4 HdBe-NameInformation:NameInformation.FirstNames zib-nameinformation-v1.1-2020EN:NL-CM:20.4.5 HdBe-NameInformation:NameInformation.Initials
extension	I	1..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.name.given.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
givenOrInitial	I	1..*	Extension(code)	There are no (further) constraints on this element Element Id Patient.contact.name.given.extension:givenOrInitial Short description LS \| AC \| NB \| PR \| HON \| BR \| AD \| SP \| MID \| CL \| IN \| VV Alternate names extensions, user content Definition A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Comments Used to indicate additional information about the name part and how it should be used. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier 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 rim:ENXP.qualifier
prefix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.contact.name.prefix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:NameInformation.Titles
suffix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.contact.name.suffix Short description Titles Alternate names Titels Definition Noble and scientific titles. These can assist in formulating oral and formal addresing titles. Comments The CBB concept 'titles' is mapped to elements `HumanName.prefix` and `HumanName.suffix`. Semantically this mapping is not complete: the CBB uses a single concept that contains all the required information about noble and scientific titles, while FHIR captures the same information in a structured way. Export: Systems are expected to transform as much as possible to the FHIR datamodel and thereby to be as explicit as possible. Note that in order to mark the type of a prefix, you can use the FHIR standard extension for ISO 21090 EN Qualifiers. Examples include the use of the qualifier HON to indicate honorific prefixes and AC for academic prefixes. If it is not possible to breakup the CBB concept titles to positioned prefixes and suffixes, the prefix element is used to store all information. Import: Systems need to expect and be resilient for a broader range of information stored in the prefix element than stated by it's definition. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX] zib-nameinformation-v1.1-2020EN:NL-CM:20.4.12 HdBe-NameInformation:NameInformation.Titles
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.name.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. 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"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
telecom	I	0..*	HdBe-ContactInformation	Element Id Patient.contact.telecom Short description ContactInformation Alternate names Contactpunten, 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 Implementation of the CBB ContactInformation. Please note that this profile differs significantly from the zib ContactInformation because the zib model is deemed overly complex, too Dutch-specific, and contains unsuited terminology. The mapping from zib to FHIR is not trivial and results in too complex mapping. Therefore, the CBB is redesigned based on what is implemented internationally and in Belgium by looking at the FHIR data type and eHealth core profiles. The new model replaces the containers for phone numbers and email addresses with elements on the root that can capture both. Therefore, no need for two profiles, slicing in the host profiles and no ConceptMaps. Data Type HdBe-ContactInformation Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a zib-contactinformation-v1.2-2020EN:NL-CM:20.6.2 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.3 HdBe-ContactInformation:ContactInformation zib-contactperson-v3.4-2020EN:NL-CM:3.1.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.1 HdBe-ContactPerson:ContactInformation
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.telecom.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
comment	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.telecom.extension:comment 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(string) Extension URL https://fhir.healthdata.be/StructureDefinition/ext-Comment 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.telecom.extension:comment.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-Comment Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Patient.contact.telecom.extension:comment.value[x] Short description Comment Alternate names Toelichting Definition Explanation about the telephone number and how to use it. It can be indicated, for example, that it is a department number (for healthcare professionals) or that availability by phone is only possible during a specified part of the day. 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-contactinformation-v1.2-2020EN:NL-CM:20.6.9 HdBe-ContactInformation:ContactInformation.Comment
valueString			string	There are no (further) constraints on this element Data Type string
system	Σ I	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.telecom.system Short description Type Alternate names Type Definition The type of contact information. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Telecommunications form for contact point. ContactPointSystem (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.3 rim:./scheme servd:./ContactPointType zib-contactinformation-v1.2-2020EN:NL-CM:20.6.5 HdBe-ContactInformation:ContactInformation.Type
value	Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.contact.telecom.value Short description Value Alternate names Waarde Definition The actual contact information details. Requirements Need to support legacy numbers that are not in a tightly controlled format. Comments Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.1 (or XTN.12) rim:./url servd:./Value zib-contactinformation-v1.2-2020EN:NL-CM:20.6.4 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.7 HdBe-ContactInformation:ContactInformation.Value
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.telecom.use Short description Use Alternate names Gebruik Definition Purpose or use of the contact information. For example whether it is a private or business telephone number. Requirements Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Comments Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Data Type code Binding Use of contact point. ContactPointUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XTN.2 - but often indicated by field rim:unique(./use) servd:./ContactPointPurpose zib-contactinformation-v1.2-2020EN:NL-CM:20.6.6 zib-contactinformation-v1.2-2020EN:NL-CM:20.6.8 HdBe-ContactInformation:ContactInformation.Use
rank	Σ	0..1	positiveInt	There are no (further) constraints on this element Element Id Patient.contact.telecom.rank Short description Specify preferred order of use (1 = highest) Definition Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Comments Note that rank does not necessarily follow the order in which the contacts are represented in the instance. Data Type positiveInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:n/a
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.telecom.period Short description Time period when the contact point was/is in use Definition Time period when the contact point was/is in use. 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"] v2:N/A rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
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:AddressInformation zib-contactperson-v3.4-2020EN:NL-CM:3.1.5 HdBe-ContactPerson:AddressInformation
extension	I	1..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.address.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
language	I	1..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.contact.address.extension:language Short description Human Language for the item Alternate names extensions, user content Definition The Human Language of the item. Comments This is used where an item may repeat to indicate the language of each repeat. Data Type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/language 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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.address.use Short description AddressType Alternate names AdresSoort Definition The type of address in question, such as a home address or mailing address. Requirements Allows an appropriate address to be chosen from a list of many. Comments Applications can assume that an address is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of an address. AddressUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General home Mappings rim:n/a v2:XAD.7 rim:unique(./use) servd:./AddressPurpose zib-addressinformation-v1.1-2020EN:NL-CM:20.5.8 HdBe-AddressInformation:AddressInformation.AddressUse
type	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.address.type Short description AddressType Alternate names AdresSoort Definition The type of address in question, such as a home address or mailing address. Comments The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). Data Type code Binding The type of an address (physical / postal). AddressType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General both Mappings rim:n/a v2:XAD.18 rim:unique(./use) vcard:address type parameter zib-addressinformation-v1.1-2020EN:NL-CM:20.5.8 HdBe-AddressInformation:AddressInformation.AddressType
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.text Short description Text representation of the address Definition Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. Requirements A renderable, unencoded form. Comments Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street, Erewhon 9132 Mappings rim:n/a v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim:./formatted vcard:address label parameter
line	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.contact.address.line Short description Street name, number, direction & P.O. Box etc. Definition This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Comments The elements of Address stored in the address-part extensions will be ignored by applications that do not support them, so any information in them should also be duplicated in the `Address.line` to which they are attached. The value of `Address.line` should be populated with a complete string representation of all the separate extension values, like: "[Street] [HouseNumberIndication] [HouseNumber] [HouseNumberLetter] [HouseNumberAddition]". Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 137 Nowhere Street Mappings rim:n/a v2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim:AD.part[parttype = AL] vcard:street servd:./StreetAddress (newline delimitted)
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.address.line.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
streetName	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:streetName Short description streetName Alternate names extensions, user content Definition streetName. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName 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 rim:ADXP[partType=STR]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:streetName.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/iso21090-ADXP-streetName Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:streetName.value[x] Short description Street Alternate names Straat Definition Street name of the address. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.2 HdBe-AddressInformation:AddressInformation.Street
valueString			string	There are no (further) constraints on this element Data Type string
houseNumber	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumber Short description houseNumber Alternate names extensions, user content Definition The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber 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 rim:ADXP[partType=BNR]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumber.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/iso21090-ADXP-houseNumber Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumber.value[x] Short description HouseNumber Alternate names Huisnummer Definition House number of the address. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.12 HdBe-AddressInformation:AddressInformation.HouseNumber
valueString			string	There are no (further) constraints on this element Data Type string
houseNumberLetter-houseNumberAddition	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberLetter-houseNumberAddition Short description buildingNumberSuffix Alternate names extensions, user content Definition Any alphabetic character, fraction or other text that may appear after the numeric portion of a building number. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix 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 rim:ADXP[partType=BNS]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberLetter-houseNumberAddition.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/iso21090-ADXP-buildingNumberSuffix Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberLetter-houseNumberAddition.value[x] Short description HouseNumberLetter / HouseNumberAddition Alternate names Huisnummerletter, Huisnummertoevoeging Definition Export: If a HouseNumberLetter as well as a HouseNumberAddition is known: HouseNumberLetter first, followed by a space and finally the HouseNumberAddition. If only a HouseNumberLetter is known, send just that. No trailing space is required. If only a HouseNumberAddition is known, communicate that with a leading space. Import If the value of buildingNumberSuffix contains no space, then the whole value is considered to be the HouseNumberLetter. If the value of buildingNumberSuffix contains a space, then everything before the first space is considered to be the HouseNumberLetter, and the everything trailing the first space is considered to be the HouseNumberAddition. Note: While a leading space is allowed in string values in FHIR, the parsing of such space cannot be guaranteed in XML representations. Although aware of this issue, this mapping is not changed because of compatibility reasons. If an implementer cannot parse a leading space, the practical risk of mapping a HouseNumberIndication to a HouseNumberAddition is deemed insignificant. 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-addressinformation-v1.1-2020EN:NL-CM:20.5.11 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.10 HdBe-AddressInformation:AddressInformation.HouseNumberLetter HdBe-AddressInformation:AddressInformation.HouseNumberAddition
valueString			string	There are no (further) constraints on this element Data Type string
houseNumberIndication	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberIndication Short description additionalLocator Alternate names extensions, user content Definition This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator 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 rim:ADXP[partType=ADL]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberIndication.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/iso21090-ADXP-additionalLocator Mappings rim:N/A
value[x]	I	1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:houseNumberIndication.value[x] Short description HouseNumberIndication Alternate names AanduidingBijNummer Definition The indication used for addresses which do not consist of the usual street name and house number. Comments The coded HouseNumberIndication concept (CD datatype) is mapped to a FHIR string datatype with a constraint added (the value can only be 'by' or 'to'). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` houseNumberIndication:Must have value 'by' or 'to' `value in ('by' \| 'to')` Mappings rim:n/a rim:N/A zib-addressinformation-v1.1-2020EN:NL-CM:20.5.9 HdBe-AddressInformation:AddressInformation.HouseNumberIndication
valueString			string	There are no (further) constraints on this element Data Type string
additionalInformation	I	0..1	Extension(string)	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:additionalInformation Short description unitID Alternate names extensions, user content Definition The number or name of a specific unit contained within a building or complex, as assigned by that building or complex. 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(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID 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 rim:ADXP[partType=UNID]
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:additionalInformation.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/iso21090-ADXP-unitID Mappings rim:N/A
value[x]		1..1		There are no (further) constraints on this element Element Id Patient.contact.address.line.extension:additionalInformation.value[x] Short description AdditionalInformation Alternate names AdditioneleInformatie 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 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.7 HdBe-AddressInformation:AddressInformation.AdditionalInformation
valueString			string	There are no (further) constraints on this element Data Type string
city	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.city Short description PlaceOfResidence Alternate names Municpality, Woonplaats Definition A geographically determined area which forms part of the municipal area. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Erewhon Mappings rim:n/a v2:XAD.3 rim:AD.part[parttype = CTY] vcard:locality servd:./Jurisdiction zib-addressinformation-v1.1-2020EN:NL-CM:20.5.3 HdBe-AddressInformation:AddressInformation.PlaceOfResidence
district	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.district Short description Municipality Alternate names County, Gemeente Definition Municipality of residence. Comments District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Madison Mappings rim:n/a v2:XAD.9 rim:AD.part[parttype = CNT \| CPA] zib-addressinformation-v1.1-2020EN:NL-CM:20.5.4 HdBe-AddressInformation:AddressInformation.Municipality
state	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.state Short description Sub-unit of country (abbreviations ok) Alternate names Province, Territory Definition Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.4 rim:AD.part[parttype = STA] vcard:region servd:./Region
postalCode	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.postalCode Short description Postcode Alternate names Zip, Postcode Definition Postcode of the address. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 9132 Mappings rim:n/a v2:XAD.5 rim:AD.part[parttype = ZIP] vcard:code servd:./PostalIdentificationCode zib-addressinformation-v1.1-2020EN:NL-CM:20.5.6 HdBe-AddressInformation:AddressInformation.Postcode
country	Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.contact.address.country Short description Country (e.g. can be ISO 3166 2 or 3 letter code) Definition Country - a nation as commonly understood or generally accepted. Comments The FHIR datatype does not properly support coding the country using a CodeableConcept or Coding datatype. If the sender supports coded countries, it SHALL send the coded value using the CodeSpecification extension under `Address.country.extension:countryCode`. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD.6 rim:AD.part[parttype = CNT] vcard:country servd:./Country
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id Patient.contact.address.country.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
countryCode	I	0..1	Extension(CodeableConcept)	There are no (further) constraints on this element Element Id Patient.contact.address.country.extension:countryCode 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.contact.address.country.extension:countryCode.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	There are no (further) constraints on this element Element Id Patient.contact.address.country.extension:countryCode.value[x] Short description Country Alternate names Land Definition Country in which the address is located. Binding Iso 3166 Part 1: 2 Letter Codes CountryISO (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 zib-addressinformation-v1.1-2020EN:NL-CM:20.5.5 HdBe-AddressInformation:AddressInformation.Country
valueCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.address.period Short description Time period when address was/is in use Definition Time period when address was/is in use. Requirements Allows addresses to be placed in historical context. 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)` Examples General { "start": "2010-03-23", "end": "2010-07-01" } Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XAD.12 / XAD.13 + XAD.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
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.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.name	NameInformation	HdBe-ContactPerson
Patient.contact.telecom	ContactInformation	HdBe-ContactPerson
Patient.contact.address	AddressInformation	HdBe-ContactPerson
Patient.maritalStatus	MaritalStatusRC.MaritalStatus	HdBe-MaritalStatus
Patient.extension:nationality.extension:code.value[x]	NationalityRC.Nationality	HdBe-Nationality
Patient	Patient	HdBe-Patient
Patient.identifier	Patient.PatientIdentificationNumber	HdBe-Patient
Patient.name	Patient.NameInformation	HdBe-Patient
Patient.telecom	Patient.ContactInformation	HdBe-Patient
Patient.gender	Patient.Gender	HdBe-Patient
Patient.gender.extension:genderCodelist.value[x]	Patient.Gender	HdBe-Patient
Patient.birthDate	Patient.DateOfBirth	HdBe-Patient
Patient.deceased[x]:deceasedBoolean	Patient.DeathIndicator	HdBe-Patient
Patient.deceased[x]:deceasedDateTime	Patient.DateOfDeath	HdBe-Patient
Patient.deceased[x]:deceasedDateTime	Patient.DeathIndicator	HdBe-Patient
Patient.address	Patient.AddressInformation	HdBe-Patient
Patient.multipleBirth[x]:multipleBirthBoolean	Patient.MultipleBirthIndicator	HdBe-Patient
Patient.multipleBirth[x]:multipleBirthInteger	Patient.MultipleBirthOrder	HdBe-Patient
Patient.multipleBirth[x]:multipleBirthInteger	Patient.MultipleBirthIndicator	HdBe-Patient

zib Patient difference

Concept	Category	Description
`PatientIdentificationNumber`	textual	Replaced the Dutch context (BSN) with the Belgian equivalent (NISS-INSZ).
`PatientIdentificationNumber`	mapping	Moved mapping from the slice definition to the root identifier. Nictiz ticket #230
`telecom`	reference	Added reference to HdBe-ContactInformation profile, which replaces the two separate HdBe-ContactInformation profiles.
`telecom`	slicing	Removed slicing as the two HdBe-ContactInformation profiles are replaced with one general HdBe-ContactInformation profile, which makes slicing unnecessary.
`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.
`MultipleBirthOrder`	element	Added mapping to mulitple birth order.
`contact.telecom`	reference	Added reference to HdBe-ContactInformation profile, which replaces the two separate HdBe-ContactInformation profiles.
`contact.telecom`	slicing	Removed slicing as the two HdBe-ContactInformation profiles are replaced with one general HdBe-ContactInformation profile, which makes slicing unnecessary.
`extension:nationality.extension:code`	terminology	Replaced GBA Nationaliteitentabel with ISO 3166.

Terminology Bindings

Path	Name	Strength	URL	ConceptMap
Patient.extension.extension.value[x]	CountryISO	extensible	https://fhir.healthdata.be/ValueSet/CountryISO	No bound ConceptMap
Patient.gender	administrative-gender\|4.0.1	required	http://hl7.org/fhir/ValueSet/administrative-gender\|4.0.1
Patient.gender.extension.value[x]	Gender	required	https://fhir.healthdata.be/ValueSet/Gender	No bound ConceptMap
Patient.maritalStatus	be-civilstate	required	https://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-civilstate
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