MedMij:Vprepub-2020.01/FHIR LaboratoryResults: verschil tussen versies

Uit informatiestandaarden
Naar navigatie springen Naar zoeken springen
(MM-854: Remove guidance on profile declaration, as it is included in the overarching principles)
(HOTFIX: Remove incorrect call to included template)
 
(20 tussenliggende versies door 3 gebruikers niet weergegeven)
Regel 1: Regel 1:
 
__NUMBEREDHEADINGS__
 
__NUMBEREDHEADINGS__
−
{{DISPLAYTITLE:MedMij FHIR Implementation Guide LaboratoryResults {{VersieInfo|Vprepub|Laboratoriumresultaten}}}}
+
{{DISPLAYTITLE:MedMij FHIR Implementation Guide LaboratoryResults {{VersieInfo|Laboratoriumresultaten}}}}
−
{{MedMij:Vprepub/Issuebox_FHIR_IG}}
+
{{MedMij:Vprepub-2020.01/Issuebox_FHIR_IG}}
  
 
[[Bestand:MedMij2.png |link=https://www.medmij.nl/|rechts|Naar medmij.nl]]
 
[[Bestand:MedMij2.png |link=https://www.medmij.nl/|rechts|Naar medmij.nl]]
Regel 7: Regel 7:
 
<imagemap>Bestand:Leeswijzer-technisch-banner 03 white.png|center|400px|alt=Afspraken-Functioneel-Technisch   
 
<imagemap>Bestand:Leeswijzer-technisch-banner 03 white.png|center|400px|alt=Afspraken-Functioneel-Technisch   
 
circle 241 216 211 [https://www.medmij.nl/afsprakenstelsel Afsprakenstelsel]                 
 
circle 241 216 211 [https://www.medmij.nl/afsprakenstelsel Afsprakenstelsel]                 
−
circle 1013 224 212 [[MedMij:Vprepub/OntwerpLabresult|Functioneel]]                 
+
circle 1013 224 212 [[MedMij:Vprepub-2020.01/OntwerpLabresult|Functioneel]]                 
−
circle 1787 230 212 [[MedMij:Vprepub/FHIR_IG|Technisch]]                 
+
circle 1787 230 212 [[MedMij:Vprepub-2020.01/FHIR_IG|Technisch]]                 
 
desc none                     
 
desc none                     
 
</imagemap>
 
</imagemap>
  
 
=Introduction=
 
=Introduction=
−
[[Bestand:Functioneel-02.png|link=MedMij:Vprepub/Ontwerpen |100px|rechts|Functional design|Go to functional design]]
+
[[Bestand:Functioneel-02.png|link=MedMij:Vprepub-2020.01/Ontwerpen |100px|rechts|Functional design|Go to functional design]]
  
−
This page describes patient's use cases for the retrieval of laboratory results, in a personal health environment (PHR) context. Functional specifications are described at the [[MedMij:Vprepub/Ontwerpen| functional design wiki page]]. The technical specification is described here. HL7 FHIR STU3 is used for this purpose.
+
This page describes patient's use cases for the retrieval of laboratory results, in a personal health environment (PHR) context. Functional specifications are described at the [[MedMij:Vprepub-2020.01/Ontwerpen| functional design wiki page]]. The technical specification is described here. HL7 FHIR STU3 is used for this purpose.
 +
 
 +
'''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]].
  
 
Many laboratory result observations have important relationships to other observations and need to be grouped together. [http://hl7.org/fhir/observation.html#10.1.4.1 The FHIR specification] defines three structures to do this: DiagnosticReport and DiagnosticReport.result, Observation and Observation.component, and Observation and Observation.related. For the transactions of laboratory results retrieval, the following two grouping structures are relevant.  
 
Many laboratory result observations have important relationships to other observations and need to be grouped together. [http://hl7.org/fhir/observation.html#10.1.4.1 The FHIR specification] defines three structures to do this: DiagnosticReport and DiagnosticReport.result, Observation and Observation.component, and Observation and Observation.related. For the transactions of laboratory results retrieval, the following two grouping structures are relevant.  
Regel 27: Regel 29:
 
Both structures may exist in a XIS. Therefore, two transactions are defined to retrieve a patient's laboratory results. The transaction content either consists of a single and related laboratory results structure or a complete diagnostic report that adds more clinical meaning to the single and related laboratory results. The transactions:
 
Both structures may exist in a XIS. Therefore, two transactions are defined to retrieve a patient's laboratory results. The transaction content either consists of a single and related laboratory results structure or a complete diagnostic report that adds more clinical meaning to the single and related laboratory results. The transactions:
  
−
* [[MedMij:Vprepub/FHIR_LaboratoryResults#Use_case:_retrieve_laboratory_results| Retrieve laboratory results]]
+
* [[MedMij:Vprepub-2020.01/FHIR_LaboratoryResults#Use_case:_retrieve_laboratory_results| Retrieve laboratory results]]
−
* [[MedMij:Vprepub/FHIR_LaboratoryResults#Use_case:_retrieve_laboratory_results_DiagnosticReport| Retrieve laboratory results DiagnosticReport]]
+
* [[MedMij:Vprepub-2020.01/FHIR_LaboratoryResults#Use_case:_retrieve_laboratory_results_DiagnosticReport| Retrieve laboratory results DiagnosticReport]]
  
 
=Actors involved=
 
=Actors involved=
Regel 44: Regel 46:
 
|-
 
|-
 
| Patient
 
| Patient
−
| The user of a personal healthcare enviorment.
+
| The user of a personal healthcare environment.
 
| PHR
 
| PHR
 
| Personal health record
 
| Personal health record
−
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/labresults-clientcapabilities|CapabilityStatement: Client}}
+
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/labresults-clientcapabilities|nictiz.fhir.nl.stu3.zib2017|title=CapabilityStatement: Client}}
 
| LaboratoryResults process client requirements  
 
| LaboratoryResults process client requirements  
 
|-
 
|-
Regel 54: Regel 56:
 
| XIS
 
| XIS
 
| Healthcare information system
 
| Healthcare information system
−
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/labresults-servercapabilities|CapabilityStatement: Server}}
+
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/labresults-servercapabilities|nictiz.fhir.nl.stu3.zib2017|title=CapabilityStatement: Server}}
 
| LaboratoryResults server requirements  
 
| LaboratoryResults server requirements  
 
|}
 
|}
  
 
=Use case: retrieve laboratory results=
 
=Use case: retrieve laboratory results=
 +
[[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |100px|Go to Afsprakenstelsel]]
 
{{FHIR-IG-Afsprakenstelsel-Note}}
 
{{FHIR-IG-Afsprakenstelsel-Note}}
  
Regel 71: Regel 74:
 
! style="text-align:left;"| '''Role'''
 
! style="text-align:left;"| '''Role'''
 
|-
 
|-
−
|style="background-color: white;vertical-align:top;" rowspan="3"|Retrieve Laboratory Results(PULL)
+
|style="background-color: white;vertical-align:top;" rowspan="2"|Retrieve Laboratory Results(PULL)
 
|style="background-color: white;vertical-align:top;"|Retrieve laboratory results request
 
|style="background-color: white;vertical-align:top;"|Retrieve laboratory results request
 
|style="background-color: white;vertical-align:top;"|Patient (using a PHR)
 
|style="background-color: white;vertical-align:top;"|Patient (using a PHR)
Regel 89: Regel 92:
  
 
====Message Semantics====
 
====Message Semantics====
−
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>
+
<pre>GET [base]/Observation?category=http://snomed.info/sct|49581000146104{&[parameters]}</pre>
−
GET [base]/Observation?[parameters]{&_format=[mime-type]}
 
−
</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].
 
  
 +
The PHR may use, and the XIS shall be capable of processing, the following parameters to configure the search query:
 
{| class="wikitable"  
 
{| class="wikitable"  
−
! colspan="3" style="font-weight: bold; text-align:left;" | Observation
+
! Name
 +
! Description
 +
! Examples
 
|-
 
|-
−
| style="font-weight: bold;" | Name
+
| [https://www.hl7.org/fhir/stu3/observation.html#search date]
−
| style="font-weight: bold;" | Type
+
| Obtained date/time for the result. If the result was obtained over a period, this parameter should be interpreted as a date that falls in this period.
−
| style="font-weight: bold;" | Description
+
| Retrieve all zib LaboratoryTestResults Observation resources that have an effective date greater than 01-01-2010:
 +
<pre>GET [base]/Observation?category=http://snomed.info/sct|49581000146104&date=ge2010-01-01</pre>
 +
Retrieve all zib LaboratoryTestResults Observation resources that have an effective date within a 2 year period:
 +
<pre>GET [base]/Observation?_include=Observation:specimen&category=http://snomed.info/sct|49581000146104date=ge2010-01-01&date=le2011-12-31</pre>
 
|-
 
|-
−
| date
+
| [https://www.hl7.org/fhir/stu3/observation.html#search category]
−
| date
+
| The classification of the type of observation.
−
| Obtained date/time. If the obtained element is a period, a date that falls in the period.
+
| Retrieve all zib LaboratoryTestResults Observation resources:
 +
<pre>GET [base]/Observation?category=http://snomed.info/sct|49581000146104</pre>
 
|-
 
|-
−
|category
+
| [http://hl7.org/fhir/STU3/search.html#include _include]
−
|token
+
| The PHR may request that the XIS returns resources related to the search results, in order to reduce the overall network delay of repeated retrievals of related resources.
−
|The classification of the type of observation.
+
| Retrieve all zib LaboratoryTestResults Observation resources and include Specimen information in the search results:
 +
<pre>GET [base]/Observation?_include=Observation:specimen&category=http://snomed.info/sct|49581000146104</pre>
 
|}
 
|}
−
 
−
=====Search on fixed category code=====
 
−
To distinguish the zib LaboratoryTestResults Observations from other Observation resources, such as zib DrugUse observations, a fixed category code has been added to the zib LaboratoryTestResults profile. This fixed category code is solely used for indexing and retrieval of the zib building blocks. For LaboratoryTestResult Observations this category code is SNOMED code '49581000146104' - Laboratory test finding (finding).
 
−
 
−
=====Including other resources in search results=====
 
−
The PHR may request that the XIS return resources related to the search results, in order to reduce the overall network delay of repeated retrievals of related resources. This is useful when the PHR is searching on a clinical resource, but for every such resource returned, the client will also need for example the subject (Patient resource) or performer (Organization / Practitioner resource) or Specimen resource that the clinical resource refers to. The client can use the _include parameter to indicate that the subject resources be included in the results. An example is shown below.
 
−
 
−
=====Example search URLs=====
 
−
 
−
<pre>
 
−
1. GET https://vonk.test-nictiz.nl/Observation?category=http://snomed.info/sct|49581000146104
 
−
2. GET https://vonk.test-nictiz.nl/Observation?category=http://snomed.info/sct|49581000146104&date=ge2010-01-01
 
−
3. GET https://vonk.test-nictiz.nl/Observation?category=http://snomed.info/sct|49581000146104&date=ge2010-01-01&date=le2011-12-31
 
−
4. GET https://vonk.test-nictiz.nl/Observation?_include=Observation:specimen&category=http://snomed.info/sct|49581000146104date=ge2010-01-01&date=le2011-12-31</pre>
 
−
 
−
# Retrieves all zib LaboratoryTestResults Observation resources
 
−
# Retrieves all zib LaboratoryTestResults Observation resources that have an effective date greater than 01-01-2010.
 
−
# Retrieves all zib LaboratoryTestResults Observation resources that have an effective date within a 2 year period.
 
−
# Retrieves all zib LaboratoryTestResults Observation resources that have an effective date within a 2 year period and includes Specimen information in the search results.
 
  
 
=====Expected Actions=====
 
=====Expected Actions=====
Regel 143: Regel 130:
  
 
====Message Semantics====
 
====Message Semantics====
−
Based on the query 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 SHOULD include a FHIR OperationOutcome resource with more details on the failure. If the request message is processed successfully, whether or not any observation resources are found, the HTTP status code SHALL be 200.  
+
The returned data to the PHR should conform to the HCIMs and their associated profiles listed in the table below. The resources in the response message SHALL be a valid instance of these profiles. All resources SHALL include their related profile canonical URL in the ''meta.profile'' element in order to show compliance.  
  
−
The response message shall be a Bundle resource of type "searchset" containing zero or more FHIR resources as entries. 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:
+
{{MedMij:Vprepub-2020.01/NoteBoxPackage|p1=nictiz.fhir.nl.stu3.zib2017}}
−
*[http://hl7.org/fhir/STU3/http.html RESTful API framework]
 
−
*[http://hl7.org/fhir/STU3/search.html#errors Search errors]
 
−
*[http://hl7.org/fhir/STU3/bundle.html Bundle resource]
 
−
*[http://hl7.org/fhir/operationoutcome.html OperationOutcome resource]
 
−
 
 
−
=====Message resource content=====
 
−
The returned data to the PHR should conform to the profiles listed in the table below. This table shows the relevant zibs and their related profiles.
 
−
 
 
−
{{NoteBoxPackage|https://simplifier.net/NictizSTU3-Zib2017/~packages|1.3.x|MedMij:Vprepub/FHIR_IG}}
 
  
 
{| class="wikitable" width="1400px"
 
{| class="wikitable" width="1400px"
Regel 164: Regel 142:
 
| #Zib Patient|Patient
 
| #Zib Patient|Patient
 
| Patient
 
| Patient
−
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient}}
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Zorgverlener
 
| Zorgverlener
 
| HealthProfessional
 
| HealthProfessional
 
| Practitioner
 
| Practitioner
−
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner}}
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Zorgaanbieder
 
| Zorgaanbieder
 
| HealthcareProvider
 
| HealthcareProvider
 
| Organization
 
| Organization
−
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization}}
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| LaboratoriumUitslag
 
| LaboratoriumUitslag
 
| LaboratoryTestResult
 
| LaboratoryTestResult
 
| Observation
 
| Observation
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation|nictiz.fhir.nl.stu3.zib2017}}
 
|}
 
|}
−
{{Sjabloon:Voorbeelden}}
+
 
 
====Expected Actions====
 
====Expected Actions====
 
The PHR shall process the results according to application-defined rules. The PHR should be robust as the response may contain observation and specimen resources that match the query parameters.
 
The PHR shall process the results according to application-defined rules. The PHR should be robust as the response may contain observation and specimen resources that match the query parameters.
−
 
−
==Interactions, operations, search parameters==
 
−
===Interactions===
 
−
The following logical interactions are needed for the retrieve laboratory results transaction:
 
−
* [http://hl7.org/fhir/STU3/http.html#search Search]
 
−
 
−
===Operations===
 
−
No operations are defined or needed for this transaction.
 
−
 
−
===Search parameters===
 
−
The following search parameter type needs 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]
 
−
 
−
Search result parameters:
 
−
{| class=wikitable
 
−
! Parameter !! Type !! Description
 
−
|-
 
−
| [http://hl7.org/fhir/STU3/search.html#include _include] || || To request inclusion of indicated resources, referenced from the Laboratory Results
 
−
|-
 
−
| [http://hl7.org/fhir/STU3/observation.html#search date] || [http://hl7.org/fhir/STU3/search.html#date date] || Obtained date/time. If the obtained element is a period, a date that falls in the period
 
−
|}
 
−
 
−
==Examples==
 
  
 
=Use case: retrieve laboratory results DiagnosticReport=
 
=Use case: retrieve laboratory results DiagnosticReport=
 +
[[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |100px|Go to Afsprakenstelsel]]
 
{{FHIR-IG-Afsprakenstelsel-Note}}
 
{{FHIR-IG-Afsprakenstelsel-Note}}
  
Regel 224: Regel 177:
 
! style="text-align:left;"| '''Role'''
 
! style="text-align:left;"| '''Role'''
 
|-
 
|-
−
|style="background-color: white;vertical-align:top;" rowspan="3"|Retrieve Laboratory Results(PULL)
+
|style="background-color: white;vertical-align:top;" rowspan="2"|Retrieve Laboratory Results(PULL)
 
|style="background-color: white;vertical-align:top;"|Retrieve laboratory diagnostic report request
 
|style="background-color: white;vertical-align:top;"|Retrieve laboratory diagnostic report request
 
|style="background-color: white;vertical-align:top;"|Patient (using a PHR)
 
|style="background-color: white;vertical-align:top;"|Patient (using a PHR)
Regel 244: Regel 197:
 
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 DiagnosticReport 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 RESTfull] and [http://hl7.org/fhir/search.html search] specification against the XIS's DiagnosticReport endpoint. This search query URL is configurable by the PHR and has the following format.
 
   
 
   
−
<pre>
+
<pre>GET [base]/DiagnosticReport?category=http://snomed.info/sct|4241000179101{&[parameters]}</pre>
−
GET [base]/DiagnosticReport?[parameters]{&_format=[mime-type]}
 
−
</pre>
 
  
−
=====Search Parameters=====
+
The PHR may use, and the XIS shall be capable of processing, the following parameters to configure the search query:
−
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/diagnosticreport.html#search DiagnosticReport].
 
  
 
{| class="wikitable"  
 
{| class="wikitable"  
−
! colspan="3" style="font-weight: bold; text-align:left;" | DiagnosticReport
+
! Name
 +
! Description
 +
! Example(s)
 
|-
 
|-
−
| style="font-weight: bold;" | Name
+
| [https://www.hl7.org/fhir/stu3/diagnosticreport.html#search date]
−
| style="font-weight: bold;" | Type
 
−
| style="font-weight: bold;" | Description
 
−
|-
 
−
| date
 
−
| date
 
 
| The clinically relevant time of the report.
 
| The clinically relevant time of the report.
 +
| Retrieve all zib LaboratoryTestResult DiagnosticReport resources that have an effective date greater than 01-01-2010.
 +
<pre>GET [base]/DiagnosticReport?category=http://snomed.info/sct|4241000179101&date=ge2010-01-01</pre>
 +
Retrieve all zib LaboratoryTestResult DiagnosticReport resources that have an effective date within a 2 year period.
 +
<pre>GET [base]/DiagnosticReport?category=http://snomed.info/sct|4241000179101&date=ge2010-01-01&date=le2011-12-31</pre>
 
|-
 
|-
−
| category
+
| [https://www.hl7.org/fhir/stu3/diagnosticreport.html#search category]
−
| token
 
 
| Which diagnostic discipline/department created the report.
 
| Which diagnostic discipline/department created the report.
 +
|-
 +
| [http://hl7.org/fhir/STU3/search.html#include _include]
 +
| The PHR may request that the XIS returns resources related to the search results, in order to reduce the overall net
 +
| Retrieves all zib LaboratoryTestResult DiagnosticReport resources and include the referenced Observation resources in the search results.
 +
<pre>GET [base]/DiagnosticReport?category=http://snomed.info/sct|4241000179101&include=DiagnosticReport:result&date=ge2010-01-01&date=le2011-12-31</pre>
 
|}
 
|}
−
 
−
=====Search on zib LaboratoryTestResult DiagnosticReport=====
 
−
A fixed category code has been added to the zib LaboratoryTestResults profile to distinguish the zib LaboratoryTestResult DiagnosticReports between other DiagnosticReport resources. This fixed category code is solely used for indexing and retrieval of the zib building blocks. For LaboratoryTestResult DiagnosticReport this category is SNOMED code '4241000179101' - Laboratory report (record artifact).
 
−
 
−
=====Including other resources in searchresults=====
 
−
The PHR may request that the XIS return resources related to the search results, in order to reduce the overall network delay of repeated retrievals of related resources. This is useful when the PHR is searching on a clinical resource, but for every such resource returned, the client will also need for example the subject (Patient resource) or performer (Organization / Practitioner resource) or the Observation resource that the clinical resource refers to. The client can use the _include parameter to indicate that the subject resources be included in the results. An example is shown below.
 
−
 
−
=====Example search URLs=====
 
−
<pre>
 
−
1. GET https://vonk.test-nictiz.nl/DiagnosticReport?category=http://snomed.info/sct|4241000179101
 
−
2. GET https://vonk.test-nictiz.nl/DiagnosticReport?category=http://snomed.info/sct|4241000179101&date=ge2010-01-01
 
−
3. GET https://vonk.test-nictiz.nl/DiagnosticReport?category=http://snomed.info/sct|4241000179101&date=ge2010-01-01&date=le2011-12-31
 
−
4. GET https://vonk.test-nictiz.nl/DiagnosticReport?category=http://snomed.info/sct|4241000179101&include=DiagnosticReport:result&date=ge2010-01-01&date=le2011-12-31 </pre>
 
−
 
−
# Retrieves all zib LaboratoryTestResult DiagnosticReport resources
 
−
# Retrieves all zib LaboratoryTestResult DiagnosticReport resources that have an effective date greater than 01-01-2010.
 
−
# Retrieves all zib LaboratoryTestResult DiagnosticReport resources that have an effective date within a 2 year period.
 
−
# Retrieves all zib LaboratoryTestResult DiagnosticReport resources that have an effective date within a 2 year period and include the referenced Observation resources in the search results.
 
  
 
=====Expected Actions=====
 
=====Expected Actions=====
Regel 295: Regel 232:
  
 
====Message Semantics====
 
====Message Semantics====
−
Based on the query 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 SHOULD include a FHIR OperationOutcome resource with more details on the failure. If the request message is processed successfully, whether or not any DiagnosticReport resources are found, the HTTP status code SHALL be 200.
+
The returned data to the PHR should conform to the HCIMS and their associate profiles listed in the table below. The resources in the response message SHALL be a valid instance of these profiles. All resources SHALL include their related profile canonical URL in the ''meta.profile'' element in order to show compliance.  
−
 
 
−
The response message shall be a Bundle resource of type "searchset" containing zero or more FHIR resources as entries. 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/http.html RESTful API framework]
 
−
*[http://hl7.org/fhir/STU3/search.html#errors Search errors]
 
−
*[http://hl7.org/fhir/STU3/bundle.html Bundle resource]
 
−
*[http://hl7.org/fhir/operationoutcome.html OperationOutcome resource]
 
−
 
 
−
=====Message resource content=====
 
−
The returned data to the PHR should conform to the profiles listed in the table below. This table shows the relevant zibs and their related profiles.
 
  
−
{{NoteBoxPackage|https://simplifier.net/NictizSTU3-Zib2017/~packages|1.3.x|MedMij:Vprepub/FHIR_IG}}
+
{{MedMij:Vprepub-2020.01/NoteBoxPackage|p1=nictiz.fhir.nl.stu3.zib2017|v1Min=2.0.0}}
  
 
{| class="wikitable" width="1400px"
 
{| class="wikitable" width="1400px"
Regel 316: Regel 244:
 
| #Zib Patient|Patient
 
| #Zib Patient|Patient
 
| Patient
 
| Patient
−
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient}}
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Zorgverlener
 
| Zorgverlener
 
| HealthProfessional
 
| HealthProfessional
 
| Practitioner
 
| Practitioner
−
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner}}
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Zorgaanbieder
 
| Zorgaanbieder
 
| HealthcareProvider
 
| HealthcareProvider
 
| Organization
 
| Organization
−
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization}}
+
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| rowspan="2" | LaboratoriumUitslag
 
| rowspan="2" | LaboratoriumUitslag
 
| rowspan="2" | LaboratoryTestResult
 
| rowspan="2" | LaboratoryTestResult
 
| DiagnosticReport
 
| DiagnosticReport
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-DiagnosticReport}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-DiagnosticReport|nictiz.fhir.nl.stu3.zib2017}}
 
|-
 
|-
 
| Observation
 
| Observation
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation|nictiz.fhir.nl.stu3.zib2017}}
 
|}
 
|}
−
{{Sjabloon:Voorbeelden}}
+
 
 
====Expected Actions====
 
====Expected Actions====
 
The PHR shall process the results according to application-defined rules. The PHR should be robust as the response may contain DiagnosticReport, Observation and Specimen resources that match the query parameters.
 
The PHR shall process the results according to application-defined rules. The PHR should be robust as the response may contain DiagnosticReport, Observation and Specimen resources that match the query parameters.
−
 
−
==Interactions, operations, search parameters==
 
−
===Interactions===
 
−
The following logical interactions are needed for the retrieve laboratory results transaction:
 
−
* [http://hl7.org/fhir/STU3/http.html#search Search]
 
−
 
−
===Operations===
 
−
No operations are defined or needed for this transaction.
 
−
 
−
===Search parameters===
 
−
The following search parameter types 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]
 
−
 
−
Search result parameters:
 
−
{| class=wikitable
 
−
! Parameter !! Type !! Description
 
−
|-
 
−
| [http://hl7.org/fhir/STU3/search.html#include _include] || || To request inclusion of indicated resources, referenced from the Laboratory Results
 
−
|-
 
−
| [http://hl7.org/fhir/STU3/diagnosticreport.html#search date] || [http://hl7.org/fhir/STU3/search.html#date date] || The clinically relevant time of the report
 
−
|}
 
−
 
−
=Terminology, NamingSystems, Mappings=
 
−
 
−
===Terminology===
 
−
Relevant ValueSets can be found through the ValueSet bindings in the listed StructureDefinitions. All ValueSets can be found here [https://simplifier.net/NictizSTU3-Zib2017/~resources?category=ValueSet here] and can be downloaded as a .zip in XML or JSON format.
 
−
 
−
===NamingSystems===
 
−
Relevant NamingSystems can be found [https://simplifier.net/NictizSTU3-Zib2017/~resources?category=NamingSystem here].
 
−
 
−
===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 [https://simplifier.net/NictizSTU3-Zib2017/~resources?category=ConceptMap here].
 
−
 
−
An explanation about mappings can be found at [[MedMij:Vprepub/FHIR_IG#Mapping_of_coded_concepts|Mapping of coded concepts]].
 
  
 
=Release notes=
 
=Release notes=
−
Release notes can be found on the [[MedMij:Vprepub/OntwerpLabresult#Release_notes| functional design page]].
+
Release notes can be found on the [[MedMij:Vprepub-2020.01/OntwerpLabresult#Release_notes| functional design page]].

Huidige versie van 30 mrt 2021 om 11:36


Issue icon.png

Work in progress - See official publication here.

Naar medmij.nl
Medication process
AfsprakenstelselFunctioneelTechnischAfspraken-Functioneel-Technisch

1 Introduction

Go to functional design

This page describes patient's use cases for the retrieval of laboratory results, in a personal health environment (PHR) context. Functional specifications are described at the functional design wiki page. The technical specification is described here. HL7 FHIR STU3 is used for this purpose.

Note: This implementation guide builds on the general guidelines described in the use case overarching principles.

Many laboratory result observations have important relationships to other observations and need to be grouped together. The FHIR specification defines three structures to do this: DiagnosticReport and DiagnosticReport.result, Observation and Observation.component, and Observation and Observation.related. For the transactions of laboratory results retrieval, the following two grouping structures are relevant.

1.1 Observation

Individual laboratory results are represented by Observation resources, such as one blood glucose value. The Observation resource can also be used as a structure for a panel or battery observation. Observation.related is used for any supporting result that can be interpreted and used on its own and has one or more different values for method, observation, performer, device, time, and/or error conditions. The top-level observation specifies the grouping code in Observation.code, but typically does not have its own Observation.value, and the set of member observations are listed in the Observation.related element.

1.2 DiagnosticReport

In contrast to the Observation resource, the DiagnosticReport resource typically includes additional clinical context and some mix of atomic results, images, imaging reports, textual and coded interpretation, and formatted representations. Report conclusions can be expressed as a simple text blob, structured coded data or as an attached fully formatted report such as a PDF. The DiagnosticReport.code names the panel and serves as the grouping element, which is traditionally referred to as a "panel" or "battery" by laboratories. The DiagnosticReport.result element references the individual observations.

Both structures may exist in a XIS. Therefore, two transactions are defined to retrieve a patient's laboratory results. The transaction content either consists of a single and related laboratory results structure or a complete diagnostic report that adds more clinical meaning to the single and related laboratory results. The transactions:

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 Verwijzing.png CapabilityStatement: Client LaboratoryResults process client requirements
Healthcare professional The user of a XIS XIS Healthcare information system Verwijzing.png CapabilityStatement: Server LaboratoryResults server requirements

3 Use case: retrieve laboratory results

Go to Afsprakenstelsel

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 laboratory results transaction is used by the PHR to retrieve laboratory results from a XIS.

3.2 Actors

Transaction group Transaction Actor Role
Retrieve Laboratory Results(PULL) Retrieve laboratory results request Patient (using a PHR) Request laboratory results from the XIS
Retrieve laboratory results response Healthcare professional (using a XIS) Serves laboratory results 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 laboratory results, it issues a retrieve laboratory results request message.

3.3.1.2 Message Semantics

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?category=http://snomed.info/sct|49581000146104{&[parameters]}

The PHR may use, and the XIS shall be capable of processing, the following parameters to configure the search query:

Name Description Examples
date Obtained date/time for the result. If the result was obtained over a period, this parameter should be interpreted as a date that falls in this period. Retrieve all zib LaboratoryTestResults Observation resources that have an effective date greater than 01-01-2010: 
GET [base]/Observation?category=http://snomed.info/sct|49581000146104&date=ge2010-01-01

Retrieve all zib LaboratoryTestResults Observation resources that have an effective date within a 2 year period: 

GET [base]/Observation?_include=Observation:specimen&category=http://snomed.info/sct|49581000146104date=ge2010-01-01&date=le2011-12-31
category The classification of the type of observation. Retrieve all zib LaboratoryTestResults Observation resources: 
GET [base]/Observation?category=http://snomed.info/sct|49581000146104
_include The PHR may request that the XIS returns resources related to the search results, in order to reduce the overall network delay of repeated retrievals of related resources. Retrieve all zib LaboratoryTestResults Observation resources and include Specimen information in the search results: 
GET [base]/Observation?_include=Observation:specimen&category=http://snomed.info/sct|49581000146104
3.3.1.2.1 Expected Actions

The XIS shall process the query to discover Observation resources that match the search parameters given.

3.3.2 XIS: response message

The XIS returns an HTTP Status code appropriate to the processing as well as a FHIR Bundle including the matching observation information.

3.3.2.1 Trigger Events

The XIS completed processing of the retrieve laboratory results request message.

3.3.2.2 Message Semantics

The returned data to the PHR should conform to the HCIMs and their associated profiles listed in the table below. The resources in the response message SHALL be a valid instance of these profiles. All resources SHALL include their related profile canonical URL in the meta.profile element in order to show compliance.


Em.png

MedMij uses the FHIR Packaging mechanism. This conveniently bundles all profiles, terminology, example material and other conformance resources you need into a single archive, which can be downloaded or installed using the appropriate FHIR tooling. This version of the information standard uses the following packages:

Note: packages use Semantic Versioning. Other versions can be used at will as long as they have the same major.minor number or a minor number higher than the stated version.

Zib name NL Zib name EN FHIR Resource
Patient Patient Patient http://fhir.nl/fhir/StructureDefinition/nl-core-patient
Zorgverlener HealthProfessional Practitioner http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner
Zorgaanbieder HealthcareProvider Organization http://fhir.nl/fhir/StructureDefinition/nl-core-organization
LaboratoriumUitslag LaboratoryTestResult Observation http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation

3.3.2.3 Expected Actions

The PHR shall process the results according to application-defined rules. The PHR should be robust as the response may contain observation and specimen resources that match the query parameters.

4 Use case: retrieve laboratory results DiagnosticReport

Go to Afsprakenstelsel

This FHIR implementation guide assumes that the PHR system is able to make a connection to the right XIS that contains the patient's information. It does not provide information on finding the right XIS nor does it provide information about security. Moreover, each transaction is performed in the context of a specific authenticated patient, for whose context (token) has been established using the authentication mechanisms described in the 'Afsprakenstelsel'. Each XIS Gateway is required to perform filtering based on the patient associated with the context for the request, so only the records associated with the authenticated patient are returned. For this reason, search parameters should not be included for patient identification.

4.1 Introduction

The retrieve laboratory diagnostic report transaction is used by the PHR to retrieve laboratory results from a XIS.

4.2 Actors

Transaction group Transaction Actor Role
Retrieve Laboratory Results(PULL) Retrieve laboratory diagnostic report request Patient (using a PHR) Request laboratory diagnostic report from the XIS
Retrieve laboratory diagnostic report response Healthcare professional (using a XIS) Serves laboratory diagnostic report to the PHR

4.3 Invocations

4.3.1 PHR: request message

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

4.3.1.1 Trigger Events

When the patient(PHR) wants to obtain laboratory diagnostic report, it issues a retrieve laboratory diagnostic report request message.

4.3.1.2 Message Semantics

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

GET [base]/DiagnosticReport?category=http://snomed.info/sct|4241000179101{&[parameters]}

The PHR may use, and the XIS shall be capable of processing, the following parameters to configure the search query:

Name Description Example(s)
date The clinically relevant time of the report. Retrieve all zib LaboratoryTestResult DiagnosticReport resources that have an effective date greater than 01-01-2010. 
GET [base]/DiagnosticReport?category=http://snomed.info/sct|4241000179101&date=ge2010-01-01

Retrieve all zib LaboratoryTestResult DiagnosticReport resources that have an effective date within a 2 year period. 

GET [base]/DiagnosticReport?category=http://snomed.info/sct|4241000179101&date=ge2010-01-01&date=le2011-12-31
category Which diagnostic discipline/department created the report.
_include The PHR may request that the XIS returns resources related to the search results, in order to reduce the overall net Retrieves all zib LaboratoryTestResult DiagnosticReport resources and include the referenced Observation resources in the search results. 
GET [base]/DiagnosticReport?category=http://snomed.info/sct|4241000179101&include=DiagnosticReport:result&date=ge2010-01-01&date=le2011-12-31
4.3.1.2.1 Expected Actions

The XIS shall process the query to discover DiagnosticReport resources that match the search parameters given.

4.3.2 XIS: response message

The XIS returns an HTTP Status code appropriate to the processing as well as a FHIR Bundle including the matching laboratory diagnostic report information.

4.3.2.1 Trigger Events

The XIS completed processing of the retrieve laboratory diagnostic report request message.

4.3.2.2 Message Semantics

The returned data to the PHR should conform to the HCIMS and their associate profiles listed in the table below. The resources in the response message SHALL be a valid instance of these profiles. All resources SHALL include their related profile canonical URL in the meta.profile element in order to show compliance.


Em.png

MedMij uses the FHIR Packaging mechanism. This conveniently bundles all profiles, terminology, example material and other conformance resources you need into a single archive, which can be downloaded or installed using the appropriate FHIR tooling. This version of the information standard uses the following packages:

Note: packages use Semantic Versioning. Other versions can be used at will as long as they have the same major.minor number or a minor number higher than the stated version.

Zib name NL Zib name EN FHIR Resource
Patient Patient Patient http://fhir.nl/fhir/StructureDefinition/nl-core-patient
Zorgverlener HealthProfessional Practitioner http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner
Zorgaanbieder HealthcareProvider Organization http://fhir.nl/fhir/StructureDefinition/nl-core-organization
LaboratoriumUitslag LaboratoryTestResult DiagnosticReport http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-DiagnosticReport
Observation http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation

4.3.2.3 Expected Actions

The PHR shall process the results according to application-defined rules. The PHR should be robust as the response may contain DiagnosticReport, Observation and Specimen resources that match the query parameters.

5 Release notes

Release notes can be found on the functional design page.

Overgenomen van "https://informatiestandaarden.test-nictiz.nl/index.php?title=MedMij:Vprepub-2020.01/FHIR_LaboratoryResults&oldid=58192"