MedMij:V2019.01 FHIR BGZ 2017: verschil tussen versies

Uit informatiestandaarden
Ga naar: navigatie, zoeken
(→‎Handling errors)
k (Beveiligde "MedMij:V2019.01 FHIR BGZ 2017": Protect production page from accidental edits ([Bewerken=Alleen beheerders toestaan] (vervalt niet) [Hernoemen=Alleen beheerders toestaan] (vervalt niet)))
 
(48 tussenliggende versies door 10 gebruikers niet weergegeven)
Regel 1: Regel 1:
−
{{#customtitle:MedMij FHIR Implementation Guide: BgZ 2.1.0}}
+
{{MedMij:V2019.01_BgZ2_Uitgefaseerd}}
 +
__NUMBEREDHEADINGS__
 +
{{DISPLAYTITLE:MedMij FHIR Implementation Guide: BgZ {{VersieInfo|BgZ|release=V2019.01}}}}
 
{{MedMij:V2019.01_Issuebox_FHIR_IG}}
 
{{MedMij:V2019.01_Issuebox_FHIR_IG}}
  
Regel 16: Regel 18:
 
[[Bestand:Functioneel-02.png|link=MedMij:V2019.01_Ontwerpen |100px|rechts|Functional design|Go to functional design]]
 
[[Bestand:Functioneel-02.png|link=MedMij:V2019.01_Ontwerpen |100px|rechts|Functional design|Go to functional design]]
  
−
The program ‘Registratie aan de bron’ (Data capture at the point of Care) has defined Health and Care Information models ([https://zibs.nl/wiki/HCIM_Mainpage HCIMs] (English) or [https://zibs.nl/wiki/ZIB_Hoofdpagina 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.
+
The program ‘Registratie aan de bron’ (Clinical documentation at the point of care) has defined Health and Care Information models ([https://zibs.nl/wiki/HCIM_Mainpage HCIMs] (English) or [https://zibs.nl/wiki/ZIB_Hoofdpagina 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 [https://zibs.nl/wiki/HCIM_Release_2017(EN) HCIMs release 2017] constitute the [https://www.registratieaandebron.nl/pdf/BgZ_specificatie_obv_zibs_2017_v1.0.pdf 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 [[MedMij:V2019.01_FHIR_BGZ_2017#List_of_StructureDefinitions|list of StructureDefinitions]].  
+
A subselection of the published [https://zibs.nl/wiki/HCIM_Release_2017(EN) HCIMs release 2017] constitute the [https://www.registratieaandebron.nl/pdf/BgZ_specificatie_obv_zibs_2017_v1.1.pdf 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 [[MedMij:V2019.01_FHIR_BGZ_2017#List_of_StructureDefinitions|list of StructureDefinitions]].  
  
 
The patient journey of [https://www.nictiz.nl/ehealth/MedMij 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 [https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2019.01_Ontwerpen 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.
 
The patient journey of [https://www.nictiz.nl/ehealth/MedMij 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 [https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2019.01_Ontwerpen 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.
Regel 39: Regel 41:
 
| PHR
 
| PHR
 
| Personal health record
 
| Personal health record
−
|[[Bestand: Verwijzing.png| 20px]] [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/CapabilityStatement/bgz2017-clientcapabilities CapabilityStatement: Client]
+
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/bgz2017-clientcapabilities|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12|title=CapabilityStatement: Client}}
 
| FHIR Client requirements  
 
| FHIR Client requirements  
 
|-
 
|-
Regel 46: Regel 48:
 
| XIS
 
| XIS
 
| Healthcare information system
 
| Healthcare information system
−
|[[Bestand: Verwijzing.png| 20px]] [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/CapabilityStatement/bgz2017-servercapabilities CapabilityStatement: Server]
+
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/bgz2017-servercapabilities|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12|title=CapabilityStatement: Server}}
 
| FHIR Server requirements  
 
| FHIR Server requirements  
 
|}
 
|}
  
 
==Boundaries and Relationships==
 
==Boundaries and Relationships==
−
The BgZ 2017 use case follows the BgZ 1.0 use case. The difference between the two is the underlying HCIMs, which have been upgraded from release 2015 to release 2017.  
+
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 [https://github.com/Nictiz/Nictiz-STU3-Zib2017/raw/master/ReleaseNotes%20FHIR%20profielen%20ZIB2017.pdf release notes] document.
−
 
 
−
Release notes can be found here:https://github.com/Nictiz/Nictiz-STU3-Zib2017/raw/master/ReleaseNotes%20FHIR%20profielen%20ZIB2017.pdf
 
−
 
 
  
 
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.
 
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.
  
 
==List of invocations==
 
==List of invocations==
−
[[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |100px|Go to Afsprakenstelsel]]
+
[[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |100px|Go to MedMij Afsprakenstelsel]]
  
−
This FHIR implementation guide assumes that the PHR system is able to make a connection to the XIS that contains the patients BgZ information. It does not provide information on finding the right XIS nor does it provide information about security. These infrastructure and interface specifications are described in the [https://www.medmij.nl/afsprakenstelsel/ 'Afsprakenstelsel'].
+
This FHIR implementation guide assumes that the PHR system is able to make a connection to the XIS that contains the patients BgZ information. It does not provide information on finding the right XIS nor does it provide information about security. These infrastructure and interface specifications are described in the [https://www.medmij.nl/afsprakenstelsel/ 'MedMij Afsprakenstelsel'].
  
 
===Client - PHR===
 
===Client - PHR===
Regel 82: Regel 81:
 
| Patient information
 
| Patient information
 
| Patient
 
| Patient
−
| Identification, birthdate, gender, deceasedindicator, contact details, marital status, and general practitioner (practitioner or organization)
+
| Identification, birth date, gender, deceased indicator, contact details, last known marital status, and general practitioner (practitioner or organization)
 
| <pre>GET [base]/Patient?_include=Patient:general-practitioner</pre>
 
| <pre>GET [base]/Patient?_include=Patient:general-practitioner</pre>
 
|-
 
|-
Regel 92: Regel 91:
 
|-
 
|-
 
| rowspan="2" | 3
 
| rowspan="2" | 3
−
| rowspan="2" | Treatment Directives
+
| rowspan="2" | Treatment directives
 
| TreatmentDirective
 
| TreatmentDirective
 
| Known treatment directives
 
| Known treatment directives
Regel 102: Regel 101:
 
|-
 
|-
 
| 4
 
| 4
−
| Contactperson
+
| Contact persons
 
| ContactPerson
 
| ContactPerson
 
| First relation/contact
 
| First relation/contact
Regel 170: Regel 169:
 
| Medical aids
 
| Medical aids
 
| MedicalAid
 
| MedicalAid
−
| All known medical aids
+
| Known medical aids
 
| <pre>GET [base]/DeviceUseStatement?_include=DeviceUseStatement:device</pre>
 
| <pre>GET [base]/DeviceUseStatement?_include=DeviceUseStatement:device</pre>
 
|-
 
|-
Regel 176: Regel 175:
 
| Vaccinations
 
| Vaccinations
 
| Vaccination
 
| Vaccination
−
| All known vaccinations
+
| Known vaccinations
 
| <pre>GET [base]/Immunization?status=completed</pre>
 
| <pre>GET [base]/Immunization?status=completed</pre>
 
|-
 
|-
Regel 202: Regel 201:
 
| Procedures
 
| Procedures
 
| Procedure
 
| Procedure
−
| All surgical procedures
+
| Known surgical procedures
 
| <pre>GET [base]/Procedure?category=http://snomed.info/sct|387713003</pre>
 
| <pre>GET [base]/Procedure?category=http://snomed.info/sct|387713003</pre>
 
|-
 
|-
Regel 208: Regel 207:
 
| Encounters
 
| Encounters
 
| Contact
 
| Contact
−
| All hospital admissions (no outpatient contacts)
+
| Known hospital admissions (no outpatient contacts)
 
| <pre>GET [base]/Encounter?class=http://hl7.org/fhir/v3/ActCode|IMP,http://hl7.org/fhir/v3/ActCode|ACUTE,http://hl7.org/fhir/v3/ActCode|NONAC</pre>
 
| <pre>GET [base]/Encounter?class=http://hl7.org/fhir/v3/ActCode|IMP,http://hl7.org/fhir/v3/ActCode|ACUTE,http://hl7.org/fhir/v3/ActCode|NONAC</pre>
 
|-
 
|-
−
| rowspan="5" | 17
+
| 17
−
| rowspan="5" | Planned care
+
| Planned care
−
| rowspan="5" | PlannedCareActivity
+
| PlannedCareActivityForTransfer
−
| rowspan="5" | All known planned care activities <nowiki>[</nowiki> [[#MM-115|*]] <nowiki>]</nowiki>
+
| Known planned care activities
−
| <pre>GET [base]/ProcedureRequest?status=active</pre>
+
| <span id="PlannedCareRemark"></span>{{NoteBox|The HCIM PlannedCareActivityForTransfer represents a planned activity as a (reference to) the HCIM for that activity in the 'planned' status. However, FHIR doesn't recognize this status; instead it uses dedicated resources for planning. Therefore, the FHIR implementation of this HCIM uses these dedicated resources instead of a distinct profile::
−
|-
+
 
−
| <pre>GET [base]/ImmunizationRecommendation</pre>
+
*Planning an Encounter is done by using an Appointment
−
|-
+
*Planning a Procedure is done by using a ProcedureRequest
−
| <pre style="text-decoration: line-through;">GET [base]/MedicationDispense?category=http://snomed.info/sct|422037009&status=in-progress,preparation&_include=MedicationDispense:medication</pre>
+
*Planning a Vaccination is done by using a VaccinationRecommendation 
−
|-
+
*Planning a MedicalDevice is done by using a MedicalDeviceRequest
−
| <pre>GET [base]/DeviceRequest?status=active&_include=DeviceRequest:device</pre>
+
}}
−
|-
+
<pre>GET [base]/ProcedureRequest?status=active</pre>
−
| <pre>GET [base]/Appointment?status=booked,pending,proposed</pre>
+
<pre>GET [base]/ImmunizationRecommendation</pre>
 +
<pre style="text-decoration: line-through;">GET [base]/MedicationDispense?category=http://snomed.info/sct|422037009&status=in-progress,preparation&_include=MedicationDispense:medication</pre>
 +
<span id="MM115Remark"></span>{{NoteBox|PlannedCareActivityForTransfer for MedicationAdministration was found unimplementable as-is. Presumed solution will come from a future HCIM release. See [https://bits.nictiz.nl/browse/MM-115 MM-115] for more information.}}
 +
<pre>GET [base]/DeviceRequest?status=active&_include=DeviceRequest:device</pre>
 +
<pre>GET [base]/Appointment?status=booked,pending,proposed</pre>
 
|-
 
|-
 
| 18
 
| 18
Regel 231: Regel 234:
 
| <pre style="font-style: italic;">see Patient</pre>
 
| <pre style="font-style: italic;">see Patient</pre>
 
|}
 
|}
 +
{{Sjabloon:Voorbeelden}}
  
 
===Server - XIS===
 
===Server - XIS===
−
Important sections of the FHIR specification for a server in this use case are the [http://hl7.org/fhir/STU3/http.html#2.21.0 RESTful API section] the [http://hl7.org/fhir/STU3/search.html search section] and [http://hl7.org/fhir/STU3/operations.html operation section] (for the nlast operation).
+
Important sections of the FHIR specification for a server in this use case are the [http://hl7.org/fhir/STU3/http.html#2.21.0 RESTful API section] the [http://hl7.org/fhir/STU3/search.html search section] and [http://hl7.org/fhir/STU3/operations.html operation section] (for the lastn operation).
  
 
====Response to resource requests====
 
====Response to resource requests====
Regel 298: Regel 302:
 
Search result parameters:
 
Search result parameters:
 
* [http://hl7.org/fhir/STU3/search.html#include _include]
 
* [http://hl7.org/fhir/STU3/search.html#include _include]
−
* [http://hl7.org/fhir/STU3/search.html#include _revinclude]
 
  
 
==List of StructureDefinitions==
 
==List of StructureDefinitions==
−
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 are those of the patient administration resources and vital signs.
+
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.
  
−
{{NoteBoxPackage|https://simplifier.net/packages/nictiz.fhir.nl.stu3.zib2017/1.1.0|1.1.0|MedMij:V2019.01_FHIR_IG}}
+
{{NoteBoxPackage|https://simplifier.net/NictizSTU3-Zib2017/~packages|1.3.x|MedMij:V2019.01_FHIR_IG}}
  
 
{| class="wikitable" style="horizontal-align: right"  
 
{| class="wikitable" style="horizontal-align: right"  
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:10px"  | Section
+
!style="background-color: #1F497D; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:10px"  | Section
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:100px" | ZIB NL
+
!style="background-color: #1F497D; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:100px" | Zib NL
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:100px" | HCIM EN
+
!style="background-color: #1F497D; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:100px" | HCIM EN
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:100px" | FHIR Resource
+
!style="background-color: #1F497D; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:100px" | FHIR Resource
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:400px" | FHIR Profile
+
!style="background-color: #1F497D; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:400px" | FHIR Profile
 
|-
 
|-
−
| 01
+
| 1
 
| Patient
 
| Patient
−
| #ZIB Patient|Patient
+
| #Zib Patient|Patient
 
| Patient
 
| Patient
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-patient http://fhir.nl/fhir/StructureDefinition/nl-core-patient]
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
−
| rowspan="3" |02
+
| rowspan="3" |2
 
| rowspan="3" | Betaler
 
| rowspan="3" | Betaler
 
| rowspan="3" | Payer
 
| rowspan="3" | Payer
 
| Coverage
 
| Coverage
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Payer http://nictiz.nl/fhir/StructureDefinition/zib-Payer]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Payer|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| Organization
 
| Organization
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-organization http://fhir.nl/fhir/StructureDefinition/nl-core-organization]
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| Patient
 
| Patient
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-patient http://fhir.nl/fhir/StructureDefinition/nl-core-patient]
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
−
| rowspan="2" |03
+
| rowspan="2" |3
 
| BehandelAanwijzing
 
| BehandelAanwijzing
 
| TreatmentDirective
 
| TreatmentDirective
 
| Consent
 
| Consent
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| Wilsverklaring
 
| Wilsverklaring
 
| AdvanceDirective
 
| AdvanceDirective
 
| Consent
 
| Consent
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
−
| 04
+
| 4
 
| Contactpersoon
 
| Contactpersoon
 
| ContactPerson
 
| ContactPerson
 
| Patient.contact
 
| Patient.contact
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-patient http://fhir.nl/fhir/StructureDefinition/nl-core-patient]
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
−
| 05
+
| 5
 
| Funct. OfMentaleStatus
 
| Funct. OfMentaleStatus
 
| FunctionalOrMentalStatus
 
| FunctionalOrMentalStatus
 
| Observation
 
| Observation
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-FunctionalOrMentalStatus http://nictiz.nl/fhir/StructureDefinition/zib-FunctionalOrMentalStatus]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-FunctionalOrMentalStatus|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
−
| 06
+
| 6
 
| Probleem
 
| Probleem
 
| Problem
 
| Problem
 
| Condition
 
| Condition
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Problem http://nictiz.nl/fhir/StructureDefinition/zib-Problem]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Problem|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
−
| rowspan="5" | 07
+
| rowspan="5" | 7
 
| Woonsituatie
 
| Woonsituatie
 
| LivingSituation
 
| LivingSituation
 
| Observation
 
| Observation
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| DrugsGebruik
 
| DrugsGebruik
 
| DrugUse
 
| DrugUse
 
| Observation
 
| Observation
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-DrugUse http://nictiz.nl/fhir/StructureDefinition/zib-DrugUse]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-DrugUse|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| AlcoholGebruik
 
| AlcoholGebruik
 
| AlcoholUse
 
| AlcoholUse
 
| Observation
 
| Observation
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-AlcoholUse http://nictiz.nl/fhir/StructureDefinition/zib-AlcoholUse]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-AlcoholUse|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| TabakGebruik
 
| TabakGebruik
 
| TobaccoUse
 
| TobaccoUse
 
| Observation
 
| Observation
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-TobaccoUse http://nictiz.nl/fhir/StructureDefinition/zib-TobaccoUse]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-TobaccoUse|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| Voedingsadvies
 
| Voedingsadvies
 
| NutritionAdvice
 
| NutritionAdvice
 
| NutritionOrder
 
| NutritionOrder
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-NutritionAdvice http://nictiz.nl/fhir/StructureDefinition/zib-NutritionAdvice]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-NutritionAdvice|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
−
| 08
+
| 8
 
| Alert
 
| Alert
 
| Alert
 
| Alert
 
| Flag
 
| Flag
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Alert http://nictiz.nl/fhir/StructureDefinition/zib-Alert]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Alert|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
−
| 09
+
| 9
 
| AllergieIntolerantie
 
| AllergieIntolerantie
 
| AllergyIntolerance
 
| AllergyIntolerance
 
| AllergyIntolerance
 
| AllergyIntolerance
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| rowspan="3" | 10  
 
| rowspan="3" | 10  
Regel 401: Regel 404:
 
| MedicationUse
 
| MedicationUse
 
| MedicationStatement
 
| MedicationStatement
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| MedicationAgreement
 
| MedicationAgreement
 
| MedicationRequest
 
| MedicationRequest
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAgreement http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAgreement]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAgreement|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| AdministrationAgreement
 
| AdministrationAgreement
 
| MedicationDispense
 
| MedicationDispense
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| rowspan="2" | 11  
 
| rowspan="2" | 11  
Regel 415: Regel 418:
 
| rowspan="2" | MedicalDevice
 
| rowspan="2" | MedicalDevice
 
| Device
 
| Device
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDeviceProduct http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDeviceProduct]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDeviceProduct|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| DeviceUseStatement
 
| DeviceUseStatement
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| rowspan="2" | 12  
 
| rowspan="2" | 12  
Regel 424: Regel 427:
 
| rowspan="2" | Vaccination
 
| rowspan="2" | Vaccination
 
| Immunization
 
| Immunization
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Vaccination http://nictiz.nl/fhir/StructureDefinition/zib-Vaccination]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Vaccination|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| ImmunizationRecommendation
 
| ImmunizationRecommendation
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| rowspan="3" | 13
 
| rowspan="3" | 13
Regel 433: Regel 436:
 
| BloodPressure
 
| BloodPressure
 
| Observation
 
| Observation
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-BloodPressure http://nictiz.nl/fhir/StructureDefinition/zib-BloodPressure]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-BloodPressure|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| LichaamsGewicht
 
| LichaamsGewicht
 
| BodyWeight
 
| BodyWeight
 
| Observation
 
| Observation
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-BodyWeight http://nictiz.nl/fhir/StructureDefinition/zib-BodyWeight]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-BodyWeight|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| LichaamsLengte
 
| LichaamsLengte
 
| BodyHeight
 
| BodyHeight
 
| Observation
 
| Observation
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-BodyHeight http://nictiz.nl/fhir/StructureDefinition/zib-BodyHeight]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-BodyHeight|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| rowspan="2" | 14
 
| rowspan="2" | 14
Regel 449: Regel 452:
 
| rowspan="2" | LaboratoryTestResult
 
| rowspan="2" | LaboratoryTestResult
 
| Observation
 
| Observation
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| Specimen
 
| Specimen
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Specimen http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Specimen]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Specimen|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| 15  
 
| 15  
Regel 458: Regel 461:
 
| Procedure
 
| Procedure
 
| Procedure
 
| Procedure
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Procedure http://nictiz.nl/fhir/StructureDefinition/zib-Procedure]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Procedure|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| 16  
 
| 16  
Regel 464: Regel 467:
 
| Encounter
 
| Encounter
 
| Encounter
 
| Encounter
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Encounter http://nictiz.nl/fhir/StructureDefinition/zib-Encounter]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Encounter|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| rowspan="5" | 17  
 
| rowspan="5" | 17  
−
| rowspan="5" | GeplandeZorgActiviteit
+
| rowspan="5" | OverdrachtGeplandeZorgActiviteit
−
| rowspan="5" | PlannedCareActivity
+
| rowspan="5" | PlannedCareActivityForTransfer
−
| ProcedureRequest
+
| ProcedureRequest [[#PlannedCareRemark|*]]
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-ProcedureRequest http://nictiz.nl/fhir/StructureDefinition/zib-ProcedureRequest]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-ProcedureRequest|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
−
| <span style="text-decoration: line-through;">MedicationDispense</span> <nowiki>[</nowiki> [[#MM-115|*]] <nowiki>]</nowiki>
+
| <span style="text-decoration: line-through;">MedicationDispense</span> [[#MM115Remark|**]]
−
| <span style="text-decoration: line-through;">[https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement]</span>
+
| <span style="text-decoration: line-through;">{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}</span>
 
|-
 
|-
−
| ImmunizationRecommendation
+
| ImmunizationRecommendation [[#PlannedCareRemark|*]]
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
−
| DeviceRequest
+
| DeviceRequest [[#PlannedCareRemark|*]]
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDeviceRequest http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDeviceRequest]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDeviceRequest|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
−
| Appointment
+
| Appointment [[#PlannedCareRemark|*]]
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment]
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| rowspan="3" | 18
 
| rowspan="3" | 18
Regel 488: Regel 491:
 
| rowspan="2" | HealthProfessional
 
| rowspan="2" | HealthProfessional
 
| Practitioner
 
| Practitioner
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner]
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| PractitionerRole
 
| PractitionerRole
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole]
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|-
 
|-
 
| Zorgaanbieder
 
| Zorgaanbieder
 
| HealthcareProvider
 
| HealthcareProvider
 
| Organization
 
| Organization
−
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-organization http://fhir.nl/fhir/StructureDefinition/nl-core-organization]
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
 
|}
 
|}
  
 
==Terminology, NamingSystems, Mappings==
 
==Terminology, NamingSystems, Mappings==
 +
{{MedMij:V2019.01_Template_Terminologies_NamingSystems_Mappings|id1=List_of_StructureDefinitions|t1=List of StructureDefinitions}}
  
−
===Terminology===
+
=Release notes=
−
Relevant value sets can be found [https://simplifier.net/NictizSTU3-Zib2017/~resources?category=ValueSet using the ValueSet category]. All resources can be downloaded in a .zip in XML or JSON format. In the .zip, the value sets are stored in the directory 'value sets'.
 
−
 
 
−
===NamingSystems===
 
−
Relevant NamingSystems can be found [https://simplifier.net/NictizSTU3-Zib2017/~resources?category=NamingSystem using the NamingSystem category].
 
−
 
 
−
===Mappings===
 
−
Relevant HCIM to FHIR value set mappings can be found [https://simplifier.net/NictizSTU3-Zib2017/~resources?category=ConceptMap using the ConceptMap category].
 
−
All profiles include HCIM mappings. HCIM concepts are mapped to the corresponding FHIR elements using the HCIMs concept id. The top of the StructureDefinition contains meta information regarding the HCIM mapping, such as the name and uri of the HCIM. In the StructureDefinition elements, the corresponding HCIM ID is given including the mapping meta information id. This is illustrated in the following example.
 
−
 
 
−
<pre>
 
−
<StructureDefinition>
 
−
    <id value="nl-core-patient" />
 
−
    .....
 
−
    <mapping>
 
−
        <identity value="hcim-patient-v3.1-2017EN"/>
 
−
        <uri value="https://zibs.nl/wiki/Patient-v3.1(2017EN)"/>
 
−
        <name value="HCIM Patient-v3.1(2017EN)"/>
 
−
    </mapping>
 
−
    .....
 
−
        <element id="Patient.name">
 
−
            <path value="Patient.name" />
 
−
            <short value="NameInformation" />
 
−
            <alias value="Naamgegevens" />
 
−
            <type>
 
−
                <code value="HumanName" />
 
−
                <profile value="http://fhir.nl/fhir/StructureDefinition/nl-core-humanname" />
 
−
            </type>
 
−
            <mapping>
 
−
                <identity value="hcim-patient-v3.1-2017EN"/>
 
−
                <map value="NL-CM:0.1.6"/>
 
−
            </mapping>
 
−
        </element>
 
−
    .....
 
−
</StructureDefinition>
 
−
</pre>
 
−
 
 
−
=Annex: Document history=
 
−
==Release notes==
 
 
Release notes can be found on the [[MedMij:V2019.01_OntwerpBGZ_2017#Release_notes|functional design page]].
 
Release notes can be found on the [[MedMij:V2019.01_OntwerpBGZ_2017#Release_notes|functional design page]].
−
 
+
{{EindUitgefaseerd}}
−
==History==
 
−
{| class="wikitable" "cellpadding="10"
 
−
!style="text-align:left;"|Release
 
−
!style="text-align:left;"|Date
 
−
!style="text-align:left;"|Description
 
−
|-
 
−
| style="background-color: white;"| <span id="MM-115">2019.01</span>
 
−
| style="background-color: white;"| 11-03-2019
 
−
| style="background-color: white;"| '''*''' [https://bits.nictiz.nl/browse/MM-115 MM-115] Solved inconsistency in the List of StructureDefinitions. Also we will no longer check PlannedCareActivityForTransfer for MedicationAdministration in section 17 Zorgplan, because we found it was unimplementable as-is. Presumed solution will come from a future HCIM release
 
−
|-
 
−
| style="background-color: white;"| 2019.01
 
−
| style="background-color: white;"| 11-03-2019
 
−
| style="background-color: white;"|
 
−
*Publication of changes in version 2019.01, conform release notes
 
−
*Moved release notes to functional design page
 
−
|-
 
−
| style="background-color: white;"| 2018.06
 
−
| style="background-color: white;"| 18-10-2018
 
−
| style="background-color: white;"| Corrected SNOMED code in search url for FunctionalOrMantalStatus
 
−
|-
 
−
| style="background-color: white;"| 2018.06
 
−
| style="background-color: white;"| 15-10-2018
 
−
| style="background-color: white;"| Added version in title, and document history
 
−
|}
 
−
[[categorie:MedMij FHIR Use Cases]]
 

Huidige versie van 25 mrt 2024 om 21:16

Icoon Nictiz Cirkel Informatie Grafiet.svg

Deze versie van de informatiestandaard is per 1-7-2022 uitgefaseerd. Zie de MedMij-overzichtspagina voor de actuele versies van de MedMij-informatiestandaarden.

This version of this information standard has been deprecated as of 1-7-2022. Consult the MedMij overview page for the current versions of MedMij information standards.



Naar medmij.nl
Patient Summary (BgZ)
AfsprakenstelselFunctioneelTechnischAfspraken-Functioneel-Technisch

1 Introduction

Go to functional design

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

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.

2 Actors involved

Actors Systems FHIR Capability Statements
Name Description Name Description Name Description
Patient The user of a personal healthcare enviorment. PHR Personal health record Verwijzing.png CapabilityStatement: Client FHIR Client requirements
Healthcare professional The user of a XIS XIS Healthcare information system Verwijzing.png 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 List of invocations

Go to MedMij Afsprakenstelsel

This FHIR implementation guide assumes that the PHR system is able to make a connection to the XIS that contains the patients BgZ information. It does not provide information on finding the right XIS nor does it provide information about security. These infrastructure and interface specifications are described in the 'MedMij Afsprakenstelsel'.

4.1 Client - PHR

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 interaction can be performed by an HTTP GET or command as shown:

GET [base]/[type]/{?[parameters]{&_format=[mime-type]}}

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 are based on StructureDefinitions listed in this section.

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.

# BgZ Section HCIM EN Content Example Search URL
1 Patient information Patient Identification, birth date, gender, deceased indicator, contact details, last known marital status, and general practitioner (practitioner or organization) 
GET [base]/Patient?_include=Patient:general-practitioner
2 Payment details Payer Insurance information 
GET [base]/Coverage?_include=Coverage:payor:Patient&_include=Coverage:payor:Organization
3 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
4 Contact persons ContactPerson First relation/contact 
see Patient
5 Functional status FunctionalOrMentalStatus Last known functional / mental status 
GET [base]/Observation/$lastn?category=http://snomed.info/sct|118228005,http://snomed.info/sct|384821006
6 Problems Concern All known problems 
GET [base]/Condition
7 Social history LivingSituation Current living situation 
GET [base]/Observation/$lastn?code=http://snomed.info/sct|365508006
DrugUse All known drug use 
GET [base]/Observation?code=http://snomed.info/sct|228366006
AlcoholUse All known alcohol use 
GET [base]/Observation?code=http://snomed.info/sct|228273003
TobaccoUse All known tobacco use 
GET [base]/Observation?code=http://snomed.info/sct|365980008
NutritionAdvice All known current dietary recommendations 
GET [base]/NutritionOrder?status=active
8 Alerts Alert All known alerts 
GET [base]/Flag
9 Allergies AllergyIntolerance All known information regarding allergies 
GET [base]/AllergyIntolerance
10 Medication MedicationUse Known medication use 
GET [base]/MedicationStatement?category=urn:oid:2.16.840.1.113883.2.4.3.11.60.20.77.5.3|6&_include=MedicationStatement:medication
MedicationAgreement Known medication agreements 
GET [base]/MedicationRequest?category=http://snomed.info/sct|16076005&_include=MedicationRequest:medication
AdministrationAgreement Known administration agreements 
GET [base]/MedicationDispense?category=http://snomed.info/sct|422037009&_include=MedicationDispense:medication
11 Medical aids MedicalAid Known medical aids 
GET [base]/DeviceUseStatement?_include=DeviceUseStatement:device
12 Vaccinations Vaccination Known vaccinations 
GET [base]/Immunization?status=completed
13 Vital signs BloodPressure Last known blood pressure 
GET [base]/Observation/$lastn?code=http://loinc.org|85354-9
BodyWeight Last known body weight 
GET [base]/Observation/$lastn?code=http://loinc.org|29463-7
BodyHeight Last known body height 
GET [base]/Observation/$lastn?code=http://loinc.org|8302-2,http://loinc.org|8306-3,http://loinc.org|8308-9
14 Results LaboratoryTestResult Last known laboratory results per type 
GET [base]/Observation/$lastn?category=http://snomed.info/sct|275711006&_include=Observation:related-target&_include=Observation:specimen
15 Procedures Procedure Known surgical procedures 
GET [base]/Procedure?category=http://snomed.info/sct|387713003
16 Encounters Contact Known hospital admissions (no outpatient contacts) 
GET [base]/Encounter?class=http://hl7.org/fhir/v3/ActCode|IMP,http://hl7.org/fhir/v3/ActCode|ACUTE,http://hl7.org/fhir/v3/ActCode|NONAC
17 Planned care PlannedCareActivityForTransfer Known planned care activities

Em.png

The HCIM PlannedCareActivityForTransfer represents a planned activity as a (reference to) the HCIM for that activity in the 'planned' status. However, FHIR doesn't recognize this status; instead it uses dedicated resources for planning. Therefore, the FHIR implementation of this HCIM uses these dedicated resources instead of a distinct profile::

  • Planning an Encounter is done by using an Appointment
  • Planning a Procedure is done by using a ProcedureRequest
  • Planning a Vaccination is done by using a VaccinationRecommendation
  • Planning a MedicalDevice is done by using a MedicalDeviceRequest
 
GET [base]/ProcedureRequest?status=active
GET [base]/ImmunizationRecommendation
GET [base]/MedicationDispense?category=http://snomed.info/sct|422037009&status=in-progress,preparation&_include=MedicationDispense:medication

Em.png

PlannedCareActivityForTransfer for MedicationAdministration was found unimplementable as-is. Presumed solution will come from a future HCIM release. See MM-115 for more information. 

GET [base]/DeviceRequest?status=active&_include=DeviceRequest:device
GET [base]/Appointment?status=booked,pending,proposed
18 General practitioner HealthProfessional General Practitioner of the patient 
see Patient

Example instances of FHIR resources can be found on Simplifier. Please note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of any information standard.

4.2 Server - XIS

Important sections of the FHIR specification for a server in this use case are the RESTful API section the search section and operation section (for the lastn operation).

4.2.1 Response to resource requests

If the search succeeds, the server SHALL return a 200 OK HTTP status code and the returned content SHALL be a Bundle with type = searchset containing the results of the search as a collection of zero or more resources in a defined order. The returned content SHALL conform to the StructureDefinition applicable for the specific HCIM request. The list of a StructureDefinitions relevant for this use case is shown in the following paragraph: List of StructureDefinitions

The result collection can be long, so servers may use paging. If they do, they SHALL use the method described below (adapted from RFC 5005 (Feed Paging and Archiving ) for breaking the collection into pages if appropriate. The server MAY also return an OperationOutcome resource within the searchset Bundle entries that contains additional information about the search; if one is sent it SHALL NOT include any issues with a fatal or error severity, and it SHALL be marked with a Bundle.entry.search.mode of outcome.

In order to allow the client to be confident about what search parameters were used as criteria by the server, the server SHALL return the parameters that were actually used to process the search. Applications processing search results SHALL check these returned values where necessary. For example, if the server did not support some of the filters specified in the search, a client might manually apply those filters to the retrieved result set, display a warning message to the user or take some other action.

In the case of a RESTful search, these parameters are encoded in the self-link in the bundle that is returned: 

  <link>
    <relation value="self"/>
    <url value="http://example.org/Patient?identifier=[Patient-ID]/>
  </link>

Link to the relevant FHIR specification: http://hl7.org/fhir/STU3/http.html#search

4.2.2 Handling errors

If the search fails (cannot be executed, not that there are no matches), the return value is a status code 4xx or 5xx with an OperationOutcome. An HTTP status code of 403 signifies that the server refused to perform the search, while other 4xx and 5xx codes signify that some sort of error has occurred. The HTTP status code 404 is returned if a XIS did not implement an endpoint used in a request by a PHR. When the search fails, a server SHOULD return an OperationOutcome detailing the cause of the failure. For example, in case of a not implemented FHIR endpoint, the OperationOutcome would state that the resource type is not supported. Note: an empty search result is not a failure.

Common HTTP Status codes returned on FHIR-related errors (in addition to normal HTTP errors related to security, header and content type negotiation issues):

  • 400 Bad Request - search could not be processed or failed basic FHIR validation rules
  • 401 Not Authorized - authorization is required for the interaction that was attempted
  • 404 Not Found - resource type not supported, or not a FHIR end-point

In some cases, parameters may cause an error. For instance:

  • A parameter may refer to a non-existent resource e.g. GET [base]/Observation?subject=101, where "101" does not exist
  • A parameter may refer to an unknown code e.g. GET [base]/Observation?code=loinc|1234-1, where the LOINC code "1234-1" is not known to the server
  • A parameter may refer to a time that is out of scope e.g. GET [base]/Condition?onset=le1995, where the system only has data going back to 2001
  • A parameter may use an illegal or unacceptable modifier e.g. GET [base]/Condition?onset:text=1995, where the modifier cannot be processed by the server
  • A date/time parameter may have incorrect format e.g. GET [base]/Condition?onset=23%20May%202009
  • A parameter may be unknown or unsupported

Where the content of the parameter is syntactically incorrect, servers SHOULD return an error. However, where the issue is a logical condition (e.g. unknown subject or code), the server SHOULD process the search, including processing the parameter - with the result of returning an empty search set, since the parameter cannot be satisfied.

In such cases, the search process MAY include an OperationOutcome in the search set that contains additional hints and warnings about the search process. This is included in the search results as an entry with search mode = outcome. Clients can use this information to improve future searches.

Link to relevant FHIR specification: http://hl7.org/fhir/STU3/search.html#errors

5 Interactions, operations, search parameters

5.1 Interactions

The following logical interactions are needed for the BgZ use case:

5.2 Operations

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.

5.3 Search parameters

The following search parameter types and search result parameters need to be supported for this use case.

Search parameter types:

Search result parameters:

6 List of StructureDefinitions

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.

Em.png

MedMij uses the FHIR Packaging mechanism. This conveniently bundles all examples, profiles and other conformance resources you need into a single download. For more background information see the the FHIR implementation guide. This version of the information standard depends on Nictiz package 1.3.x. Please note that the direct links to the various conformance resources below will take you to the latest version, which might not match the package version. At time of writing, there is no way to render the conformance resource as found in the package. This is on the roadmap for Simplifier.
Section Zib NL HCIM EN FHIR Resource FHIR Profile
1 Patient Patient Patient http://fhir.nl/fhir/StructureDefinition/nl-core-patient
2 Betaler Payer Coverage http://nictiz.nl/fhir/StructureDefinition/zib-Payer
Organization http://fhir.nl/fhir/StructureDefinition/nl-core-organization
Patient http://fhir.nl/fhir/StructureDefinition/nl-core-patient
3 BehandelAanwijzing TreatmentDirective Consent http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentDirective
Wilsverklaring AdvanceDirective Consent http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective
4 Contactpersoon ContactPerson Patient.contact http://fhir.nl/fhir/StructureDefinition/nl-core-patient
5 Funct. OfMentaleStatus FunctionalOrMentalStatus Observation http://nictiz.nl/fhir/StructureDefinition/zib-FunctionalOrMentalStatus
6 Probleem Problem Condition http://nictiz.nl/fhir/StructureDefinition/zib-Problem
7 Woonsituatie LivingSituation Observation http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation
DrugsGebruik DrugUse Observation http://nictiz.nl/fhir/StructureDefinition/zib-DrugUse
AlcoholGebruik AlcoholUse Observation http://nictiz.nl/fhir/StructureDefinition/zib-AlcoholUse
TabakGebruik TobaccoUse Observation http://nictiz.nl/fhir/StructureDefinition/zib-TobaccoUse
Voedingsadvies NutritionAdvice NutritionOrder http://nictiz.nl/fhir/StructureDefinition/zib-NutritionAdvice
8 Alert Alert Flag http://nictiz.nl/fhir/StructureDefinition/zib-Alert
9 AllergieIntolerantie AllergyIntolerance AllergyIntolerance http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance
10 MedicatieGebruik MedicationUse MedicationStatement http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse
MedicationAgreement MedicationRequest http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAgreement
AdministrationAgreement MedicationDispense http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement
11 MedischHulpmiddel MedicalDevice Device http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDeviceProduct
DeviceUseStatement http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDevice
12 Vaccinatie Vaccination Immunization http://nictiz.nl/fhir/StructureDefinition/zib-Vaccination
ImmunizationRecommendation http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation
13 Bloeddruk BloodPressure Observation http://nictiz.nl/fhir/StructureDefinition/zib-BloodPressure
LichaamsGewicht BodyWeight Observation http://nictiz.nl/fhir/StructureDefinition/zib-BodyWeight
LichaamsLengte BodyHeight Observation http://nictiz.nl/fhir/StructureDefinition/zib-BodyHeight
14 LaboratoriumUitslag LaboratoryTestResult Observation http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation
Specimen http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Specimen
15 Verrichting Procedure Procedure http://nictiz.nl/fhir/StructureDefinition/zib-Procedure
16 Contact Encounter Encounter http://nictiz.nl/fhir/StructureDefinition/zib-Encounter
17 OverdrachtGeplandeZorgActiviteit PlannedCareActivityForTransfer ProcedureRequest * http://nictiz.nl/fhir/StructureDefinition/zib-ProcedureRequest
MedicationDispense ** http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement
ImmunizationRecommendation * http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation
DeviceRequest * http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDeviceRequest
Appointment * http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment
18 Zorgverlener HealthProfessional Practitioner http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner
PractitionerRole http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole
Zorgaanbieder HealthcareProvider Organization http://fhir.nl/fhir/StructureDefinition/nl-core-organization

7 Terminology, NamingSystems, Mappings

Relevant ValueSets, NamingSystems and ConceptMaps can be found in the packages referenced in the List of StructureDefinitions section.

The HCIM ValueSets used in the profiles are included in the package (or one of its dependencies). When a FHIR core ValueSet must be used instead of an HCIM ValueSet, a FHIR ConceptMap resource is provided to map the values between the two sets. An explanation about mappings can be found at in the overarching principles.

8 Release notes

Release notes can be found on the functional design page.

Overgenomen van "https://informatiestandaarden.nictiz.nl/index.php?title=MedMij:V2019.01_FHIR_BGZ_2017&oldid=208725"