MedMij:V2020.01/FHIR BGLZ: verschil tussen versies
(HOTFIX: Add package scope to Simplifier references) |
k (Beveiligde "MedMij:V2020.01/FHIR BGLZ": Protect production page from accidental edits ([Bewerken=Alleen beheerders toestaan] (vervalt niet) [Hernoemen=Alleen beheerders toestaan] (vervalt niet))) |
||
| (23 tussenliggende versies door 5 gebruikers niet weergegeven) | |||
| Regel 1: | Regel 1: | ||
__NUMBEREDHEADINGS__ | __NUMBEREDHEADINGS__ | ||
| − | {{DISPLAYTITLE:MedMij FHIR Implementation Guide: BgLZ {{VersieInfo|BgLZ | + | {{DISPLAYTITLE:MedMij FHIR Implementation Guide: BgLZ {{VersieInfo|BgLZ}}}} |
| − | {{MedMij: | + | {{MedMij:V2020.01/Issuebox_FHIR_IG}} |
| + | {{NoteBox|1= As of 01-12-2021 this version (2020.01) is no longer in use for MedMij and will no longer be qualified upon. For the currently supported version please visit [[MedMij:V2020.02/FHIR_IG]].}} | ||
[[Bestand:MedMij2.png |link=https://www.medmij.nl/|rechts|Naar medmij.nl]] | [[Bestand:MedMij2.png |link=https://www.medmij.nl/|rechts|Naar medmij.nl]] | ||
[[Bestand:BgLZ-icon.png |link=|links|90px|Use case BgZ 2017|Patient Summary (BgZ)]] | [[Bestand:BgLZ-icon.png |link=|links|90px|Use case BgZ 2017|Patient Summary (BgZ)]] | ||
<imagemap>Bestand:Leeswijzer-technisch-banner 03 white.png|center|400px|alt=Afspraken-Functioneel-Technisch | <imagemap>Bestand:Leeswijzer-technisch-banner 03 white.png|center|400px|alt=Afspraken-Functioneel-Technisch | ||
circle 241 216 211 [https://www.medmij.nl/afsprakenstelsel Afsprakenstelsel] | circle 241 216 211 [https://www.medmij.nl/afsprakenstelsel Afsprakenstelsel] | ||
| − | circle 1013 224 212 [[MedMij: | + | circle 1013 224 212 [[MedMij:V2020.01/OntwerpLangdurigeZorg|Functioneel]] |
| − | circle 1787 230 212 [[MedMij: | + | circle 1787 230 212 [[MedMij:V2020.01/FHIR_IG|Technisch]] |
desc none | desc none | ||
</imagemap> | </imagemap> | ||
| Regel 15: | Regel 16: | ||
=Introduction= | =Introduction= | ||
| − | [[Bestand:Functioneel-02.png|link=MedMij: | + | [[Bestand:Functioneel-02.png|link=MedMij:V2020.01/Ontwerpen |100px|rechts|Functional design|Go to functional design]] |
| − | This page provides the technical specification of the exchange of long-term healthcare information (Dutch: Basisgegevens Langdurige Zorg or BgLZ) based on a selection of Dutch Health Care Information Models. The specification is based on this [[MedMij: | + | This page provides the technical specification of the exchange of long-term healthcare information (Dutch: Basisgegevens Langdurige Zorg or BgLZ) based on a selection of Dutch Health Care Information Models. The specification is based on this [[MedMij:V2020.01/OntwerpLangdurigeZorg|functional design]]. |
| − | '''Note''': This implementation guide builds on the general guidelines described in the [[MedMij: | + | '''Note''': This implementation guide builds on the general guidelines described in the [[MedMij:V2020.01/FHIR_IG#Use case overarching principles|use case overarching principles]]. |
=Actors involved= | =Actors involved= | ||
| Regel 35: | Regel 36: | ||
|- | |- | ||
| Patient | | Patient | ||
| − | | The user of a personal healthcare | + | | The user of a personal healthcare environment. |
| PHR | | PHR | ||
| Personal health record | | Personal health record | ||
| Regel 50: | Regel 51: | ||
=Boundaries and Relationships= | =Boundaries and Relationships= | ||
| − | The BgLZ has similarities with the [[MedMij: | + | The BgLZ has similarities with the [[MedMij:V2020.01/FHIR_BGZ_2017|Basisgegevensset Zorg (BgZ)]] and [[MedMij:V2020.01/FHIR_GGZ|Basisgegevens GGZ (GGZ)]] but is definitely different. These information standards use much of the same HCIM based FHIR profiles for exchanging information. Wherever possible every attempt is made to re-use profiles. The BgLZ use case also has unique profiles compared to the aforementioned use cases, such as OutcomeOfCare. In addition, it uses a CareTeam profile without an underlying HCIM. |
| − | A second thing to note is that also the selection of requested information per HCIM may differentiate. For example, only a subset of LaboratoryResults or AllergyIntolerance is expected to be returned by a XIS. [[MedMij: | + | A second thing to note is that also the selection of requested information per HCIM may differentiate. For example, only a subset of LaboratoryResults or AllergyIntolerance is expected to be returned by a XIS. [[MedMij:V2020.01/InhoudLangdurigeZorg|This page]], which belongs to the BgLZ functional design, and related [https://decor.nictiz.nl/decor/services/RetrieveTransaction?id=2.16.840.1.113883.2.4.3.11.60.58.4.3&effectiveDate=2019-04-09T16:33:35&language=nl-NL&ui=nl-NL&format=html&hidecolumns=34567 transactions] provide details on the information that is expected to be exchanged. |
| − | Medication information is part of a good overview of patients in long-term healthcare. Retrieving medication information by a PHR is however out of scope for this information standard. A separate information standard, [[MedMij: | + | Medication information is part of a good overview of patients in long-term healthcare. Retrieving medication information by a PHR is however out of scope for this information standard. A separate information standard, [[MedMij:V2020.01/FHIR_MedicationProcess|MedicationProcess]], is intended to serve this purpose. |
=Use case: Retrieve BgLZ information= | =Use case: Retrieve BgLZ information= | ||
| Regel 87: | Regel 88: | ||
<code>GET [base]/[type]{?[parameters]}</code> | <code>GET [base]/[type]{?[parameters]}</code> | ||
| − | The table below shows in the first four columns the BgLZ sections, the HCIMs that constitute those sections and the specific content of the BgLZ. The last column shows the FHIR search queries to obtain the BgLZ information. These queries and expected responses are based on | + | The table below shows in the first four columns the BgLZ sections, the HCIMs that constitute those sections and the specific content of the BgLZ. The last column shows the FHIR search queries to obtain the BgLZ information. These queries and expected responses are based on profiles listed in [[#List_of_profiles|this section]]. |
{| class="wikitable collapsible" width="100%" style="horizontal-align: right" | {| class="wikitable collapsible" width="100%" style="horizontal-align: right" | ||
| Regel 94: | Regel 95: | ||
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:10px" | HCIM EN | !style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:10px" | HCIM EN | ||
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:10px" | Content | !style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:10px" | Content | ||
| − | !style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:10px" | Search URL<ref>See [[MedMij: | + | !style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:10px" | Search URL<ref>See [[MedMij:V2020.01/FHIR_IG#Search_URLs_and_search_parameters|Search URLs and search parameters]] for the interpretation of these search URLs</ref> |
|- | |- | ||
| 1 | | 1 | ||
| Regel 133: | Regel 134: | ||
| Results | | Results | ||
| LaboratoryTestResult | | LaboratoryTestResult | ||
| − | | A selection of | + | | A selection of information from the last known clinical laboratory results per type. The [https://decor.nictiz.nl/decor/services/RetrieveTransaction?id=2.16.840.1.113883.2.4.3.11.60.58.4.3&effectiveDate=2019-04-09T16:33:35&language=nl-NL&ui=nl-NL&format=html&hidecolumns=34567 ART-DECOR transaction] specification describes the selection. |
| <pre>GET [base]/Observation/$lastn?category=http://snomed.info/sct|275711006&_include=Observation:related-target&_include=Observation:specimen</pre> | | <pre>GET [base]/Observation/$lastn?category=http://snomed.info/sct|275711006&_include=Observation:related-target&_include=Observation:specimen</pre> | ||
|- | |- | ||
| Regel 176: | Regel 177: | ||
===XIS: response message=== | ===XIS: response message=== | ||
| − | The returned data to the PHR should conform to the profiles listed in [[# | + | The returned data to the PHR should conform to the profiles listed in [[#List_of_profiles]]. |
===The <code>lastn</code> operation=== | ===The <code>lastn</code> operation=== | ||
| Regel 193: | Regel 194: | ||
* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/careplan-medicaldevice|nictiz.fhir.nl.stu3.zib2017}} | * {{Simplifier|http://nictiz.nl/fhir/SearchParameter/careplan-medicaldevice|nictiz.fhir.nl.stu3.zib2017}} | ||
| − | ==List of | + | ==List of profiles== |
The profiles represent their entire respective HCIM, to make them applicable in a broader context than the exchange of BgLZ or a MedMij context. | The profiles represent their entire respective HCIM, to make them applicable in a broader context than the exchange of BgLZ or a MedMij context. | ||
| − | {{ | + | {{MedMij:V2020.01/NoteBoxPackage|p1=nictiz.fhir.nl.stu3.zib2017|v1Min=2.0.0}} |
{| class="wikitable" "cellpadding="10" | {| class="wikitable" "cellpadding="10" | ||
| Regel 273: | Regel 274: | ||
<blockquote>* The 2018 release of the HCIM NursingIntervention is used because the 2017 release is not suitable. The functional design page provides more information. In addition, the CarePlan resource is used to transfer the HCIM NursingIntervention. The BgLZ does not use the Procedure resource for HCIM NursingIntervention.</blockquote> | <blockquote>* The 2018 release of the HCIM NursingIntervention is used because the 2017 release is not suitable. The functional design page provides more information. In addition, the CarePlan resource is used to transfer the HCIM NursingIntervention. The BgLZ does not use the Procedure resource for HCIM NursingIntervention.</blockquote> | ||
| − | |||
| − | = | + | =Release notes= |
| − | + | Release notes can be found on the [[MedMij:V2020.01/OntwerpLangdurigeZorg#Release_notes|functional design page]]. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | {{MedMij:Sjabloon_Support}} | |
| − | |||
| − | |||
| − | |||
Huidige versie van 19 dec 2024 om 14:06
|
|
As of 01-12-2021 this version (2020.01) is no longer in use for MedMij and will no longer be qualified upon. For the currently supported version please visit MedMij:V2020.02/FHIR_IG. |
Inhoud
1 Introduction
This page provides the technical specification of the exchange of long-term healthcare information (Dutch: Basisgegevens Langdurige Zorg or BgLZ) based on a selection of Dutch Health Care Information Models. The specification is based on this functional design.
Note: This implementation guide builds on the general guidelines described in the use case overarching principles.
2 Actors involved
| Actors | Systems | FHIR Capability Statements | |||
|---|---|---|---|---|---|
| Name | Description | Name | Description | Name | Description |
| 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 BgLZ has similarities with the Basisgegevensset Zorg (BgZ) and Basisgegevens GGZ (GGZ) but is definitely different. These information standards use much of the same HCIM based FHIR profiles for exchanging information. Wherever possible every attempt is made to re-use profiles. The BgLZ use case also has unique profiles compared to the aforementioned use cases, such as OutcomeOfCare. In addition, it uses a CareTeam profile without an underlying HCIM. A second thing to note is that also the selection of requested information per HCIM may differentiate. For example, only a subset of LaboratoryResults or AllergyIntolerance is expected to be returned by a XIS. This page, which belongs to the BgLZ functional design, and related transactions provide details on the information that is expected to be exchanged.
Medication information is part of a good overview of patients in long-term healthcare. Retrieving medication information by a PHR is however out of scope for this information standard. A separate information standard, MedicationProcess, is intended to serve this purpose.
4 Use case: Retrieve BgLZ information
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 Introduction
The retrieve BgLZ transaction is used by the PHR to retrieve long-term healthcare information from a XIS.
4.2 Actors
| Transaction group | Transaction | Actor | Role |
|---|---|---|---|
| Retrieve BgLZ (PULL) | Retrieve BgLZ request | Patient (using a PHR) | Request long-term healthcare information from a XIS |
| Retrieve BgLZ response | Healthcare professional (using a XIS) | Serves long-term healthcare information to a PHR |
4.3 Invocations
4.3.1 PHR: request message
The PHR system requests the BgLZ using individual search interactions. The BgLZ consists of multiple FHIR resources with certain constraints. To obtain the patient's BgLZ, the client can use multiple individual search operations based on specified search queries. The interactions are performed by an HTTP GET as shown:
GET [base]/[type]{?[parameters]}
The table below shows in the first four columns the BgLZ sections, the HCIMs that constitute those sections and the specific content of the BgLZ. The last column shows the FHIR search queries to obtain the BgLZ information. These queries and expected responses are based on profiles listed in this section.
| # | BgLZ Section | HCIM EN | Content | Search URL[1] |
|---|---|---|---|---|
| 1 | Patient information | Patient | Identification, birthdate, gender, deceasedindicator, contact details, marital status, and general practitioner (practitioner or organization) | GET [base]/Patient?_include=Patient:general-practitioner |
| 2 | Treatment Directives | TreatmentDirective | Known treatment directives | GET [base]/Consent?category=http://snomed.info/sct|11291000146105 |
| AdvanceDirective | Known advance directives | GET [base]/Consent?category=http://snomed.info/sct|11341000146107 | ||
| 3 | Contactperson | ContactPerson | First relation/contact | see Patient in Patient.contact |
| 4 | Problems | Problem | All known problems including diagnoses; no verification status | GET [base]/Condition |
| 5 | Allergies | AllergyIntolerance | A selection of information from all known allergies and intolerances. The ART-DECOR transaction specification describes the selection. | GET [base]/AllergyIntolerance |
| 6 | Results | LaboratoryTestResult | A selection of information from the last known clinical laboratory results per type. The ART-DECOR transaction specification describes the selection. | GET [base]/Observation/$lastn?category=http://snomed.info/sct|275711006&_include=Observation:related-target&_include=Observation:specimen |
| 7 | Procedures | Procedure | All procedures | GET [base]/Procedure |
| 8 | Goals and interventions
* see the NoteBox above |
NursingIntervention | NursingInterventions beloning to active problems | GET [base]/CarePlan?_include=CarePlan:activity-goal:Goal &_include=CarePlan:activity-outcomereference:Observation &_include=CarePlan:activity-medicaldevice:DeviceUseStatement &_include:recurse=DeviceUseStatement:device:Device |
| TreatmentObjective | All treatment objectives beloning to NursingInterventions | |||
| MedicalDevice | All MedicalDevices belonging to NursingInterventions; only product type and anatomical location | |||
| OutcomeOfCare | Known treatment outcomes | |||
| 9 | Caresetting / CareTeam | HealthProfessional |
|
GET [base]/CareTeam?_include=CareTeam:participant |
| HealthcareProvider |
- ↑ See Search URLs and search parameters for the interpretation of these search URLs
4.3.2 XIS: response message
The returned data to the PHR should conform to the profiles listed in #List_of_profiles.
4.3.3 The lastn operation
The following operation is needed for this use case.
The 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 lastn, the effective[x] element is used for sorting of Observations, sorted from most recent to the oldest.
4.3.4 Custom search parameters
The following custom search parameters are defined for this use case:
- http://nictiz.nl/fhir/SearchParameter/careplan-activity-goal
- http://nictiz.nl/fhir/SearchParameter/careplan-activity-outcomereference
- http://nictiz.nl/fhir/SearchParameter/careplan-medicaldevice
4.4 List of profiles
The profiles represent their entire respective HCIM, to make them applicable in a broader context than the exchange of BgLZ or a MedMij context.
|
|
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. |
* The 2018 release of the HCIM NursingIntervention is used because the 2017 release is not suitable. The functional design page provides more information. In addition, the CarePlan resource is used to transfer the HCIM NursingIntervention. The BgLZ does not use the Procedure resource for HCIM NursingIntervention.
5 Release notes
Release notes can be found on the functional design page.
6 Support
For questions and change requests regarding the information on this page, please create a ticket in Servicedesk Portal.
