eHealth Platform Federal Core Profiles
2.1.2 - STU1
eHealth Platform Federal Core Profiles
2.1.2 - STU1
eHealth Platform Federal Core Profiles, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/core/ and changes regularly. See the Directory of published versions
| Draft as of 2025-07-17 |
Definitions for the BeModelPatient logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. BeModelPatient | |
| Definition | Data about a patient, according to the National Register of Persons (Ministry of the Interior), and possibly other sources to be mentioned when used. |
| Short | BeModelPatient |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. BeModelPatient.names | |
| Definition | Names |
| Short | Names |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. BeModelPatient.names.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 6. BeModelPatient.names.extension | |
| 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on BeModelPatient.names.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 8. BeModelPatient.names.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 10. BeModelPatient.names.usage | |
| Definition | Usage context of the name (e.g. NR 11, if the name is used as a pseudonym) |
| Short | Usage context of the name (e.g. NR 11, if the name is used as a pseudonym) |
| Control | 0..1 |
| Type | CodeableConcept |
| 12. BeModelPatient.names.familyname | |
| Definition | Surname (NR 10) |
| Short | Surname (NR 10) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. BeModelPatient.names.firstnames | |
| Definition | Given names (NR 10) |
| Short | Given names (NR 10) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. BeModelPatient.names.title | |
| Definition | Title of nobility (NR 12) |
| Short | Title of nobility (NR 12) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. BeModelPatient.names.period | |
| Definition | Period of validity of the name (e.g. NR 13 Change of name, first names and title of nobility) |
| Short | Period of validity of the name (e.g. NR 13 Change of name, first names and title of nobility) |
| Control | 0..1 |
| Type | Period |
| 20. BeModelPatient.birth | |
| Definition | Birth data |
| Short | Birth data |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. BeModelPatient.birth.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 24. BeModelPatient.birth.extension | |
| 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on BeModelPatient.birth.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. BeModelPatient.birth.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 28. BeModelPatient.birth.place | |
| Definition | Place of birth (NR 100 or NR 101) |
| Short | Place of birth (NR 100 or NR 101) |
| Control | 0..1 |
| Type | Address |
| 30. BeModelPatient.birth.date | |
| Definition | Date of birth (NR 100 or NR 101) |
| Short | Date of birth (NR 100 or NR 101) |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. BeModelPatient.birth.multiple | |
| Definition | Number of siblings + person in case of multiple birth |
| Short | Number of siblings + person in case of multiple birth |
| Control | 0..1 |
| Type | positiveInt |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. BeModelPatient.gender | |
| Definition | Gender |
| Short | Gender |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. BeModelPatient.gender.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 38. BeModelPatient.gender.extension | |
| 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on BeModelPatient.gender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 40. BeModelPatient.gender.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 42. BeModelPatient.gender.administrative | |
| Definition | Gender (integrated in the identification no.: 000) |
| Short | Gender (integrated in the identification no.: 000) |
| Control | 0..1 |
| Type | CodeableConcept |
| 44. BeModelPatient.gender.atbirth | |
| Definition | Gender at birth, accounts for gender changes and errors (NR 2 and NR 4) |
| Short | Gender at birth, accounts for gender changes and errors (NR 2 and NR 4) |
| Control | 0..1 |
| Type | CodeableConcept |
| 46. BeModelPatient.gender.social | |
| Definition | Gender the person identifies with |
| Short | Gender the person identifies with |
| Control | 0..1 |
| Type | CodeableConcept |
| 48. BeModelPatient.nationality | |
| Definition | Current nationality (and dual nationality) (NR 31, NR 32) |
| Short | Current nationality (and dual nationality) (NR 31, NR 32) |
| Control | 0..* |
| Type | CodeableConcept |
| 50. BeModelPatient.residence | |
| Definition | Main and other residences (NR 1, 3, 5, 18, 19, 20,22, 23, 24, 26, 27). NR 252 will be covered by other privacy rules. |
| Short | Main and other residences (NR 1, 3, 5, 18, 19, 20,22, 23, 24, 26, 27). NR 252 will be covered by other privacy rules. |
| Control | 0..* |
| Type | Address |
| 52. BeModelPatient.death | |
| Definition | Date and state of death (place of death is not clinically relevant, and we only care about factual death, not absence (NR 151) or administrative/judicial death (NR 150)) |
| Short | Date and state of death (place of death is not clinically relevant, and we only care about factual death, not absence (NR 151) or administrative/judicial death (NR 150)) |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. BeModelPatient.death.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 56. BeModelPatient.death.extension | |
| 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on BeModelPatient.death.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 58. BeModelPatient.death.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 60. BeModelPatient.death.date | |
| Definition | Date of death |
| Short | Date of death |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 62. BeModelPatient.death.deceased | |
| Definition | The person is deceased |
| Short | The person is deceased |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 64. BeModelPatient.maritalstatus | |
| Definition | Marital Status |
| Short | Marital Status |
| Control | 0..1 |
| Type | CodeableConcept |
| 66. BeModelPatient.telecom | |
| Definition | Means of contact |
| Short | Means of contact |
| Control | 0..1 |
| Type | ContactPoint |
| 68. BeModelPatient.contact | |
| Definition | Identifiers of contact persons |
| Short | Identifiers of contact persons |
| Control | 0..* |
| Type | Identifier |
| 70. BeModelPatient.communication | |
| Definition | language of communication |
| Short | language of communication |
| Control | 0..1 |
| Type | CodeableConcept |
| 72. BeModelPatient.generalPractitioner | |
| Definition | identifier of the GMD holder |
| Short | identifier of the GMD holder |
| Control | 0..1 |
| Type | Identifier |
| 74. BeModelPatient.managingOrganisation | |
| Definition | identifier of the organisation managing the patient record |
| Short | identifier of the organisation managing the patient record |
| Control | 0..1 |
| Type | Identifier |
Guidance on how to interpret the contents of this table can be foundhere
| 0. BeModelPatient | |
| Definition | Data about a patient, according to the National Register of Persons (Ministry of the Interior), and possibly other sources to be mentioned when used. |
| Short | BeModelPatient |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. BeModelPatient.names | |
| Definition | Names |
| Short | Names |
| Control | 0..* |
| Type | BackboneElement |
| 4. BeModelPatient.names.usage | |
| Definition | Usage context of the name (e.g. NR 11, if the name is used as a pseudonym) |
| Short | Usage context of the name (e.g. NR 11, if the name is used as a pseudonym) |
| Control | 0..1 |
| Type | CodeableConcept |
| 6. BeModelPatient.names.familyname | |
| Definition | Surname (NR 10) |
| Short | Surname (NR 10) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. BeModelPatient.names.firstnames | |
| Definition | Given names (NR 10) |
| Short | Given names (NR 10) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. BeModelPatient.names.title | |
| Definition | Title of nobility (NR 12) |
| Short | Title of nobility (NR 12) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. BeModelPatient.names.period | |
| Definition | Period of validity of the name (e.g. NR 13 Change of name, first names and title of nobility) |
| Short | Period of validity of the name (e.g. NR 13 Change of name, first names and title of nobility) |
| Control | 0..1 |
| Type | Period |
| 14. BeModelPatient.birth | |
| Definition | Birth data |
| Short | Birth data |
| Control | 0..1 |
| Type | BackboneElement |
| 16. BeModelPatient.birth.place | |
| Definition | Place of birth (NR 100 or NR 101) |
| Short | Place of birth (NR 100 or NR 101) |
| Control | 0..1 |
| Type | Address |
| 18. BeModelPatient.birth.date | |
| Definition | Date of birth (NR 100 or NR 101) |
| Short | Date of birth (NR 100 or NR 101) |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. BeModelPatient.birth.multiple | |
| Definition | Number of siblings + person in case of multiple birth |
| Short | Number of siblings + person in case of multiple birth |
| Control | 0..1 |
| Type | positiveInt |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. BeModelPatient.gender | |
| Definition | Gender |
| Short | Gender |
| Control | 0..1 |
| Type | BackboneElement |
| 24. BeModelPatient.gender.administrative | |
| Definition | Gender (integrated in the identification no.: 000) |
| Short | Gender (integrated in the identification no.: 000) |
| Control | 0..1 |
| Type | CodeableConcept |
| 26. BeModelPatient.gender.atbirth | |
| Definition | Gender at birth, accounts for gender changes and errors (NR 2 and NR 4) |
| Short | Gender at birth, accounts for gender changes and errors (NR 2 and NR 4) |
| Control | 0..1 |
| Type | CodeableConcept |
| 28. BeModelPatient.gender.social | |
| Definition | Gender the person identifies with |
| Short | Gender the person identifies with |
| Control | 0..1 |
| Type | CodeableConcept |
| 30. BeModelPatient.nationality | |
| Definition | Current nationality (and dual nationality) (NR 31, NR 32) |
| Short | Current nationality (and dual nationality) (NR 31, NR 32) |
| Control | 0..* |
| Type | CodeableConcept |
| 32. BeModelPatient.residence | |
| Definition | Main and other residences (NR 1, 3, 5, 18, 19, 20,22, 23, 24, 26, 27). NR 252 will be covered by other privacy rules. |
| Short | Main and other residences (NR 1, 3, 5, 18, 19, 20,22, 23, 24, 26, 27). NR 252 will be covered by other privacy rules. |
| Control | 0..* |
| Type | Address |
| 34. BeModelPatient.death | |
| Definition | Date and state of death (place of death is not clinically relevant, and we only care about factual death, not absence (NR 151) or administrative/judicial death (NR 150)) |
| Short | Date and state of death (place of death is not clinically relevant, and we only care about factual death, not absence (NR 151) or administrative/judicial death (NR 150)) |
| Control | 0..1 |
| Type | BackboneElement |
| 36. BeModelPatient.death.date | |
| Definition | Date of death |
| Short | Date of death |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. BeModelPatient.death.deceased | |
| Definition | The person is deceased |
| Short | The person is deceased |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. BeModelPatient.maritalstatus | |
| Definition | Marital Status |
| Short | Marital Status |
| Control | 0..1 |
| Type | CodeableConcept |
| 42. BeModelPatient.telecom | |
| Definition | Means of contact |
| Short | Means of contact |
| Control | 0..1 |
| Type | ContactPoint |
| 44. BeModelPatient.contact | |
| Definition | Identifiers of contact persons |
| Short | Identifiers of contact persons |
| Control | 0..* |
| Type | Identifier |
| 46. BeModelPatient.communication | |
| Definition | language of communication |
| Short | language of communication |
| Control | 0..1 |
| Type | CodeableConcept |
| 48. BeModelPatient.generalPractitioner | |
| Definition | identifier of the GMD holder |
| Short | identifier of the GMD holder |
| Control | 0..1 |
| Type | Identifier |
| 50. BeModelPatient.managingOrganisation | |
| Definition | identifier of the organisation managing the patient record |
| Short | identifier of the organisation managing the patient record |
| Control | 0..1 |
| Type | Identifier |
Guidance on how to interpret the contents of this table can be foundhere
| 0. BeModelPatient | |
| Definition | Data about a patient, according to the National Register of Persons (Ministry of the Interior), and possibly other sources to be mentioned when used. |
| Short | BeModelPatient |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. BeModelPatient.names | |
| Definition | Names |
| Short | Names |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. BeModelPatient.names.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 6. BeModelPatient.names.extension | |
| 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on BeModelPatient.names.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 8. BeModelPatient.names.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 10. BeModelPatient.names.usage | |
| Definition | Usage context of the name (e.g. NR 11, if the name is used as a pseudonym) |
| Short | Usage context of the name (e.g. NR 11, if the name is used as a pseudonym) |
| Control | 0..1 |
| Type | CodeableConcept |
| 12. BeModelPatient.names.familyname | |
| Definition | Surname (NR 10) |
| Short | Surname (NR 10) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. BeModelPatient.names.firstnames | |
| Definition | Given names (NR 10) |
| Short | Given names (NR 10) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. BeModelPatient.names.title | |
| Definition | Title of nobility (NR 12) |
| Short | Title of nobility (NR 12) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. BeModelPatient.names.period | |
| Definition | Period of validity of the name (e.g. NR 13 Change of name, first names and title of nobility) |
| Short | Period of validity of the name (e.g. NR 13 Change of name, first names and title of nobility) |
| Control | 0..1 |
| Type | Period |
| 20. BeModelPatient.birth | |
| Definition | Birth data |
| Short | Birth data |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. BeModelPatient.birth.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 24. BeModelPatient.birth.extension | |
| 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on BeModelPatient.birth.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. BeModelPatient.birth.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 28. BeModelPatient.birth.place | |
| Definition | Place of birth (NR 100 or NR 101) |
| Short | Place of birth (NR 100 or NR 101) |
| Control | 0..1 |
| Type | Address |
| 30. BeModelPatient.birth.date | |
| Definition | Date of birth (NR 100 or NR 101) |
| Short | Date of birth (NR 100 or NR 101) |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. BeModelPatient.birth.multiple | |
| Definition | Number of siblings + person in case of multiple birth |
| Short | Number of siblings + person in case of multiple birth |
| Control | 0..1 |
| Type | positiveInt |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. BeModelPatient.gender | |
| Definition | Gender |
| Short | Gender |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. BeModelPatient.gender.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 38. BeModelPatient.gender.extension | |
| 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on BeModelPatient.gender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 40. BeModelPatient.gender.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 42. BeModelPatient.gender.administrative | |
| Definition | Gender (integrated in the identification no.: 000) |
| Short | Gender (integrated in the identification no.: 000) |
| Control | 0..1 |
| Type | CodeableConcept |
| 44. BeModelPatient.gender.atbirth | |
| Definition | Gender at birth, accounts for gender changes and errors (NR 2 and NR 4) |
| Short | Gender at birth, accounts for gender changes and errors (NR 2 and NR 4) |
| Control | 0..1 |
| Type | CodeableConcept |
| 46. BeModelPatient.gender.social | |
| Definition | Gender the person identifies with |
| Short | Gender the person identifies with |
| Control | 0..1 |
| Type | CodeableConcept |
| 48. BeModelPatient.nationality | |
| Definition | Current nationality (and dual nationality) (NR 31, NR 32) |
| Short | Current nationality (and dual nationality) (NR 31, NR 32) |
| Control | 0..* |
| Type | CodeableConcept |
| 50. BeModelPatient.residence | |
| Definition | Main and other residences (NR 1, 3, 5, 18, 19, 20,22, 23, 24, 26, 27). NR 252 will be covered by other privacy rules. |
| Short | Main and other residences (NR 1, 3, 5, 18, 19, 20,22, 23, 24, 26, 27). NR 252 will be covered by other privacy rules. |
| Control | 0..* |
| Type | Address |
| 52. BeModelPatient.death | |
| Definition | Date and state of death (place of death is not clinically relevant, and we only care about factual death, not absence (NR 151) or administrative/judicial death (NR 150)) |
| Short | Date and state of death (place of death is not clinically relevant, and we only care about factual death, not absence (NR 151) or administrative/judicial death (NR 150)) |
| Control | 0..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. BeModelPatient.death.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 56. BeModelPatient.death.extension | |
| 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. |
| Short | Additional content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | 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()) |
| Slicing | This element introduces a set of slices on BeModelPatient.death.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 58. BeModelPatient.death.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | 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()) |
| 60. BeModelPatient.death.date | |
| Definition | Date of death |
| Short | Date of death |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 62. BeModelPatient.death.deceased | |
| Definition | The person is deceased |
| Short | The person is deceased |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 64. BeModelPatient.maritalstatus | |
| Definition | Marital Status |
| Short | Marital Status |
| Control | 0..1 |
| Type | CodeableConcept |
| 66. BeModelPatient.telecom | |
| Definition | Means of contact |
| Short | Means of contact |
| Control | 0..1 |
| Type | ContactPoint |
| 68. BeModelPatient.contact | |
| Definition | Identifiers of contact persons |
| Short | Identifiers of contact persons |
| Control | 0..* |
| Type | Identifier |
| 70. BeModelPatient.communication | |
| Definition | language of communication |
| Short | language of communication |
| Control | 0..1 |
| Type | CodeableConcept |
| 72. BeModelPatient.generalPractitioner | |
| Definition | identifier of the GMD holder |
| Short | identifier of the GMD holder |
| Control | 0..1 |
| Type | Identifier |
| 74. BeModelPatient.managingOrganisation | |
| Definition | identifier of the organisation managing the patient record |
| Short | identifier of the organisation managing the patient record |
| Control | 0..1 |
| Type | Identifier |
IG © 2021+ eHealth Platform. Package hl7.fhir.be.core#2.1.2 based on FHIR 4.0.1. Generated 2025-07-17
Links: Table of Contents |
QA Report |
Version History |
