MedMij FHIR Implementation Guide: BgZ
Draft version for the BgZ patient correction use case - not suitable for implementation.
- 1 Introduction
- 2 Actors involved
- 3 Boundaries and Relationships
- 4 Use cases
- 5 List of profiles
- 6 Release notes
The program ‘Registratie aan de bron’ (Clinical documentation at the point of care) has defined Health and Care Information models (HCIMs (English) or zibs (Dutch)) for The Netherlands. Next to these HCIMs, the program ‘Registratie aan de bron’ also made a selection of these HCIMs into the so-called ‘Basisgegevensset Zorg’ (Common Clinical Dataset, a Dutch version of a ‘patient summary’, further referred to as ‘BgZ’). The BgZ serves as a minimal healthcare dataset that is always appropriate for caregivers in order to provide continuity of care for a patient and can be seen as a representation of a patient summary.
A subselection of the published HCIMs release 2017 constitute the BgZ 2017. The BgZ makes a subselection of the information concepts within the HCIMs or restricts the HCIMs to a certain category. For example, only include the general practitioner of the patient or only the last known value of 'X'. MedMij created FHIR profiles that represent these HCIMs completely if no existing and usable profiles were available. The profiles represent their entire respective HCIM, to make them applicable in a broader context than a patient summary or even the MedMij context. An overview of the profiles can be found at the list of profiles.
The patient journey of Thomas van Beek, provides a patients context for exchanging a patient summary from a healthcare provider's system (XIS) to a personal health record (PHR). MedMij created a functional design of the BgZ use case. This use case consists of enabling a patient to view his own BgZ in a PHR. This page will elaborate further on the HL7 FHIR details needed to exchange the BgZ information using FHIR.
Note: This implementation guide builds on the general guidelines described in the use case overarching principles.
2 Actors involved
|Actors||Systems||FHIR Capability Statements|
|Patient||The user of a personal healthcare environment.||PHR||Personal health record||CapabilityStatement: Client||FHIR Client requirements|
|Healthcare professional||The user of a XIS||XIS||Healthcare information system||CapabilityStatement: Server||FHIR Server requirements|
3 Boundaries and Relationships
The BgZ 2017 v1.1 use case follows the BgZ v1.0 use case. The difference between the two is the underlying HCIMs, which have been upgraded from release 2015 to release 2017. The changes are documented in a release notes document.
The BgZ use case has similarities and differences with other use cases such as Medication Process, Vital Signs and Lab Results. These use cases use the same HCIM based FHIR profiles for exchanging information. The BgZ use case covers practically all profiles included in the other use cases. However, the BgZ differs in the scope of the actual health information content that should be exchanged. For example, the BgZ conveys only the last known lab result of each type while the Lab Results use case may cover all known information.
4 Use cases
This FHIR implementation guide assumes that the PHR system is able to make a connection to the right XIS that contains the patient's information. It does not provide information on finding the right XIS nor does it provide information about security. Moreover, each transaction is performed in the context of a specific authenticated patient, for whose context (token) has been established using the authentication mechanisms described in the 'Afsprakenstelsel'. Each XIS Gateway is required to perform filtering based on the patient associated with the context for the request, so only the records associated with the authenticated patient are returned. For this reason, search parameters should not be included for patient identification.
4.1 Use case 1: Retrieve BgZ information in PHR
4.1.1 PHR: request message
The PHR system requests the BgZ using individual search interactions. The BgZ consists of multiple FHIR resources with certain constraints. To obtain the patient's BgZ, the client can use multiple individual search operations based on specified search queries. The interactions are performed by an HTTP GET as shown:
The table below shows in the first four columns the BgZ sections, the HCIMs that constitute those sections and the specific content of the BgZ. The last column shows the FHIR search queries to obtain the BgZ information. These queries and expected responses are based on profiles listed in this section.
|#||BgZ Section||HCIM EN||Content||Search URL|
|1||Patient information||Patient||Identification, birth date, gender, deceased indicator, contact details, last known marital status, and general practitioner (practitioner or organization)|
|2||Payment details||Payer||Insurance information|
|3||Treatment directives||TreatmentDirective||Known treatment directives|
|AdvanceDirective||Known advance directives|
|4||Contact persons||ContactPerson||First relation/contact|
|5||Functional status||FunctionalOrMentalStatus||Last known functional / mental status|
|6||Problems||Concern||All known problems|
|7||Social history||LivingSituation||Current living situation|
|DrugUse||All known drug use|
|AlcoholUse||All known alcohol use|
|TobaccoUse||All known tobacco use|
|NutritionAdvice||All known current dietary recommendations|
|8||Alerts||Alert||All known alerts|
|9||Allergies||AllergyIntolerance||All known information regarding allergies|
|10||Medication||MedicationUse||Known medication use|
|MedicationAgreement||Known medication agreements|
|AdministrationAgreement||Known administration agreements|
|11||Medical aids||MedicalDevice||Known medical aids|
|13||Vital signs||BloodPressure||Last known blood pressure|
|BodyWeight||Last known body weight|
|BodyHeight||Last known body height|
|14||Results||LaboratoryTestResult||Last known laboratory results per type|
|15||Procedures||Procedure||Known surgical procedures|
|16||Encounters||Contact||Known hospital admissions (no outpatient contacts)|
|17||Planned care||PlannedCareActivityForTransfer||Known planned care activities|
|18||General practitioner||HealthProfessional||General Practitioner of the patient|
- See Search URLs and search parameters for the interpretation of these search URLs
4.1.2 XIS: response message
The returned data to the PHR should conform to the profiles listed in #List_of_profiles.
The following operation is needed for this use case.
lastn query meets the common need for searching for the most recent or last n=number of observations for a subject. For example, retrieving the last 5 temperatures for a patient to view trends or fetching the most recent laboratory results or vital signs. The link will provide more detailed information and examples regarding this operation.
The FHIR STU3 specification is vague regarding the sorting mechanism of
lastn. In FHIR R4 however, this has been clarified and can be read as follows: when using
effective[x] element is used for sorting of Observations, sorted from most recent to the oldest.
4.2 Use case 2: Send patient correction request on BgZ information from PHR
In this use case the patient wishes to communicate information the patient wants to see corrected in a BgZ registration. It is assumed the PHR Client "knows" where the information is sourced and which XIS needs to recieve the correction request. Note:This use case will be based on the FHIR version R4, due to its more mature nature and to be future proof.
The requirements for the communication resource are specified using the "TO DO: ADD PROFILE" profile. This profile SHALL be used for the use case. In this use case the communication resource will contain 4 mandatory elements to populate by the sending Client.
- .subject: Will always be populated by the patient the request applies to
- .sent: It is import for the recieving XIS to be able to discern in which order requests were sent.
- .recipient: If the practitioner is known the practitionr reference SHALL be used, otherwise a reference to organisation SHALL be used.
- .sender: Dictates that the communication is created and send by the patient.
4.2.2 PHR: send message
The initial correction request is performed by sending a Communucation resource from the PHR Client to the recieving XIS. This interaction are performed by an HTTP POST as shown:
The communication resource will contain the patient for who this request applies to, the recipient, the sender and the request itself modeled on the .payload element. See <Profile communcation resource>
4.2.3 XIS: response message
The recieving XIS is expected to send an 200 OK HTTP Response when the request is correctly recieved and return the created Communication with id.
4.2.4 State Machine
5 List of profiles
The profiles represent their entire respective HCIM, to make them applicable in a broader context than the exchange of BgZ or a MedMij context. An example of reuse of existing profiles is those of the patient administration resources and vital signs.
MedMij uses the FHIR Packaging mechanism. This conveniently bundles all profiles, terminology, example material and other conformance resources you need into a single archive, which can be downloaded or installed using the appropriate FHIR tooling. This version of the information standard uses the following packages:
Note: packages use Semantic Versioning. Other versions can be used at will as long as they have the same major.minor number or a minor number higher than the stated version.
6 Release notes
Release notes can be found on the functional design page.