eHealth Platform Federal Core Profiles
2.1.2 - Belgium flag

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

Resource Profile: BePatient

Official URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient Version: 2.1.2
Computable Name: BePatient

Belgian federal profile for a patient. Initially based on the functional description of the NIHDI. Special remarks for KMEHR users: following elements in KMEHR are not available in this FHIR resource. If needed, an extension can be defined in a future iteration of these specifications: the ‘deathlocation’ (location is not available but the death of the patient is expressed by either date or Boolean cfr. infra.), the ‘insurancystatus’ (covered in a seperate FHIR resource: Coverage), ‘insurancymembership’ (covered in a seperate FHIR resource: Coverage) and ‘profession’ (covered in a possible future FHIR resource: OccupationalData.)

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:birthPlace 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension:socialGender 0..1 CodeableConcept The patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding Description: (example): a value set
.... extension:genderAtBirth 0..1 CodeableConcept Gender at the time of birth
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth
Binding: List of possible genders at birth in Belgium (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:SSIN Σ 0..* Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
..... value Σ 1..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 0..* HumanName A name associated with the patient
... telecom Σ 0..* ContactPoint A contact detail for the individual
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date of birth for the individual
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* BeAddress An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: BeCivilState (required)
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: BeContactPerson (extensible)
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... generalPractitioner 0..* Reference(BeOrganization | BePractitioner | BePractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(BeOrganization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:SSIN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required BeCivilState 📦2.1.2 This IG
Patient.contact.relationship Base extensible BeContactPerson 📦2.1.2 This IG
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
be-inv-SSIN error Patient.identifier SINN contains 11 digits without interpunction Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('\\d{11}')).allTrue()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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-4 error Patient 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-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact 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()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:birthPlace 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension:socialGender 0..1 CodeableConcept The patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding Description: (example): a value set
.... extension:genderAtBirth 0..1 CodeableConcept Gender at the time of birth
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth
Binding: List of possible genders at birth in Belgium (required)
... Slices for identifier SC 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: be-inv-SSIN
.... identifier:SSIN 0..* Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
..... value 1..1 string The value that is unique
... name S 0..* HumanName A name associated with the patient
... gender 0..1 code male | female | other | unknown
... birthDate 0..1 date The date of birth for the individual
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... deceased[x] 0..1 boolean, dateTime Indicates if the individual is deceased or not
... address 0..* BeAddress An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: BeCivilState (required)
... multipleBirth[x] 0..1 boolean, integer Whether patient is part of a multiple birth
... contact 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
.... relationship 0..* CodeableConcept The kind of relationship
Binding: BeContactPerson (extensible)
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
... generalPractitioner 0..* Reference(BeOrganization | BePractitioner | BePractitionerRole) Patient's nominated primary care provider
... managingOrganization 0..1 Reference(BeOrganization) Organization that is the custodian of the patient record

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.maritalStatus Base required BeCivilState 📦2.1.2 This IG
Patient.contact.relationship Base extensible BeContactPerson 📦2.1.2 This IG

Constraints

Id Grade Path(s) Description Expression
be-inv-SSIN error Patient.identifier SINN contains 11 digits without interpunction Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('\\d{11}')).allTrue()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:birthPlace 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension:socialGender 0..1 CodeableConcept The patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding Description: (example): a value set
.... extension:genderAtBirth 0..1 CodeableConcept Gender at the time of birth
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth
Binding: List of possible genders at birth in Belgium (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: be-inv-SSIN
.... identifier:SSIN Σ 0..* Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 0..* HumanName A name associated with the patient
... telecom Σ 0..* ContactPoint A contact detail for the individual
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date of birth for the individual
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1 date Primitive value for date
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* BeAddress An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: BeCivilState (required)
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: BeContactPerson (extensible)
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(BeOrganization | BePractitioner | BePractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(BeOrganization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier:SSIN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSIN.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required BeCivilState 📦2.1.2 This IG
Patient.contact.relationship Base extensible BeContactPerson 📦2.1.2 This IG
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
be-inv-SSIN error Patient.identifier SINN contains 11 digits without interpunction Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('\\d{11}')).allTrue()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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-4 error Patient 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-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:birthPlace 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension:socialGender 0..1 CodeableConcept The patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding Description: (example): a value set
.... extension:genderAtBirth 0..1 CodeableConcept Gender at the time of birth
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth
Binding: List of possible genders at birth in Belgium (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:SSIN Σ 0..* Identifier An identifier for this patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
..... value Σ 1..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 0..* HumanName A name associated with the patient
... telecom Σ 0..* ContactPoint A contact detail for the individual
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date of birth for the individual
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* BeAddress An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: BeCivilState (required)
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: BeContactPerson (extensible)
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... generalPractitioner 0..* Reference(BeOrganization | BePractitioner | BePractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(BeOrganization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:SSIN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required BeCivilState 📦2.1.2 This IG
Patient.contact.relationship Base extensible BeContactPerson 📦2.1.2 This IG
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
be-inv-SSIN error Patient.identifier SINN contains 11 digits without interpunction Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('\\d{11}')).allTrue()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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-4 error Patient 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-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact 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()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:birthPlace 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension:socialGender 0..1 CodeableConcept The patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding Description: (example): a value set
.... extension:genderAtBirth 0..1 CodeableConcept Gender at the time of birth
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth
Binding: List of possible genders at birth in Belgium (required)
... Slices for identifier SC 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: be-inv-SSIN
.... identifier:SSIN 0..* Identifier An identifier for this patient
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
..... value 1..1 string The value that is unique
... name S 0..* HumanName A name associated with the patient
... gender 0..1 code male | female | other | unknown
... birthDate 0..1 date The date of birth for the individual
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... deceased[x] 0..1 boolean, dateTime Indicates if the individual is deceased or not
... address 0..* BeAddress An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: BeCivilState (required)
... multipleBirth[x] 0..1 boolean, integer Whether patient is part of a multiple birth
... contact 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
.... relationship 0..* CodeableConcept The kind of relationship
Binding: BeContactPerson (extensible)
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
... generalPractitioner 0..* Reference(BeOrganization | BePractitioner | BePractitionerRole) Patient's nominated primary care provider
... managingOrganization 0..1 Reference(BeOrganization) Organization that is the custodian of the patient record

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.maritalStatus Base required BeCivilState 📦2.1.2 This IG
Patient.contact.relationship Base extensible BeContactPerson 📦2.1.2 This IG

Constraints

Id Grade Path(s) Description Expression
be-inv-SSIN error Patient.identifier SINN contains 11 digits without interpunction Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('\\d{11}')).allTrue()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:birthPlace 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension:socialGender 0..1 CodeableConcept The patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding Description: (example): a value set
.... extension:genderAtBirth 0..1 CodeableConcept Gender at the time of birth
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-gender-at-birth
Binding: List of possible genders at birth in Belgium (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 0..* Identifier An identifier for this patient
Slice: Unordered, Open by value:system
Constraints: be-inv-SSIN
.... identifier:SSIN Σ 0..* Identifier An identifier for this patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 0..* HumanName A name associated with the patient
... telecom Σ 0..* ContactPoint A contact detail for the individual
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date of birth for the individual
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1 date Primitive value for date
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* BeAddress An address for the individual
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: BeCivilState (required)
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: BeContactPerson (extensible)
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(BeOrganization | BePractitioner | BePractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(BeOrganization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier:SSIN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSIN.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.maritalStatus Base required BeCivilState 📦2.1.2 This IG
Patient.contact.relationship Base extensible BeContactPerson 📦2.1.2 This IG
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
be-inv-SSIN error Patient.identifier SINN contains 11 digits without interpunction Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('\\d{11}')).allTrue()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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-4 error Patient 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-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact 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()

 

Other representations of profile: CSV, Excel, Schematron