bgz:Vissue-NICTIZ-14348 BgZ 2017 Technical IG: verschil tussen versies

Uit informatiestandaarden
Ga naar: navigatie, zoeken
imported>Rick Busbridge
(NICTIZ-14769 - Ontwikkelen/schrijven van de TO in de wiki)
imported>Rick Busbridge
(NICTIZ-14769 - Ontwikkelen/schrijven van de TO in de wiki)
Regel 167: Regel 167:
  
 
=FHIR Queries=
 
=FHIR Queries=
 +
The XIS requests the BgZ using individual [https://www.hl7.org/fhir/stu3/search.html 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:
 +
 +
<code>GET [base]/[type]{?[parameters]}</code>
 +
 +
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 [[#List_of_profiles| this section]].
 +
 +
{| class="wikitable collapsible" width="100%" style="horizontal-align: right" 
 +
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:10px" | #
 +
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;  background-color: #E3E3E3 width:10px" | BgZ Section
 +
!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" | 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
 +
| Patient information
 +
| Patient
 +
| 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>
 +
|-
 +
| 2
 +
| Payment details
 +
| Payer
 +
| Insurance information
 +
| <pre>GET [base]/Coverage?_include=Coverage:payor:Patient&_include=Coverage:payor:Organization</pre>
 +
|-
 +
| rowspan="2" | 3
 +
| rowspan="2" | Treatment directives
 +
| TreatmentDirective
 +
| Known treatment directives
 +
| <pre>GET [base]/Consent?category=http://snomed.info/sct|11291000146105</pre>
 +
|-
 +
| AdvanceDirective
 +
| Known advance directives
 +
| <pre>GET [base]/Consent?category=http://snomed.info/sct|11341000146107</pre>
 +
|-
 +
| 4
 +
| Contact persons
 +
| ContactPerson
 +
| First relation/contact
 +
| <pre style="font-style: italic;">see Patient</pre>
 +
|-
 +
| 5
 +
| Functional status
 +
| FunctionalOrMentalStatus
 +
| Last known functional / mental status
 +
| <pre>GET [base]/Observation/$lastn?category=http://snomed.info/sct|118228005,http://snomed.info/sct|384821006</pre>
 +
<span id="FunctionalOrMentalStatusRemark"></span>{{NoteBox|The NL-CM:4.26.6 StatusDate concept is incorrectly mapped on the <code>effective[x]:effectivePeriod.start</code> element in the HCIM FunctionalOrMentalStatus profile, it is a date rather than a period. Presumed solution will come from a future HCIM release. See [https://bits.nictiz.nl/browse/MM-1570 MM-1570] for more information.}}
 +
|-
 +
| 6
 +
| Problems
 +
| Concern
 +
| All known problems
 +
| <pre>GET [base]/Condition</pre>
 +
|-
 +
| rowspan="5" | 7
 +
| rowspan="5" | Social history
 +
| LivingSituation
 +
| Current living situation
 +
| <pre>GET [base]/Observation/$lastn?code=http://snomed.info/sct|365508006</pre>
 +
|-
 +
| DrugUse
 +
| All known drug use
 +
| <pre>GET [base]/Observation?code=http://snomed.info/sct|228366006</pre>
 +
|-
 +
| AlcoholUse
 +
| All known alcohol use
 +
| <pre>GET [base]/Observation?code=http://snomed.info/sct|228273003</pre>
 +
|-
 +
| TobaccoUse
 +
| All known tobacco use
 +
| <pre>GET [base]/Observation?code=http://snomed.info/sct|365980008</pre>
 +
|-
 +
| NutritionAdvice
 +
| All known dietary recommendations
 +
| <pre>GET [base]/NutritionOrder</pre>
 +
|-
 +
| 8
 +
| Alerts
 +
| Alert
 +
| All known alerts
 +
| <pre>GET [base]/Flag</pre>
 +
|-
 +
| 9
 +
| Allergies
 +
| AllergyIntolerance
 +
| All known information regarding allergies
 +
| <pre>GET [base]/AllergyIntolerance</pre>
 +
|-
 +
| rowspan="3" | 10
 +
| rowspan="3" | Medication
 +
| MedicationUse
 +
| Known medication use
 +
| <pre>todo ref MP9</pre>
 +
|-
 +
| MedicationAgreement
 +
| Known medication agreements
 +
| <pre>todo ref MP9</pre>
 +
|-
 +
| AdministrationAgreement
 +
| Known administration agreements
 +
| <pre>todo ref MP9</pre>
 +
|-
 +
| 11
 +
| Medical aids
 +
| MedicalDevice
 +
| Known medical aids
 +
| <pre>GET [base]/DeviceUseStatement?_include=DeviceUseStatement:device</pre>
 +
|-
 +
| 12
 +
| Vaccinations
 +
| Vaccination
 +
| Known vaccinations
 +
| <pre>GET [base]/Immunization?status=completed</pre>
 +
|-
 +
| rowspan="3" | 13
 +
| rowspan="3" | Vital signs
 +
| BloodPressure
 +
| Last known blood pressure
 +
| <pre>GET [base]/Observation/$lastn?code=http://loinc.org|85354-9</pre>
 +
|-
 +
| BodyWeight
 +
| Last known body weight
 +
| <pre>GET [base]/Observation/$lastn?code=http://loinc.org|29463-7</pre>
 +
|-
 +
| BodyHeight
 +
| Last known body height
 +
| <pre>GET [base]/Observation/$lastn?code=http://loinc.org|8302-2,http://loinc.org|8306-3,http://loinc.org|8308-9</pre>
 +
|-
 +
| 14
 +
| Results
 +
| LaboratoryTestResult
 +
| Last known laboratory results per type
 +
| <pre>GET [base]/Observation/$lastn?category=http://snomed.info/sct|275711006&_include=Observation:related-target&_include=Observation:specimen</pre>
 +
|-
 +
| 15
 +
| Procedures
 +
| Procedure
 +
| Known surgical procedures
 +
| <pre>GET [base]/Procedure?category=http://snomed.info/sct|387713003</pre>
 +
|-
 +
| 16
 +
| Encounters
 +
| Contact
 +
| 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>
 +
|-
 +
| 17
 +
| Planned care
 +
| PlannedCareActivityForTransfer
 +
| Known planned care activities
 +
| <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::
 +
 +
*Planning an Encounter is done by using an Appointment
 +
*Planning a Procedure is done by using a ProcedureRequest
 +
*Planning an Immunization is done by using an ImmunizationRecommendation 
 +
*Planning a MedicalDevice is done by using a DeviceRequest
 +
}}
 +
<pre>GET [base]/ProcedureRequest?status=active</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
 +
| Care setting
 +
| HealthProfessional
 +
| General Practitioner of the patient
 +
| <pre style="font-style: italic;">todo query HealthProfessional</pre>
 +
|
 +
|-
 +
|
 +
|
 +
| HealthProvider
 +
| Health provider of the patient
 +
| <pre style="font-style: italic;">todo query HealthProvider</pre>
 +
|}
 +
 
=FHIR Profiles=
 
=FHIR Profiles=
 
==Notification Task==
 
==Notification Task==

Versie van 5 apr 2024 om 13:49

Issue icon.png

Dit is een tijdelijke pagina met wijzigingen voor issue NICTIZ-14348. De gepubliceerde versie vind je hier.

Under construction icon-blue.png This article or section is in the middle of an expansion or major restructuring and is not yet ready for use.


1 Introduction

2 Background

3 About this document

4 Glossary

5 Boundaries and Relationships

6 Systems and System Roles

7 Use Cases

7.1 Verzenden BgZ

7.1.1 Actors

Persons Systems
Name Description Name Description
Referring medical specialist Medical specialist who sends a BgZ along with a referral EHR Electronic health record
Receiving medical specialist Medical specialist receives a BgZ along with a referral EHR Electronic health record

7.1.2 Transactions

using NP

7.2 Opvragen BgZ

(out of scope V2.0)

7.2.1 Actors

Persons Systems
Name Description Name Description
to do... Source System that is queried for the BgZ to do... EHR Electronic health record
Querying medical specialist Medical specialist who queries for a BgZ EHR Electronic health record

7.2.2 Transactions

8 Query Coding Schemes

LOINC / SNOMED-CT codes identifying BgZ MSZ items

HCIM Code System Code System
Patient
MaritalStatus
ContactPerson
HealthProfessional 		79191-3 http://loinc.org
Payer 48768-6 http://loinc.org
TreatmentDirective 11291000146105 http://snomed.info/sct
AdvanceDirective 11341000146107 http://snomed.info/sct
FunctionalOrMentalStatus 47420-5 http://loinc.org
Problem 11450-4 http://loinc.org
LivingSituation 365508006 http://snomed.info/sct
DrugUse 228366006 http://snomed.info/sct
AlcoholUse 228273003 http://snomed.info/sct
TobaccoUse 365980008 http://snomed.info/sct
NutritionAdvice 11816003 http://snomed.info/sct
Alert 75310-3 http://loinc.org
AllergyIntolerance 48765-2 http://loinc.org
MedicationAgreement 16076005 http://snomed.info/sct
AdministrationAgreement 422037009 http://snomed.info/sct
MedicationUse2 422979000 http://snomed.info/sct
MedicalDevice 46264-8 http://loinc.org
Vaccination 11369-6 http://loinc.org
BloodPressure 85354-9 http://loinc.org
BodyWeight 29463-7 http://loinc.org
BodyHeight 8302-2 http://loinc.org
LaboratoryTestResult 15220000 http://snomed.info/sct
Procedure 47519-4 http://loinc.org
Encounter 46240-8 http://loinc.org
PlannedCareActivityForTransfer 18776-5 http://loinc.org

9 FHIR Queries

The XIS 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:

GET [base]/[type]{?[parameters]}

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]
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

Em.png

The NL-CM:4.26.6 StatusDate concept is incorrectly mapped on the effective[x]:effectivePeriod.start element in the HCIM FunctionalOrMentalStatus profile, it is a date rather than a period. Presumed solution will come from a future HCIM release. See MM-1570 for more information.

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 dietary recommendations 
GET [base]/NutritionOrder
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 
todo ref MP9
MedicationAgreement Known medication agreements 
todo ref MP9
AdministrationAgreement Known administration agreements 
todo ref MP9
11 Medical aids MedicalDevice 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 an Immunization is done by using an ImmunizationRecommendation
  • Planning a MedicalDevice is done by using a DeviceRequest
 
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 Care setting HealthProfessional General Practitioner of the patient 
todo query HealthProfessional
HealthProvider Health provider of the patient 
todo query HealthProvider

10 FHIR Profiles

10.1 Notification Task

10.2 Workflow Task

10.3 Referenced BgZ Resources

11 Infrastructure

Say something about infrastructure and use of generic functions

12 References

13 Release Notes

  1. ↑ See Search URLs and search parameters for the interpretation of these search URLs
Overgenomen van "https://informatiestandaarden.nictiz.nl/index.php?title=bgz:Vissue-NICTIZ-14348_BgZ_2017_Technical_IG&oldid=308427"