Versie van 31 jul 2020 07:45

1 Introduction

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 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 use case overarching principles.

Because the base vital signs profile constrains the .code and the .component.code to the datatype quantity it is not possible to add additional zib concepts. A GForge 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:

2 Actors involved

Persons		Systems		FHIR Capability Statements
Name	Description	Name	Description	Name	Description
Patient	The user of a personal healthcare environment.	PHR	Personal health record	CapabilityStatement: Client	Vital Signs client requirements
Healthcare professional	The user of a XIS	XIS	Healthcare information system	CapabilityStatement: Server	Vital Signs server requirements

3 Use case: Retrieve Vital Signs

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.

3.1 Introduction

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

3.2 Actors

Transaction group	Transaction	Actor	Role
Retrieve Vital Signs(PULL)	Retrieve vital signs request	Patient (using a PHR)	Request vital signs from the XIS
Retrieve Vital Signs(PULL)	Retrieve vital signs response	Healthcare professional (using a XIS)	Serves vital signs to the PHR

3.3 Invocations

3.3.1 PHR: request message

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

3.3.1.1 Trigger Events

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

3.3.1.2 Message Semantics

Search

The PHR executes an HTTP GET conform to the FHIR RESTful and search specification against the XIS's Observation endpoint. This search query URL is configurable by the PHR and has the following format.

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

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

Observation
Name	Type	Description	Example
`category`	token	The classification of the type of observation	Retrieve all Observation resources that are considerd a vital sign observation. GET [base]/Observation?category=vital-signs
`code`	token	The code of the observation type	Retrieve all Observation resources that are a blood pressure observation. GET [base]/Observation?code=http://loinc.org\|85354-9
`date`	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 greater than 01-01-2010. GET [base]/Observation?code=http://loinc.org\|85354-9&date=ge2010-01-01

Searches

The PHR should be able to fetch all of a patient's vital signs by searching on:

category (all vital signs),
category and date,
code (specific vital sign),
code and date,
code and Last N.

1. GET [base]/Observation?category=vital-signs
2. GET [base]/Observation?category=vital-signs&date=[date]{&date=[date]}
3. GET [base]/Observation?code[vital sign LOINC{,LOINC2,LOINC3,...}]
4. GET [base]/Observation?code=[vital sign LOINC{,LOINC2,LOINC3,...}]&date=[date]{&date=[date]}
5. GET [base]/Observation/$lastn?code[vital sign LOINC{,LOINC2,LOINC3,...}

The following table lists vital signs that have a corresponding zib. The column 'LOINC code' shows the LOINC code that can be used in the search query. Other possible codes, including the codes mentioned here, can be found here.

Zib	LOINC code
BloodPressure	85354-9
BodyWeight	29463-7
BodyHeight	8302-2
BodyTemperature	8310-5
Oxygenation, saturation, SpO2	59408-5
HeartRate	8867-4
PulseRate	8889-8
BloodGlucose	14770-2 (fasting) 14743-9 (general) 14760-3 (post-meal)

3.3.1.2.1 Expected Actions

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

3.3.2 XIS: response message

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

3.3.2.1 Trigger Events

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

3.3.2.2 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. Other vital signs profiles, without a corresponding zib, are can be found in the HL7 FHIR specification.

Zib name NL	Zib name EN	FHIR Resource	FHIR profile
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
Lichaamstemperatuur	BodyTemperature	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-BodyTemperature
O2Saturatie	oxygenation, saturation, SpO2	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-OxygenSaturation
Hartfrequentie	HeartRate	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-HeartRate
Polsfrequentie	PulseRate	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-PulseRate
LaboratoriumUitslag (based on)	LaboratoryTestResult (based on)	Observation	http://nictiz.nl/fhir/StructureDefinition/vitalsign-bloodglucose

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.

3.3.2.3 Expected Actions

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

3.3.3 The `lastn` operation

The following operation is needed for this use case.

Last N Observations Query

The lastn query meets the common need for searching for the most recent or last n=number of observations for a subject. For example, retrieving the last 5 temperatures for a patient to view trends or fetching the most recent laboratory results or vital signs. The link will provide more detailed information and examples regarding this operation.

The FHIR STU3 specification is vague regarding the sorting mechanism of lastn. In FHIR R4 however, this has been clarified and can be read as follows: when using lastn, the effective[x] element is used for sorting of Observations, sorted from most recent to the oldest.

4 Use case: Send Vital Signs

4.1 Introduction

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

4.2 Actors

Transaction group	Transaction	Actor	Role
Send Vital Signs(PUSH)	Send vital signs request	Patient (using a PHR)	Sends vital signs to the XIS
Send Vital Signs(PUSH)	Send vital signs response	Healthcare professional (using a XIS)	Receives vital signs from the PHR

4.3 Invocations

4.3.1 PHR: request message

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

4.3.1.1 Trigger Events

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

4.3.1.2 Message Semantics

Because sending vital signs will most likely consist of multiple Observations, a batch/transaction transaction is used. This allows for creating a set of resources in a single interaction.

A batch interaction is performed by an HTTP POST command as shown:

POST [base]

The body of the post submission is a Bundle with Bundle.type = batch. Each entry carries request details (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: the request is optional, but SHOULD be present). Every bundle.entry creates a resource using an HTTP POST method. The resource of this entry shall be the vital sign observation.

Links:

batch
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 FHIR specification can be used. Other vital sign concepts are currently out of scope for this use case.

Zib name NL	Zib name EN	FHIR Resource	FHIR Profile
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
Lichaamstemperatuur	BodyTemperature	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-BodyTemperature
O2Saturatie	oxygenation, saturation, SpO2	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-OxygenSaturation
Hartfrequentie	HeartRate	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-HeartRate
Polsfrequentie	PulseRate	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-PulseRate
LaboratoriumUitslag (based on)	LaboratoryTestResult (based on)	Observation	http://nictiz.nl/fhir/StructureDefinition/vitalsign-bloodglucose

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.3.1.2.1 Expected Actions

On receipt of the submission, the XIS shall validate the resources and respond with an appropriate HTTP code. If the XIS encounters any errors or if validation fails, the XIS shall return an error as documented in the Message Semantics of the response message.

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

4.3.2.1 Trigger Events

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

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

When the resource syntax or data is incorrect or invalid, and cannot be used to create a new resource, the server returns a 400 Bad Request HTTP status code. When the server rejects the content of the resource because of business rules, the server returns a 422 Unprocessable Entity error HTTP status code. In either case, the server SHOULD include a response body containing an OperationOutcome with detailed error messages describing the reason for the error.

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 - resource could not be parsed or failed basic FHIR validation rules
404 Not Found - resource type not supported, or not a FHIR end-point
422 Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail

4.3.2.3 Expected Actions

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

5 Terminology, NamingSystems, Mappings

5.1 Terminology

Relevant ValueSets can be found through the ValueSet bindings in the listed StructureDefinitions. All ValueSets can be found here here and can be downloaded as a .zip in XML or JSON format.

5.2 NamingSystems

Relevant NamingSystems can be found here.

5.3 Mappings

A FHIR ConceptMap resource is provided when a FHIR value set is used instead of a HCIM value set. A ConceptMap maps the values between the two value sets. These ConceptMaps can be found here.

An explanation about mappings can be found at Mapping of coded concepts.

6 Release notes

Release notes can be found on the functional design page.

@@ Regel 19: / Regel 19: @@
 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.
-'''Technical note:'''
+'''Note''': This implementation guide builds on the general guidelines described in the [[MedMij:Vprepub/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.
@@ Regel 56: / Regel 56: @@
 =Use case: Retrieve Vital Signs=
+[[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |100px|Go to Afsprakenstelsel]]
 {{FHIR-IG-Afsprakenstelsel-Note}}
@@ Regel 88: / Regel 89: @@
 '''Search'''
-The PHR executes an HTTP GET conform to the FHIR [http://hl7.org/fhir/http.html RESTfull] 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.
+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?[parameters]{&_format=[mime-type]}
+GET [base]/Observation{?[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="3" style="font-weight: bold; text-align:left;" | Observation
+! 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
 |-
-| category
+| [https://www.hl7.org/fhir/stu3/observation.html#search <code>category</code>]
 | token
 | The classification of the type of observation
+|
+Retrieve all Observation resources that are considerd a vital sign observation.
+<pre>GET [base]/Observation?category=vital-signs</pre>
 |-
-| code
+| [https://www.hl7.org/fhir/stu3/observation.html#search <code>code</code>]
 | token
 | The code of the observation type
+|
+Retrieve all Observation resources that are a blood pressure observation.
+<pre>GET [base]/Observation?code=http://loinc.org|85354-9</pre>
 |-
-| date
+| [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 greater than 01-01-2010.
+<pre>GET [base]/Observation?code=http://loinc.org|85354-9&date=ge2010-01-01</pre>
 |}
-'''Example searches'''
+'''Searches'''
 The PHR should be able to fetch all of a patient's vital signs by searching on:
@@ Regel 167: / Regel 177: @@
 ====Message Semantics====
-Based on the retrieve vital signs request message processing results, the XIS will either return an error or success. When the XIS needs to report an error, it shall use HTTP error response codes and shall include a FHIR OperationOutcome resource with more details on the failure. If the request message is processed successfully, whether or not vital signs are found or generated, the HTTP status code shall be 200.
+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.
-''Response Class:''
-* Status 200: successful operation
-* Status 400: invalid parameter
-* Status 401/4xx: unauthorized request
-* Status 403: insufficient scope
-If the XIS is sending warnings, the Bundle resource shall also contain a FHIR OperationOutcome resource that contains those warnings. The FHIR specification describes the relevant sections:
-*[http://hl7.org/fhir/STU3/observation-vitalsigns.html Vital Signs Profile]
-*[http://hl7.org/fhir/STU3/http.html RESTful API framework]
-*[http://hl7.org/fhir/STU3/search.html Search]
-*[http://hl7.org/fhir/STU3/bundle.html Bundle resource]
-*[http://hl7.org/fhir/STU3/operationoutcome.html OperationOutcome resource]
-=====Message Resource content=====
-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. 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.]
@@ Regel 211: / Regel 205: @@
 |}
 {{Sjabloon:Voorbeelden}}
 ====Expected Actions====
 The PHR processes the results according to application-defined rules.
-==Interactions, operations, search parameters==
+===The <code>lastn</code> operation===
-===Interactions===
-The following logical interactions are needed for the retrieve medication information transaction:
-* [http://hl7.org/fhir/STU3/http.html#search Search]
-===Operations===
 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 lastn query meets the common need for searching for the most recent or last n=number of observations for a subject. For example, retrieving the last 5 temperatures for a patient to view trends or fetching the most recent laboratory results or vital signs. The link will provide more detailed information and examples regarding this operation.
+The <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.
-===Search parameters===
-The following search parameter types and search result parameters need to be supported for this transaction.
-Search parameter types:
-* [http://hl7.org/fhir/STU3/search.html#token token]
-* [http://hl7.org/fhir/STU3/search.html#date date]
 =Use case: Send Vital Signs=
@@ Regel 268: / Regel 252: @@
 A batch interaction is performed by an HTTP POST command as shown:
-<pre>POST [base] {?_format=[mime-type]}</pre>
+<pre>POST [base]</pre>
 The body of the post submission is a Bundle with Bundle.type = batch. Each entry carries request details (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: the request is optional, but SHOULD be present). Every bundle.entry creates a resource using an HTTP POST method. The resource of this entry shall be the vital sign observation.
@@ Regel 332: / Regel 316: @@
 ====Expected Actions====
 The PHR processes the results according to application-defined rules.
-==Interactions, operations, search parameters==
-===Interactions===
-The following logical interactions are needed for the retrieve medication information transaction:
-* [http://hl7.org/fhir/STU3/http.html#create create]
-* [http://hl7.org/fhir/STU3/http.html#transaction batch/transaction]
-===Operations===
-No operations are defined or needed for this transaction.
-===Search parameters===
-No search parameters are defined or needed for this transaction.
 =Terminology, NamingSystems, Mappings=

MedMij:V2020.01/FHIR VitalSigns: verschil tussen versies

Versie van 31 jul 2020 07:45

Inhoud

1 Introduction

2 Actors involved

3 Use case: Retrieve Vital Signs

3.1 Introduction

3.2 Actors

3.3 Invocations

3.3.1 PHR: request message

3.3.1.1 Trigger Events

3.3.1.2 Message Semantics

3.3.1.2.1 Expected Actions

3.3.2 XIS: response message

3.3.2.1 Trigger Events

3.3.2.2 Message Semantics

3.3.2.3 Expected Actions

3.3.3 The `lastn` operation

4 Use case: Send Vital Signs

4.1 Introduction

4.2 Actors

4.3 Invocations

4.3.1 PHR: request message

4.3.1.1 Trigger Events

4.3.1.2 Message Semantics

4.3.1.2.1 Expected Actions

4.3.2 XIS: response message

4.3.2.1 Trigger Events

4.3.2.2 Message Semantics

4.3.2.3 Expected Actions

5 Terminology, NamingSystems, Mappings

5.1 Terminology

5.2 NamingSystems

5.3 Mappings

6 Release notes

Navigatiemenu

Zoeken

MedMij:V2020.01/FHIR VitalSigns: verschil tussen versies

Versie van 31 jul 2020 07:45

1 Introduction

2 Actors involved

3 Use case: Retrieve Vital Signs

3.1 Introduction

3.2 Actors

3.3 Invocations

3.3.1 PHR: request message

3.3.1.1 Trigger Events

3.3.1.2 Message Semantics

3.3.1.2.1 Expected Actions

3.3.2 XIS: response message

3.3.2.1 Trigger Events

3.3.2.2 Message Semantics

3.3.2.3 Expected Actions

3.3.3 The lastn operation

4 Use case: Send Vital Signs

4.1 Introduction

4.2 Actors

4.3 Invocations

4.3.1 PHR: request message

4.3.1.1 Trigger Events

4.3.1.2 Message Semantics

4.3.1.2.1 Expected Actions

4.3.2 XIS: response message

4.3.2.1 Trigger Events

4.3.2.2 Message Semantics

4.3.2.3 Expected Actions

5 Terminology, NamingSystems, Mappings

5.1 Terminology

5.2 NamingSystems

5.3 Mappings

6 Release notes

Navigatiemenu

Zoeken

3.3.3 The `lastn` operation