Niek van Galen: /* Invocations */ Copy text from MM-2695

2022-01-20T07:37:55Z

Invocations: Copy text from MM-2695

← Oudere versie		Versie van 20 jan 2022 07:37
Regel 245:		Regel 245:

	The body of the post submission is a Bundle with {{fhir\|Bundle.type}}={{term\|batch}}. Each entry carries request details ({{fhir\|Bundle.entry.request}}) that provides the HTTP details of the action in order to inform the system processing the batch or what to do for the entry. (Note: {{fhir\|.request}} is optional, but SHALL be present, even for the resources which aren't Observations. See [[MedMij:Vprepub-2020.01/FHIR_IG#Referring other resources when sending information\|the overarching principles]] for more information.)		The body of the post submission is a Bundle with {{fhir\|Bundle.type}}={{term\|batch}}. Each entry carries request details ({{fhir\|Bundle.entry.request}}) that provides the HTTP details of the action in order to inform the system processing the batch or what to do for the entry. (Note: {{fhir\|.request}} is optional, but SHALL be present, even for the resources which aren't Observations. See [[MedMij:Vprepub-2020.01/FHIR_IG#Referring other resources when sending information\|the overarching principles]] for more information.)

			'''Identification:'''

			Various observations may be done multiple times per day. Observations may be distinguished based on:
			* {{fhir\|.identifier}}
			* {{fhir\|.code}}, {{fhir\|.subject}}, {{fhir\|.effective[x]}}

			Some systems only work based on date without time. This would mean that multiple observations of the same type on the same day may be indistingishable. If the sending system does not provide an identifier then the receiving system may or may not be able to detect duplicates, and if the sending system queries observations, it may or may not detect observations it is the source for. Observations SHOULD include an identifier. The receiving system SHALL keep the original identifier if it has one. It MAY issue an additional identifier.

			{{NoteBox\|A FHIR {{fhir\|.identifier.system}} is required and is of type uri, which includes url, oid or uuid. Interoperability with existing systems can only be guaranteed if the {{fhir\|.identifier.system}} is an [https://www.hl7.nl/wiki/index.php?title=Implementatiehandleiding_HL7v3_basiscomponenten_v2.3_Rev2#Identificatiemechanismen OID]. Hence {{fhir\|.identifier.system}} SHOULD be an OID - {{fhir\|<nowiki>urn:oid:...</nowiki>}}. Also see the [[MedMij:V2020.01/FHIR_IG\|FHIR IG]] for more information around identifiers.}}

	'''Links:'''		'''Links:'''

Niek van Galen: Clone of V2020.01 production page for issue MM-2832

2022-01-20T07:34:46Z

Clone of V2020.01 production page for issue MM-2832

Nieuwe pagina

{{IssuePaginaWaarschuwing|MM-2832|MedMij:V2020.01/FHIR_VitalSigns}}
__NOINDEX__
__NUMBEREDHEADINGS__
{{DISPLAYTITLE:MedMij FHIR Implementation Guide Vital Signs {{VersieInfo|Zelfmetingen}}}}
{{MedMij:Vprepub-2020.01/Issuebox_FHIR_IG}}

[[Bestand:MedMij2.png |link=https://www.medmij.nl/|rechts|Naar medmij.nl]]
[[Bestand:Self-measurements_Icoon.png|link=|87px |links||Self-Measurements]]
<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 1013 224 212 [[MedMij:Vprepub-2020.01/OntwerpZelfmetingen|Functioneel]]
circle 1787 230 212 [[MedMij:Vprepub-2020.01/FHIR_IG|Technisch]]
desc none
</imagemap>

__TOC__

=Introduction=
[[Bestand:Functioneel-02.png|link=MedMij:Vprepub-2020.01/Ontwerpen |100px|rechts|Functional design|Go to functional design]]

This use case is mainly based on the HL7 FHIR vital signs specification - http://hl7.org/fhir/STU3/observation-vitalsigns.html. The HL7 FHIR vital signs specification is extended with profiles of zib concepts that represent vital signs. These profiles are derived from the official [http://hl7.org/fhir/observation-vitalsigns.html HL7 Vital Signs profiles]. The purpose of these profiles is to add additional concepts that are not in the vital sign profiles but are provided in the corresponding zib. Moreover, these derived profiles include zib to FHIR mappings.

'''Note''': This implementation guide builds on the general guidelines described in the [[MedMij:Vprepub-2020.01/FHIR_IG#Use case overarching principles|use case overarching principles]].

Because the base [http://hl7.org/fhir/vitalsigns.html vital signs] profile constrains the <code>.code</code> and the <code>.component.code</code> to the datatype quantity it is not possible to add additional zib concepts. A GForge [https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=13796 issue] is created to address this problem. This issue will most likely be resolved with FHIR version STU4. However, to address this problem now the base vital signs panel is copied, the datatype constrains removed and published under a different canonical URL. The HL7 vital sign profiles bloodpressure, bodyweight, and oxygensaturation are copied, the StructureDefinition.baseDefinition adjusted and published under a different canonical URL because they are in the chain of derived profiles and the component.code needs to be used for these vital signs.

Use cases:
* [[MedMij:Vprepub-2020.01/FHIR_VitalSigns#Use_case:_Retrieve_Vital_Signs|Retrieve vital signs]]
* [[MedMij:Vprepub-2020.01/FHIR_VitalSigns#Use_case:_Send_Vital_Signs|Send vital signs]]

=Actors involved=
{| class="wikitable"
! colspan="2" style="text-align:left;" | Persons
! colspan="2" style="text-align:left;" | Systems
! colspan="2" style="text-align:left;" | FHIR Capability Statements
|-
! style="text-align:left;" |Name
! style="text-align:left;" |Description
! style="text-align:left;" |Name
! style="text-align:left;" |Description
! style="text-align:left;" |Name
! style="text-align:left;" |Description
|-
| Patient
| The user of a personal healthcare environment.
| PHR
| Personal health record
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/vitalsigns-clientcapabilities|nictiz.fhir.nl.stu3.zib2017|title=CapabilityStatement: Client}}
| Vital Signs client requirements
|-
| Healthcare professional
| The user of a XIS
| XIS
| Healthcare information system
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/vitalsigns-servercapabilities|nictiz.fhir.nl.stu3.zib2017|title=CapabilityStatement: Server}}
| Vital Signs server requirements
|}

=Use case: Retrieve Vital Signs=
[[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |100px|Go to Afsprakenstelsel]]
{{FHIR-IG-Afsprakenstelsel-Note}}

==Introduction==
The retrieve vital signs transaction is used by the PHR to retrieve vital signs from the XIS.

==Actors==
{| class="wikitable" "cellpadding="10"
! style="text-align:left;"| '''Transaction group'''
! style="text-align:left;"| '''Transaction'''
! style="text-align:left;"| '''Actor'''
! style="text-align:left;"| '''Role'''
|-
|style="background-color: white;vertical-align:top;" rowspan="2"|Retrieve Vital Signs(PULL)
|style="background-color: white;vertical-align:top;"|Retrieve vital signs request
|style="background-color: white;vertical-align:top;"|Patient (using a PHR)
|style="background-color: white;vertical-align:top;"|Request vital signs from the XIS
|-
|style="background-color: white;vertical-align:top;"|Retrieve vital signs response
|style="background-color: white;vertical-align:top;"|Healthcare professional (using a XIS)
|style="background-color: white;vertical-align:top;"|Serves vital signs to the PHR
|}

==Invocations==
===PHR: request message===
The request message represents an HTTP GET parameterized query from the PHR to the XIS.

====Trigger Events====
When the patient(PHR) wants to obtain vital signs, it issues a retrieve vital signs request message.

====Message Semantics====
'''Search'''

The PHR executes an HTTP GET conform to the FHIR [http://hl7.org/fhir/http.html RESTful] and [http://hl7.org/fhir/search.html search] specification against the XIS's Observation endpoint. This search query URL is configurable by the PHR and has the following format.

<pre>
GET [base]/Observation{/$lastn}{?[parameters]}
</pre>

'''Search Parameters'''

The PHR may supply, and the XIS shall be capable of processing, all query parameters listed below. These search parameters are a selection of the defined search parameters by the HL7 FHIR specification search parameters of [http://hl7.org/fhir/STU3/observation.html#search Observation].

{| class="wikitable"
! colspan="4" style="font-weight: bold; text-align:left;" | Observation
|-
| style="font-weight: bold;" | Name
| style="font-weight: bold;" | Type
| style="font-weight: bold;" | Description
| style="font-weight: bold;" | Example
|-
| [https://www.hl7.org/fhir/stu3/observation.html#search <code>category</code>]
| token
| The classification of the type of observation.

Within this context this will be {{term|vital-signs}} (from code system <code><nowiki>http://hl7.org/fhir/observation-category</nowiki></code>)
|
Retrieve all Observation resources that are considered a vital sign observation:
<pre>GET [base]/Observation?category=vital-signs</pre>
|-
| [https://www.hl7.org/fhir/stu3/observation.html#search <code>code</code>]
| token
| The code of the observation type.

The different types of measurements are specified using the following LOINC codes:
* Respiration: 9279-1
* BloodPressure: 85354-9
* BodyWeight: 29463-7
* BodyHeight: 8302-2
* BodyTemperature: 8310-5
* Oxygenation, saturation, SpO2: 59408-5
* HeartRate: 8867-4
* PulseRate: 8889-8
* BloodGlucose
** fasting: 14770-2
** general: 14743-9
** post-meal: 14760-3
|
Retrieve all Observation resources that are a blood pressure observation:
<pre>GET [base]/Observation?code=http://loinc.org|85354-9</pre>
Retrieve the most recent body height and the most recent body weight observation:
<pre>GET [base]/Observation/$lastn?code=http://loinc.org|8302-2&code=http://loinc.org|29463-7</pre>
|-
| [https://www.hl7.org/fhir/stu3/observation.html#search <code>date</code>]
| date
| Obtained date/time. If the obtained element is a period, a date that falls in the period
|
Retrieve all Observation resources that are a blood pressure observation and have an effective date between 01-01-2010 and 31-12-2010:
<pre>GET [base]/Observation?code=http://loinc.org|85354-9&date=ge2010-01-01&date=le2011-01-01</pre>
Retrieve at most four temperature observations that have an effective date greater than 01-06-2012:
<pre>GET [base]/Observation/$lastn?max=4&code=http://loinc.org|8310-5&date=ge2012-06-01</pre>
|}

=====Expected Actions=====
The XIS shall process the query to find and return the vital signs matching the provided query parameters.

===XIS: response message===
The XIS returns an HTTP Status code appropriate to the processing as well as a Bundle of matching vital signs Observation.

====Trigger Events====
The XIS completed processing of the retrieve vital signs request message.

====Message Semantics====
The body of the response message shall be a Bundle of type "''searchset''" containing all matching vital sign Observations as entries. If no Observations are found, a Bundle of type "''searchset''" shall be returned without any Observation as entries.

In the table below, the vital sign zibs and their respective profiles are listed. Zibs that MUST be supported are marked with (M). Other vital signs profiles, without a corresponding zib, are can be found in the [http://hl7.org/fhir/STU3/observation-vitalsigns.html HL7 FHIR specification.]

{{MedMij:Vprepub-2020.01/NoteBoxPackage|p1=nictiz.fhir.nl.stu3.zib2017|v1Min=2.0.0}}

{| class="wikitable"
|-style="background-color: #1F497D; color: white; font-weight: bold; "
|style="width:150px;"|Zib NL||style="width:150px;"|HCIM EN||style="width:150px;"|FHIR Resource||style="width:450px;"|FHIR Profile
|-style="vertical-align:top; background-color: #E3E3E3;
|-
| Patiënt (M)||Patient||Patient||{{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017}}
|-
| Zorgverlener (M)||HealthProfessional||Practitioner||{{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner|nictiz.fhir.nl.stu3.zib2017}}
|-
| Ademhaling||Respiration||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Respiration|nictiz.fhir.nl.stu3.zib2017}}
|-
| Bloeddruk (M)||BloodPressure [[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-BloodPressure|nictiz.fhir.nl.stu3.zib2017}}
|-
| LichaamsGewicht (M)||BodyWeight[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-BodyWeight|nictiz.fhir.nl.stu3.zib2017}}
|-
| LichaamsLengte||BodyHeight[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-BodyHeight|nictiz.fhir.nl.stu3.zib2017}}
|-
| Lichaamstemperatuur||BodyTemperature[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-BodyTemperature|nictiz.fhir.nl.stu3.zib2017}}
|-
| O2Saturatie||oxygenation, saturation, SpO2[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-OxygenSaturation|nictiz.fhir.nl.stu3.zib2017}}
|-
| Hartfrequentie (M)||HeartRate[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-HeartRate|nictiz.fhir.nl.stu3.zib2017}}
|-
| Polsfrequentie||PulseRate[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-PulseRate|nictiz.fhir.nl.stu3.zib2017}}
|-
| LaboratoriumUitslag (based on) (M)||LaboratoryTestResult (based on)||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/vitalsign-bloodglucose|nictiz.fhir.nl.stu3.zib2017}}
|}

<span id="MustSupportFlag"></span>{{NoteBox|The Vital Signs FHIR profiles contain "Must Support" flags for various elements. The "Must Support" flags are inherited from FHIR core, but no particular meaning has been specified for the interpretation of these flags. Therefore, the "Must Support" flags also have no particular meaning within this context and can be ignored.}}

====Expected Actions====
The PHR processes the results according to application-defined rules.

===The <code>lastn</code> operation===
The following [http://hl7.org/fhir/STU3/operations.html operation] is needed for this use case.
* [http://hl7.org/fhir/STU3/observation-operations.html#lastn Last N Observations Query]

The <code>lastn</code> 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 [http://hl7.org/fhir/STU3/observation-operations.html#lastn FHIR STU3] specification is vague regarding the sorting mechanism of lastn. In [http://hl7.org/fhir/R4/observation-operation-lastn.html FHIR R4] however, this has been clarified and can be read as follows: when using lastn, the <code>effective[x]</code> element is used for sorting of Observations, sorted from most recent to the oldest.

=Use case: Send Vital Signs=

==Introduction==
The send vital signs transaction is used by the PHR to send vital signs to the XIS.

==Actors==
{| class="wikitable" "cellpadding="10"
! style="text-align:left;"| '''Transaction group'''
! style="text-align:left;"| '''Transaction'''
! style="text-align:left;"| '''Actor'''
! style="text-align:left;"| '''Role'''
|-
|style="background-color: white;vertical-align:top;" rowspan="2"|Send Vital Signs(PUSH)
|style="background-color: white;vertical-align:top;"|Send vital signs request
|style="background-color: white;vertical-align:top;"|Patient (using a PHR)
|style="background-color: white;vertical-align:top;"|Sends vital signs to the XIS
|-
|style="background-color: white;vertical-align:top;"|Send vital signs response
|style="background-color: white;vertical-align:top;"|Healthcare professional (using a XIS)
|style="background-color: white;vertical-align:top;"|Receives vital signs from the PHR
|}

==Invocations==
===PHR: request message===
The send vital sings request message uses the HTTP POST method on the target XIS's base.

====Trigger Events====
This message is invoked when the PHR needs to send one or more vital signs observations to the XIS.

====Message Semantics====
Because sending vital signs will most likely consist of multiple Observations, a {{fhir|batch}} operation is used. This allows for creating a set of resources in a single interaction and makes it possible to [[MedMij:Vprepub-2020.01/FHIR_IG#Referring other resources when sending information|include referenced secondary resources]] if needed.

A {{fhir|batch}} interaction is performed by an HTTP POST command as shown:

<pre>POST [base]</pre>

The body of the post submission is a Bundle with {{fhir|Bundle.type}}={{term|batch}}. Each entry carries request details ({{fhir|Bundle.entry.request}}) that provides the HTTP details of the action in order to inform the system processing the batch or what to do for the entry. (Note: {{fhir|.request}} is optional, but SHALL be present, even for the resources which aren't Observations. See [[MedMij:Vprepub-2020.01/FHIR_IG#Referring other resources when sending information|the overarching principles]] for more information.)

'''Links:'''

* [http://hl7.org/fhir/STU3/http.html#transaction batch]
* [http://hl7.org/fhir/STU3/http.html#create create]

The vital signs data send to the XIS SHALL conform to the matching vital sign profile. The table below lists profiles that represent zibs that can be used for vital sign information exchange. If no matching vital sign zib profile is present, vital sign profiles listed in the [http://hl7.org/fhir/STU3/observation-vitalsigns.html FHIR specification] can be used. Other vital sign concepts are currently out of scope for this use case.

{{MedMij:Vprepub-2020.01/NoteBoxPackage|p1=nictiz.fhir.nl.stu3.zib2017}}

{| class="wikitable"
|-style="background-color: #1F497D; color: white; font-weight: bold; "
|style="width:150px;"|Zib NL||style="width:150px;"|HCIM EN||style="width:150px;"|FHIR Resource||style="width:450px;"|FHIR Profile
|-style="vertical-align:top; background-color: #E3E3E3;
|-
| Patiënt (M)||Patient||Patient||{{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017}}
|-
| Zorgverlener (M)||HealthProfessional||Practitioner||{{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner|nictiz.fhir.nl.stu3.zib2017}}
|-
| Ademhaling||Respiration||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Respiration|nictiz.fhir.nl.stu3.zib2017}}
|-
| Bloeddruk (M)||BloodPressure[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-BloodPressure|nictiz.fhir.nl.stu3.zib2017}}
|-
| LichaamsGewicht (M)||BodyWeight[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-BodyWeight|nictiz.fhir.nl.stu3.zib2017}}
|-
| LichaamsLengte||BodyHeight[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-BodyHeight|nictiz.fhir.nl.stu3.zib2017}}
|-
| Lichaamstemperatuur||BodyTemperature[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-BodyTemperature|nictiz.fhir.nl.stu3.zib2017}}
|-
| O2Saturatie||oxygenation, saturation, SpO2[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-OxygenSaturation|nictiz.fhir.nl.stu3.zib2017}}
|-
| Hartfrequentie (M)||HeartRate[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-HeartRate|nictiz.fhir.nl.stu3.zib2017}}
|-
| Polsfrequentie||PulseRate[[#MustSupportFlag|*]]||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-PulseRate|nictiz.fhir.nl.stu3.zib2017}}
|-
| LaboratoriumUitslag (based on) (M)||LaboratoryTestResult (based on)||Observation||{{Simplifier|http://nictiz.nl/fhir/StructureDefinition/vitalsign-bloodglucose|nictiz.fhir.nl.stu3.zib2017}}
|}
=====Expected Actions=====
On receipt of the submission, the XIS shall validate the resources and respond with an appropriate HTTP code.

===XIS: response message===
The XIS returns an HTTP Status code appropriate to the processing outcome and returns a Bundle, of type batch-response, that contains one entry for each entry in the request, in the same order, with the outcome of processing the entry.

====Trigger Events====
The XIS completed processing of the send vital signs request message.

====Message Semantics====
The XIS SHALL return a Bundle with type set to batch-response that contains one entry for each entry in the request, in the same order, with the outcome of processing the entry.

A client may use the returned Bundle to track the outcomes of processing the entry, and the identities assigned to the resources by the server. Each entry element SHALL contain a response element which details the outcome of processing the entry - the HTTP status code, and the location and ETag header values, which are used for identifying and versioning the resources. In addition, a resource may be included in the entry, as specified by the Prefer header.

Read more:
[http://hl7.org/fhir/STU3/http.html#create create]
[http://hl7.org/fhir/STU3/http.html#transaction batch]

====Expected Actions====
The PHR processes the results according to application-defined rules.

====Handling Errors====
The server may be unable to accept a Bundle due to errors or because of business rules (e.g. because of an unsupported code value in an Observation resource). Refer to the [https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2020.01/FHIR_IG#Handling_errors Handling Errors section] in the MedMij FHIR IG for more information.

=Release notes=
Release notes can be found on the [[MedMij:Vprepub-2020.01/OntwerpZelfmetingen#Release_notes|functional design page]].

MedMij:Vissue-MM-2832/FHIR VitalSigns - Bewerkingsoverzicht

Niek van Galen: /* Invocations */ Copy text from MM-2695

Niek van Galen: Clone of V2020.01 production page for issue MM-2832