This page is part of the HL7 Belgium FHIR Implementation Guide - Core profiles (v2.0.0: Trial Use Draft) based on FHIR R4. The current version which supercedes this version is 2.0.1. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Patient core BE profile

Official URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient				Version: 2.0.0
Active as of 2022-03-24		Responsible: eHealth Platform	Realm: BE	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.)

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
Patient.language	preferred	CommonLanguages Max Binding: AllLanguages
Patient.identifier:SSIN.use	required	IdentifierUse
Patient.identifier:SSIN.type	extensible	Identifier Type Codes
Patient.gender	required	AdministrativeGender
Patient.maritalStatus	required	BeCivilstate
Patient.contact.relationship	extensible	BeContactPerson
Patient.contact.gender	required	AdministrativeGender
Patient.communication.language	preferred	CommonLanguages Max Binding: AllLanguages
Patient.link.type	required	LinkType

Constraints

Id	Grade	Path	Details	Requirements
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	Patient.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.extension:nationality	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.extension:nationality	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.extension:birthPlace	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.extension:birthPlace	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier:SSIN	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier:SSIN.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.identifier:SSIN.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.identifier:SSIN.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier:SSIN.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier:SSIN.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier:SSIN.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier:SSIN.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.identifier:SSIN.assigner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.active	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.gender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.birthDate	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.birthDate.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.birthDate.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.birthDate.extension:birthTime	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.birthDate.extension:birthTime	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.deceased[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.maritalStatus	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.multipleBirth[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.photo	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
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()
ele-1	error	Patient.contact.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.contact.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.contact.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.contact.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.contact.relationship	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.gender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.organization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.contact.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.communication	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.communication.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.communication.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.communication.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.communication.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.communication.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.communication.preferred	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.generalPractitioner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.managingOrganization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.link	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.link.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.link.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.link.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Patient.link.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Patient.link.other	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Patient.link.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())