Belgium eHealth FHIR Core specifications
1.2.2 - CI Build

This page is part of the Belgium eHealth FHIR Core specifications (v1.2.2: Trial Use) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide

BeAddiction

A record of a patient’s known, suspected or resolved addiction. This represents the addiction condition, not an addiction-related event or observation.

StructureDefinition/be-allergyintolerance

Belgian federal profile for an allergy and/or an intolerance. Initially based on the functional description of the NIHDI.

BeCommunication

This is the technical specification for the Communication resource, as it is used in Belgium. This specification is compatible with the current version of KMEHR Diary Note, namely the selection of attributes that are supported, and the maximum length of the payload (320 characters). It also relies on the foundation Belgium resources, for example the Belgian Patient, Practitioner and other resources.

BeHomecare Plan

This is the profile for Care Plan in a home care setting. A Care Plan contains the activities planned and/or performed by a care team to deliver care for a particular patient, usually targeting a specific goal or condition - or a set thereof.

BeHomecare Team

This is the Belgian profile for home care team. A home care team defines the people and roles organized around a patient’s care activities planned. It may also imply additional aspects such as access to information etc.

StructureDefinition/be-observation

Belgian federal profile for an observation. Initially based on the functional description of the NIHDI. As Observation is used in many instances in FHIR, please refer to the HL7 specs of the base resource for guidance around expression of actual values using UCUM, methods, location on body etc. Special remarks for KMEHR users: The FHIR Observation resource captures many things that are in a KMEHR message structured as an ‘item’. This includes things like ‘vital signs such as body weight, blood pressure, and temperature […], personal characteristics such as eye-color […] social history like tobacco use, family support, or cognitive status […]’ ( https://www.hl7.org/fhir/R4/observation.html ) For some of these things, HL7 already has worked out profiles and they SHALL be used when such a use case is needed. Specifically, projects SHALL take note of the existing profiles described on https://www.hl7.org/fhir/R4/observation-vitalsigns.html

StructureDefinition/be-organization

Belgian federal profile for an organization. Initially based on the functional description of the NIHDI.

StructureDefinition/be-patient

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.)

BePatientWill

Belgian federal profile for a patient will ONLY in the context of the patient will in the context of limitations to treatment, DNR etc. Initially based on the functional description of the NIHDI. This profile will in the future be also used to record agreement to participate in clinical trials etc. Any usecase around informed consent is out of scope for this profile.

StructureDefinition/be-practitioner

Belgian federal profile for a practitioner. Initially based on the functional description of the NIHDI.

StructureDefinition/be-practitionerrole

Belgian federal profile for a practitioner role. Initially based on the functional description of the NIHDI.

BeProblem

Belgian federal profile. Initially based on the functional description of the NIHDI. Defines a patient’s known problem, a diagnostic or antecedent that deserves attention.

Provenance core BE profile

Belgian federal profile for a provenance. Note this profile does not introduce any changes from the base profile but has been created to mark its importance, specifically when FHIR is used in a non-document approach. General use case remarks: ‘Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource.’ (cfr. the HL7 base specifications) According to the FHIR specifications, the provenance resource SHALL only be provided when no other resource already plays this role: for a Patient it SHOULD be its managing organization, provenance of an Observation SHOULD be its performer, provenance of an AllergyIntolerance SHOULD be its recorder. ‘Many other FHIR resources contain some elements that represent information about how the resource was obtained, and therefore they overlap with the functionality of the Provenance.’ Special remarks for KMEHR users: The FHIR Provenance resource in general refers to an entity that had something to do with the creation or updating of something else. In a KMEHR context, this is somewhat different – as it is ‘XML document’ based, each KMEHR message has an ‘author’ element that is responsible.

BeScoreResult

To support the standard exchange of scores such as pain assessment scores, or risk score, etc

BeVaccination

Defines constraints and extensions on the immunization resource to represent an immunization event i.e. the administration of a vaccine.

Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide

StructureDefinition/be-address

Belgain federal profile on address, to provide the possibility in the ‘line’ element to provide a seperate streetname, housenumber and postal box. It is always RECOMMENDED to give these elements seperately.

StructureDefinition/be-observationcodeableconcept

This is a supporting profile, only to give guidelines how to express a few of the typical coding systems. In general, it shall be noted SNOMED-CT is the preferred national terminology. Other coding systems remain allowed or MAY be preferred in specific flows (e.g. the use of LOINC codes to express a laboratory test.)

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide

BeExtAddictionQuantifier

The quantifier of the addiction - the quantity or frequency of the addiction

BeExtAdministeredProduct

The product administered

BeExtLaterality

An explicit statement of laterality of a lesion, or a treatment, etc.

BeExtProblemOriginType

The type of event that triggers the problem to be evaluated - whether the problem was reported from a referring GP, etc…

BeExtRecorder

The recorder of the information - note that this may not always be the same as the asserter - when a patient reports to a nurse and the nurse enters the data, the asserter is the patient, but the recorder is the nurse

BeExtVaccinationConfirmationStatus

How certain/reliable is the vaccination information

BeExtVaccinationLocation

Location (reference, code or text) of the vaccination

BeExtVaccinationOriginalOrder

A plan, proposal or order that is fulfilled in whole or in part by an event.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

ValueSet/be-allergyintolerancecode

Codes as communicated by NIHDI and the FOD Terminology Center differentiating types of allergy intolerance codes. This valueset supports the Belgian federal FHIR profiling effort.

ValueSet/be-causativeagent

Codes as communicated by NIHDI and the FPS Terminology Center differentiating types of causative agent. This valueset supports the Belgian federal FHIR profiling effort.

ValueSet/be-civilstate

Codes supported by eHealth Platform differentiating types of civil state. This valueset supports the Belgian federal FHIR profiling effort. Whenever possible add a code from http://terminology.hl7.org/CodeSystem/v3-MaritalStatus for international interoperability but also use https://www.ehealth.fgov.be/standards/fhir/CodeSystem/CD-CIVILSTATE for the Belgian specific code.

ValueSet/be-contactperson

Maximum valuest to define category of a contact person, using the HL7 values and the Belgian CD-CONTACT-PERSON values.

ValueSet/be-exposureroute

Codes to illustrate differentiating types of exposure route. This valueset supports the Belgian federal FHIR profiling effort.

ValueSet/be-noallergy

Codes as communicated by the FOD Terminology Center differentiating types of no allergies. This valueset supports the Belgian federal FHIR profiling effort.

ValueSet product or service

NIHDI codes for use to describe eAgreement products or services in the MyCareNet eAgreement flows.

ValueSet/be-riskmanifestation

Codes as communicated by NIHDI and the FPS Terminology Center differentiating types of risk manifestation. This valueset supports the Belgian federal FHIR profiling effort.

Addiction Category

Addiction Category. No Belgian standardized valueset is yet defined, this is expected for a future iteration. Implementers are encouraged to use a codification system of their choosing.

Addiction Code

Addiction code. No Belgian standardized valueset is yet defined, this is expected for a future iteration. Implementers are encouraged to use a codification system of their choosing.

Body Site

Body Site

Care Location Value Set

Care Location Value Set

ValueSet/be-vs-diarytopic

Codes supported by eHealth Platform differentiating types of communication topics.

Laterality

Laterality

Patient Will Category

Patient will category Value Set

Patient Will code Value Set

Patient Will code Value Set

Problem Category

Problem Category

Problem Code

Problem Code. No Belgian standardized valueset is yet defined, this is expected for a future iteration. Implementers are encouraged to use a codification system of their choosing.

Problem Origin Type

Problem Origin Type

Score Value Set

Codes as defined by the NIHDI. Dutch translations are expected for a next release.

Score Category Value Set

Score Category Value Set

Vaccine Administration Route

Vaccine Administration Route

Vaccination status Value Set

Vaccination status Value Set

Vaccination status reason Value Set

Vaccination status reason Value Set - the reasons for an vaccination status - typically representing the reason why a vaccination is not performed

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide

CodeSystem Albert

This code system is to identify Albert code

Body Site CodeSystem

Body Site CodeSystem

Care Location Code System

Care Location Code System

Diary Topic Code Sytem

Diary and Communication Topics

Patient Will Category CodeSystem

Patient Will Category CodeSystem

Patient Will Directive CodeSystem

Patient Will Directive CodeSystem. Codes as defined by the NIHDI.

Problem Category

Problem Category

Problem Origin Type

Problem Origin Type

Score Category

Score Category

Score Code System

Codes as defined initially by the NIHDI. Dutch translations were not yet defined but are planned for a next release.

Vaccine Administration Route

Vaccine Administration Route

Vaccination status Code System.

Vaccination status Code System.

Vaccination status reason Code System.

Vaccination reason status Code System.

CivilState

Civil state in Belgium.

ContactPerson

Contact person in Belgium.

CodeSystem CD-FED-COUNTRY

FedICT country codes.

CodeSystem/cd-hcparty

healthcare party in Belgium.

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming to this implementation guide

NamingSystem/be-ns-cnk-codes

Naming System - CNK Product Codes

NamingSystem/be-ns-cti-extended-code

Naming System - CTI Extended Codes

NamingSystem/be-ns-nihdi-organization

Naming System - Nihdi - Organization

NamingSystem/be-ns-nihdi-professional

Naming System - Nihdi - Professional

NamingSystem/be-ns-one-vaccination

Naming System - ONE Vaccination

NamingSystem/be-ns-product-manufacturer

Naming System - Product Manufacturers

NamingSystem/be-cbe

BCE/KBO

NamingSystem/be-ehp

EHP

NamingSystem/be-insurancenumber

insurance number

NamingSystem/be-insurancymembership

Membership number of a patient with an insurance organization

NamingSystem/be-nihdi

RIZIV/INAMI

NamingSystem/be-ssin

NISS/INSZ

NamingSystem/be-uhmep

UHMEP naming system