Brontekst bekijken van MedMij:Vissue-MM-3705 FHIR MedicationProcess

{{IssuePaginaWaarschuwing|MM-3705|MedMij:V2019.01_FHIR_MedicationProcess}}
__NOINDEX__
__NUMBEREDHEADINGS__
{{DISPLAYTITLE:MedMij FHIR Implementation Guide Medication Process {{VersieInfo|Medicatieproces|release=V2019.01}}}}

[[Bestand:MedMij2.png |link=https://www.medmij.nl/|rechts|Naar medmij.nl]]
[[Bestand:Medication_Icoon.png|link=|85px|links|Use case Medication|Medication process]] 
<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-2019.01_OntwerpMedicatie|Functional]]                
circle 1787 230 212 [[MedMij:Vprepub-2019.01_FHIR_IG|Tecnical]]
desc none                    
</imagemap>

__TOC__

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

This page describes patient's use cases, in a personal health record (PHR) context, in relation to the information standard [https://www.nictiz.nl/standaardisatie/informatiestandaarden/informatiestandaard-medicatieproces/ Medication Process] (MP). These use cases are based on version 9.x of this standard. Functional specification of these use cases are described in the [[MedMij:Vprepub-2019.01_Ontwerpen| functional design wiki page]]. The technical specification is described here. HL7 FHIR STU3 is used for this purpose.

The Medication Process information building blocks are adopted by 'Registratie aan de Bron' and converted to Health and Care Information models (HCIM), also called zibs. In order to exchange medication information between systems, FHIR representations of these HCIMs are made and used in the transactions described on this page.

Use cases:
* [[MedMij:Vprepub-2019.01_FHIR_MedicationProcess#Use_case:_retrieve_medication_overview|Retrieve a medication overview]]
* [[MedMij:Vprepub-2019.01_FHIR_MedicationProcess#Use_case:_retrieve_medication_information|Retrieve medication information]]
* [[MedMij:Vprepub-2019.01_FHIR_MedicationProcess#Use_case:_retrieve_Dispense612ToFHIRConversion_from_the_LSP|Retrieve Dispense612ToFHIRConversion]]

=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 enviorment.
| PHR
| Personal health record
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/medication-clientcapabilities|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12|title=CapabilityStatement: Client}}
| Medication process client requirements 
|-
| Healthcare professional
| The user of a XIS
| XIS
| Healthcare information system
|[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/medication-servercapabilities|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12|title=CapabilityStatement: Server}}
| Medication process server requirements 
|}

=Use case: retrieve medication overview=
{{StartUitgefaseerdVrijeTekst|The use case "retrieve medication overview" has been deprecated as of 2022-10-25. This use case can no longer be used on the MedMij network. The other two use cases described on this page are still active.}}
{{FHIR-IG-Afsprakenstelsel-Note}}

==Introduction==
The retrieve medication overview transaction is used by the PHR to retrieve a medication overview 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 Medication Overview(PULL)
|style="background-color: white;vertical-align:top;"|Retrieve medication overview request
|style="background-color: white;vertical-align:top;"|Patient (using a PHR)
|style="background-color: white;vertical-align:top;"|Request medication overview from the XIS
|-
|style="background-color: white;vertical-align:top;"|Retrieve medication overview response
|style="background-color: white;vertical-align:top;"|Healthcare professional (using a XIS)
|style="background-color: white;vertical-align:top;"|Serves medication overview to the PHR
|}

==Invocations==
===PHR: request message===
This message uses an extended operation on the RESTful API to obtain a medication overview from a XIS. This operation is used because the XIS needs to play an active role in formulating the content of the response.

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

====Message Semantics====
The PHR executes a medication-overview operation with HTTP POST against the XIS's base endpoint as shown below.

<pre>
POST [base]/$medication-overview
</pre>

=====Expected Actions=====
The XIS shall process the operation to find or generate and return the current medication overview.

===XIS: response message===
The XIS returns a HTTP Status code appropriate to the processing of the operation as well as a Bundle of type 'searchset', containing one List and one Patient resource along with other resources that represent the Medication Overview.

====Trigger Events====
The XIS completed processing of the retrieve medication overview request message.

====Message Semantics====
Based on the medication-overview operation 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 a Medication Overview is found or generated, the HTTP status code shall be 200. 

The body of the response message shall be a Bundle resource of type "searchset". The following section will elaborate on the content included.

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/operations.html Operations]
*[http://hl7.org/fhir/STU3/bundle.html Bundle resource]
*[http://hl7.org/fhir/operationoutcome.html OperationOutcome resource]

=====Message content=====
The outcome of the {{Simplifier|http://nictiz.nl/fhir/OperationDefinition/Medication-Overview|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12|title=medication-overview operation}} is the body of the medication overview request message. Successful processing of this operation should result in a Bundle recourse, containing one List and one Patient resource as entries along with all the resources that represent the current medication overview. These resources SHALL be referenced from the List resource. The clinical content of the medication overview is defined in the [https://informatiestandaarden.nictiz.nl/wiki/mp:V9.0.7_Ontwerp_medicatieproces#Medicatieoverzicht_en_afleidingsregels Medication Process specification]. The functional dataset of the medication overview can be found on [http://decor.nictiz.nl/medicatieproces/mp-html-20170829T141253/tr-2.16.840.1.113883.2.4.3.11.60.20.77.4.148-2016-11-08T103441.html decor.nictiz.nl].

The content in the response message SHALL be a valid instance of the following profiles. Clicking on the link will open the formal definition on Simplifier.net.

* '''Bundle profile:''' {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/Bundle-MedicationOverview|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
* '''List profile:''' {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/MedicationOverview|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}

The Bundle profile represents the structure of the retrieve medication overview response message. The List profile represents the actual medication overview. The List contains the medication overview metadata and references to all resources that constitute the medication overview. These resources are included in the Bundle as entries. The Bundle.total value contains the number of matching HCIMs: MedicationUse, AdministrationAgreement and MedicationAgreement. Other included resources, such as Medication resources, are not included in the total. The returned Bundle has at least one List and one Patient resource. 

All returned resources to the PHR, including the Bundle and List, SHALL include their related profile canonical URL in the ''meta.profile'' element in order to show compliance. The resources in the response message SHALL be a valid instance of these profiles. In the table below, the HCIMs that constitute the clinical content of the Medication Overview and their respective profiles are listed. 

'''Note''' that the medication building blocks are grouped per 'medication treatment' conform the [https://informatiestandaarden.nictiz.nl/wiki/mp:V9.0.7_Ontwerp_medicatieproces#Medicamenteuze_behandeling Medication Process specification]. Grouping SHALL be done by use of a 'medication treatment' identifier. This identifier shall be the same across different related medication resources that constitute a medication treatment. The {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12|title=zib-Medication-MedicationTreatment extension}} is added to all medication profiles and can be used for this grouping purpose.

{{NoteBoxPackage|https://simplifier.net/packages/nictiz.fhir.nl.stu3.zib2017|1.3.x|MedMij:V2019.01_FHIR_IG}}

{| class="wikitable" 
|-style="background-color: #1F497D; color: white; font-weight: bold; "
|HCIM name NL||HCIM name EN||FHIR Resource||FHIR Profile
|-style="vertical-align:top; background-color: #E3E3E3; 
|-
| Patient
| #HCIM Patient|Patient
| Patient
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Zorgverlener
| HealthProfessional
| Practitioner
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Zorgaanbieder
| HealthcareProvider
| Organization
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Medicatiegebruik||MedicationUse||MedicationStatement|| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Toedieningsafspraak||AdministrationAgreement||MedicationDispense|| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Medicatieafspraak||MedicationAgreement||MedicationRequest|| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAgreement|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Product||Product||Medication|| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Product|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| GebruiksInstructie||InstructionsForUse||Dosage (datatype)|| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-InstructionsForUse|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
|}

====Expected Actions====
The PHR processes the results according to application-defined rules. The PHR should be robust as the response may contain medication information resources as mentioned in the former section.

==Interactions, operations, search parameters== 
===Interactions===
No interactions are needed for the retrieve medication overview transaction.

===Operations===
The retrieve medication overview medication operation is used for this transaction. The formal definition can be found here:
* {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/MedicationOverview|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12|title=Medication Overview}}

===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]
{{EindUitgefaseerd}}

=Use case: retrieve medication information=
{{FHIR-IG-Afsprakenstelsel-Note}}

==Introduction==
The Retrieve Medication Information transaction is used by the PHR to retrieve medication information from the XIS. The PHR can use this transaction to retrieve the desired information by searching on specific medication building blocks.

==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 Medication Information(PULL)
|style="background-color: white;vertical-align:top;"|Retrieve medication information request
|style="background-color: white;vertical-align:top;"|Patient (using a PHR)
|style="background-color: white;vertical-align:top;"|Request medication information from the XIS
|-
|style="background-color: white;vertical-align:top;"|Retrieve medication information response
|style="background-color: white;vertical-align:top;"|Healthcare professional (using a XIS)
|style="background-color: white;vertical-align:top;"|Serves medication information to the PHR
|}

==Invocations==
===PHR: request message===
This message uses the HTTP GET method parameterized query to obtain medication information from a XIS. Multiple different HTTP GET request messages may be needed to retrieve all medication information.

====Trigger Events====
When the patient (PHR) wants to obtain medication information matching various parameters, it issues a retrieve medication information request message.

====Message Semantics====
The PHR executes an HTTP GET against the XIS's medication FHIR endpoints. These endpoints can be one of the following: 
* MedicationRequest
* MedicationDispense
* MedicationStatement 

The search interaction is performed by an HTTP GET conform the [http://hl7.org/fhir/STU3/search.html FHIR search specification], as shown below. This URL is configurable by the PHR by configuring the query search parameters and search control parameters to modify the behaviour of the XIS such as response format, or pagination. 

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

=====Search on category code=====
To distinguish the medication HCIMs between each other and between general medication resources, a fixed category coding has been added to the medication HCIM profiles (listed below in the Message content section). The fixed category code is solely used for indexing and retrieval of the HCIM building blocks.

=====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 the subject (Patient resource) or prescriber (Practitioner resource) or medication that the clinical resource refers to. The client can use the _include parameter to indicate that the subject resources be included in the results. Example search:

<pre>
GET [base]/MedicationRequest?category=http://snomed.info/sct|16076005&_include=MedicationRequest:medication
</pre>

This search interaction finds all MedicationRequest that represent the HCIM MedicationAgreement and if present includes the referenced Medication resource.

====Query Search Parameters====
The PHR may supply, and the XIS SHALL be capable of processing, all query parameters listed in the table below. The XIS may choose to support additional query parameters beyond the subset listed below. Any additional query parameters supported shall be supported according to the core FHIR specification. Such additional parameters are considered out of scope for this transaction.

{| class="wikitable"
! style="font-weight: bold;text-align:left;" | MP9 search parameters
! style="font-weight: bold;text-align:left;" | Description
! style="font-weight: bold;text-align:left;" | FHIR search parameter
! style="font-weight: bold;text-align:left;" | FHIR resource
|-
| Identification
| Search on identifier.
| identifier
| MedicationRequest, MedicationDispense, MedicationStatement
|-
| Type
| Search on type of medication building block (HCIM). 
| category '''*''' / '''**'''
| MedicationRequest, MedicationDispense, MedicationStatement
|-
| ProductCode
| Search on medication code.
| code
| MedicationRequest, MedicationDispense, MedicationStatement, Medication
|-
| UsePeriod
| Search on medication use in the past, present or future within the specified time period.
| periodofuse '''**'''
| MedicationDispense, MedicationRequest
|-
| DispensePeriod 
| Returns all medication dispenses within the specific period.
| whenhandedover
| MedicationDispense
|-
| MedicationTreatment
| Search on the medication treatment identifier
| medicationtreatment '''**'''
| MedicationRequest, MedicationDispense, MedicationStatement, System Wide
|}

'''*''' The FHIR profiles that represent the medication building blocks contain fixed code values in the ''.category'' elements to allow searching on specific medication building blocks. FHIR resource MedicationDispense does not contain a 'category' search parameter in the FHIR specification. Custom search parameters are provided.  

'''**''' The search parameter consists of a custom created FHIR search parameter not represented in the FHIR specification. 

=====Custom Search Parameters=====

The following custom search parameters are defined for this use case:

* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/Medications-category|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/Medications-periodofuse|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}} [[#Search_parameters_2|*]]
* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/Medications-medicationtreatment|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}

====Example Searches====

'''Identifier'''
<pre>1. [base]/MedicationRequest?identifier=http://example.nl/fhir/NamingSystem/MedicationRequest|999922448 </pre>
# Retrieves a MedicationRequest resource with the identifier 999922448.

'''Type'''
<pre>1. [base]/MedicationRequest 
2. [base]/MedicationRequest?category=http://snomed.info/sct|16076005</pre>
# Retrieves all MedicationRequest resources.
# Retrieves all MedicationRequest resources that represent a HCIM MedicationAgreement.

'''ProductCode'''
<pre>1. [base]/MedicationRequest?medication.code=urn:oid:2.16.840.1.113883.2.4.4.8|13610554
2. [base]/MedicationRequest?medication.code=urn:oid:2.16.840.1.113883.2.4.4.8|13610554&_include=MedicationRequest:medication
3. [base]/MedicationRequest?category=http://snomed.info/sct|16076005&medication.code=urn:oid:2.16.840.1.113883.2.4.4.8|13610554</pre>
# Retrieves all MedicationRequest resources that have Carbasalaatcalcium Sandoz 600 30 as medication.
# Retrieves all MedicationRequest resources that have Carbasalaatcalcium Sandoz 600 30 as medication and includes the Medication resource in the search results.
# Retrieves all MedicationRequest resources that represent a HCIM MedicationAgreement and have Carbasalaatcalcium Sandoz 600 30 as medication

'''UsePeriod'''
<pre>1. [base]/MedicationRequest?periodofuse=ge2010-01-01
2. [base]/MedicationRequest?periodofuse=le2009-12-31
3. [base]/MedicationDispense?periodofuse=ge2010-01-01&periodofuse=le2011-12-31
4. [base]/MedicationRequest?periodofuse=eq2010-01-01
5. [base]/MedicationRequest?category=http://snomed.info/sct|16076005&periodofuse=ge2010-01-01</pre>
# Retrieves all MedicationRequest resources that were in effect from 01-01-2010.
# Retrieves all MedicationRequest resources that were in effect before 01-01-2010.
# Retrieves all MedicationDispense resources that were in effect within a 2 year period.
# Retrieves all MedicationDispense resources that were in effect on 01-01-2010.
# Retrieves all MedicationRequest resources that represent a HCIM MedicationAgreement and were in effect from 01-01-2010.

'''DispensePeriod'''
<pre>1. [base]/MedicationDispense?whenhandedover=ge2010-01-01
2. [base]/MedicationDispense?whenhandedover=le2009-12-31
3. [base]/MedicationDispense?whenhandedover=ge2010-01-01&whenhandedover=le2011-12-31
4. [base]/MedicationDispense?whenhandedover=eq2010-01-01
5. [base]/MedicationDispense?whenhandedover=ge2010-01-01&category=http://snomed.info/sct|373784005
</pre>
# Retrieves all MedicationDispense resources that were handed over from 01-01-2010.
# Retrieves all MedicationDispense resources that were handed over before 01-01-2010.
# Retrieves all MedicationDispense resources that were handed over within a 2 year period.
# Retrieves all MedicationDispense resources that were handed over on 01-01-2010.
# Retrieves all MedicationDispense resources that represent a HCIM Dispense and handed over from 01-01-2010.

'''MedicationTreatment'''
{{NoteBox|1= Known issue: the second example search request on the server's base using the custom search parameter 'medicationtreatment' is not correct en potentially dangerous. Therefore this should not be implemented and used. Future versions of the information standard will not contain this request. It is expected that requests are made on the Resource type (first example) instead of the server base. More information can be found here: https://bits.nictiz.nl/browse/MM-560}}
<pre>1. [base]/MedicationRequest?medicationtreatment=http://example.nl/fhir/NamingSystem/medicationtreatment|1247848 
2. [base]/?medicationtreatment=http://example.nl/fhir/NamingSystem/medicationtreatment|1247848 </pre>
# Retrieves all MedicationRequest resources that are part of the medication treatment 1247848.
# Retrieves all MedicationRequest, MedicationDispense, MedicationStatement resources that are part of the the medication treatment 1247848


=====Expected Actions=====
The XIS shall process the query to discover the medication information that match the search parameters given.

===XIS: response message===
The XIS returns a HTTP Status code appropriate to the processing as well as a FHIR Bundle including the matching medication information.

====Trigger Events====
The XIS completed processing of the Retrieve medication information request message. 

====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 medication resources are found, the HTTP status code SHALL be 200. 

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/STU3/operationoutcome.html OperationOutcome resource]

=====Message resource content=====
The returned data to the PHR SHALL conform to the medication HCIMs profiles. The table below lists the medication HCIMs and their respective FHIR profiles. 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.

'''Note''' that the medication building blocks are grouped per 'medication treatment' conform the [https://informatiestandaarden.nictiz.nl/wiki/mp:V9.0.7_Ontwerp_medicatieproces#Medicamenteuze_behandeling Medication Process specification]. Grouping SHALL be done by use of a 'medication treatment' identifier. This identifier shall be the same across different related medication resources that constitute a medication treatment. The {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12|title=zib-Medication-MedicationTreatment extension}} is added to all medication profiles and can be used for this grouping purpose.

{{NoteBoxPackage|https://simplifier.net/packages/nictiz.fhir.nl.stu3.zib2017|1.3.x|MedMij:V2019.01_FHIR_IG}}

{| class="wikitable" width="1400px"
|-style="background-color: #1F497D; color: white; font-weight: bold; "
|HCIM name NL||HCIM name EN||FHIR Resource||FHIR Profile
|-style="vertical-align:top; background-color: #E3E3E3; 
|-
| Patient
| #Zib Patient|Patient
| Patient
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-patient|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Zorgverlener
| HealthProfessional
| Practitioner
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Zorgaanbieder
| HealthcareProvider
| Organization
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Medicatiegebruik||MedicationUse||MedicationStatement|| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Toedieningsafspraak||AdministrationAgreement||MedicationDispense|| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Medicatieafspraak||MedicationAgreement||MedicationRequest|| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAgreement|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Verstrekking||Dispense||MedicationDispense|| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Dispense|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Verstrekkingsverzoek||DispenseRequest||MedicationRequest|| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-DispenseRequest|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Product||Product||Medication|| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-Product|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| GebruiksInstructie||InstructionsForUse||Dosage (datatype)|| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/zib-InstructionsForUse|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
|}

====Expected Actions====
The PHR shall process the results according to application-defined rules. The PHR should be robust as the response may contain medication information resources that match the query parameters.

==Interactions, operations, search parameters==
===Interactions===
The following logical interactions are needed for the retrieve medication information 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 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]

Search result parameters:
* [http://hl7.org/fhir/STU3/search.html#include _include]

The following custom search parameters are defined for this use case:

* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/Medications-category|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/Medications-medicationtreatment|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/Medications-periodofuse|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}} * 

<nowiki>*</nowiki> This SearchParameter searches on the FHIR DataType Period in the PeriodOfUse extension, which is added to profiles on MedicationRequest and MedicationDispense resources. Clients use date parameter searches as described by the [http://hl7.org/fhir/stu3/search.html#date FHIR specification]. Servers are expected to take the [http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration MedicationUse-Duration extension] into account when processing a client's search. This means that either a Period.start AND Period.end or Period.start AND Duration or Period.end AND Duration is used to determine the search results. To illustrate the expected behavior: if a Period.start and a Duration is known, but not the Period.end, the Duration should be added to the Period.start date to calculate the Period.end. The calculated Period.end date is then used to determine the search results.

=Use case: retrieve Dispense612ToFHIRConversion from the LSP=
{{FHIR-IG-Afsprakenstelsel-Note}}

==Introduction==
This use case concerns the retrieval of medication dispenses and related medication information that is exchanged between healthcare providers on the 'Landelijk Schakelpunt' (LSP). Over the LSP, these medication dispenses are exchanged based on the information standard MedicationProces version 6.12 in HL7v3-messaging format. In this use case, the requested information by a PHR is converted to FHIR-resources by 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 Dispense612ToFHIRConversion(PULL)
|style="background-color: white;vertical-align:top;"|Retrieve Dispense612ToFHIRConversion request
|style="background-color: white;vertical-align:top;"|Patient (using a PHR)
|style="background-color: white;vertical-align:top;"|Request Dispense612ToFHIRConversion from the XIS
|-
|style="background-color: white;vertical-align:top;"|Retrieve Dispense612ToFHIRConversion response
|style="background-color: white;vertical-align:top;"|Healthcare professional (using a XIS)
|style="background-color: white;vertical-align:top;"|Serves Dispense612ToFHIRConversion to the PHR
|}

==Invocations==
===PHR: request message===
This message uses the HTTP GET method parameterized query to obtain medication information from a XIS. 

====Trigger Events====
When the patient (PHR) wants to obtain Medication process Dispense 6.12 information matching various parameters, it issues a retrieve Dispense612ToFHIRConversion request message.

====Message Semantics====
The PHR executes an HTTP GET against the XIS's MedicationDispense FHIR endpoint. This URL is configurable by the PHR by configuring the query search parameters and search control parameters to modify the behaviour of the XIS such as response format, or pagination. The search interaction is performed by an HTTP GET compliant with the [http://hl7.org/fhir/STU3/search.html FHIR search specification] as shown:

<pre>
GET [base]/MedicationDispense{?[parameters]{&_format=[mime-type]}}
</pre>

=====Explicit search on MedicationDispense and AdministrationAgreement=====
To distinguish the medication-related HCIMs between each other and between general medication resources, a fixed category coding has been added to the medication-related HCIM profiles (listed below in the Message content section). The fixed category code is solely used for indexing and retrieval of the HCIM building blocks.

For this use case, HCIMs MedicationDispense and AdministrationAgreement are requested from the XIS. Both HCIMs are represented by a MedicationDispense resource, however, the PHR makes an explicit request by searching on the category code for both HCIM's.

=====Including the Patient, Organization and Medication resources in searchresults=====
The PHR requests the XIS to return resources related to the MedicationDispense resources, namely the Patient, Organization and Medication resources. The _include parameter is used for this purpose. The request URL syntax is shown here:

<pre>
GET [base]/MedicationDispense?category=http://snomed.info/sct|373784005,http://snomed.info/sct|422037009&_include=MedicationDispense:medication&_include=MedicationDispense:patient&_include=MedicationDispense:performer{&[parameters]{&_format=[mime-type]}}
</pre>

This search interaction Retrieves MedicationDispense resources that represent a MedicationDispense or AdministrationAgreement and includes the related Patient, Organization and Medication resources in the result.

====Query Search Parameters====
The PHR may supply, and the XIS SHALL be capable of processing, all query parameters listed in the table below.

{| class="wikitable"
! style="font-weight: bold;text-align:left;" | MP9 search parameters
! style="font-weight: bold;text-align:left;" | Description
! style="font-weight: bold;text-align:left;" | FHIR search parameter
|-
| UsePeriod
| Search on medication use in the past, present or future within the specified time period.
| periodofuse 
|-
| DispensePeriod 
| Returns all medication dispenses within the specific period, based on the dispense request date.
| requestdate
|}

'''UsePeriod'''
<pre>
GET [base]/MedicationDispense?category=http://snomed.info/sct|373784005,http://snomed.info/sct|422037009&periodofuse=le2011-12-31&periodofuse=ge2010-01-01&_include=MedicationRequest:medication&_include=MedicationDispense:patient&_include=MedicationDispense:performer
</pre>
Retrieves MedicationDispense resources that represent a HCIM MedicationDispense or AdministrationAgreement, were in effect within a 2 year period and includes related Medication, Patient and Organization resources in the result.

'''DispensePeriod'''
<pre>
GET [base]/MedicationDispense?category=http://snomed.info/sct|373784005,http://snomed.info/sct|422037009&requestdate=ge2010-01-01&_include=MedicationRequest:medication&_include=MedicationDispense:patient&_include=MedicationDispense:performer
</pre>
Retrieves MedicationDispense resources that represent a HCIM MedicationDispense or AdministrationAgreement, that requested after 01-01-2010 and includes related Medication,  Patient and Organization resources in the result.

=====Custom Search Parameters=====
The following custom search parameters are defined for this use case:

* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/Medications-category|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/Medications-periodofuse|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}} [[#Search_parameters_3|*]]
* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/MedicationDispense-requestdate|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}

===XIS: response message===
The XIS returns a HTTP Status code appropriate to the processing of the request as well as a Bundle of type searchset. 

====Trigger Events====
The XIS completed processing of the retrieve medication overview request message.

====Message Semantics====
Based on the retrieve Dispense612ToFHIRConversion request 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 MedicationDispense resources are found or generated, the HTTP status code shall be 200. 

The body of the response message shall be a Bundle resource of type "searchset". The following section will elaborate on the content included.

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/bundle.html Bundle resource]
*[http://hl7.org/fhir/STU3/operationoutcome.html OperationOutcome resource]

=====Message resource content=====
The returned data to the PHR SHALL conform to the 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 respective profile canonical URL in the ''meta.profile'' element to show compliance.

These profiles are derived from the HCIM profiles. This use case has a very specific and stable underlying dataset. Therefore, the profiles contain many mandatory elements. Within the Medication Process dataset, there is a difference between the concept cardinalities '1..* Required' and '1..* Mandatory'.: The first means the element is required to be present, if the system possesses the information and the latter means the element should always be present. Both are mapped to a mandatory cardinality in the FHIR profiles. If the XIS is not able to provide the required information for a mandatory element, it shall use a [http://hl7.org/fhir/STU3/extension-iso21090-nullflavor.html nullFlavor extension] to indicate that and why the information is not present. The PHR should be able to process nullFlavor extensions and values. 

{{NoteBoxPackage|https://simplifier.net/packages/nictiz.fhir.nl.stu3.zib2017|1.3.x|MedMij:V2019.01_FHIR_IG}}

{| class="wikitable" width="1400px"
|-style="background-color: #1F497D; color: white; font-weight: bold; "
|HCIM name NL||HCIM name EN||FHIR Resource||FHIR Profile url
|-style="vertical-align:top; background-color: #E3E3E3; 
|-
| Patient
| Patient
| Patient
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/mp612-DispenseToFHIRConversion-Patient|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Zorgaanbieder
| HealthcareProvider
| Organization
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/mp612-DispenseToFHIRConversion-Organization|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Toedieningsafspraak
| AdministrationAgreement
| MedicationDispense
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/mp612-DispenseToFHIRConversion-AdministrationAgreement|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Verstrekking
| Dispense
| MedicationDispense
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/mp612-DispenseToFHIRConversion-Dispense|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
| Product
| Product
| Medication
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/mp612-DispenseToFHIRConversion-Product|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
|-
|}

====Expected Actions====
The PHR shall process the results according to application-defined rules. The PHR should be robust as the response may contain medication information resources that match the query parameters.

==Interactions, operations, search parameters==
===Interactions===
The following logical interactions are needed for the retrieve medication information 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 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]

Search result parameters:
* [http://hl7.org/fhir/STU3/search.html#include _include]

The following custom search parameters are defined for this use case:

* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/Medications-category|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}}
* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/MedicationDispense-requestdate|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}} 
* {{Simplifier|http://nictiz.nl/fhir/SearchParameter/Medications-periodofuse|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}} *

<nowiki>*</nowiki> This SearchParameter searches on the FHIR DataType Period in the PeriodOfUse extension, which is added to profiles on MedicationRequest and MedicationDispense resources. Clients use date parameter searches as described by the [http://hl7.org/fhir/stu3/search.html#date FHIR specification]. Servers are expected to take the [http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration MedicationUse-Duration extension] into account when processing a client's search. This means that either a Period.start + Period.end or Period.start + Duration is used to determine the search results. To illustrate the expected behavior: if a Period.start and a Duration is known, but not the Period, the Duration should be added to the Period.start date to calculate the Period.end. The calculated Period.end date is then used to determine the search results.

=Terminology, NamingSystems, Mappings=
{{MedMij:Vprepub-2019.01_Template_Terminologies_NamingSystems_Mappings|id1=Message_content|t1=Retrieve medication overview response message content|id2=Message_resource_content|t2=Retrieve medication information response message |id3=Message_resource_content_2|t3=Retrieve Dispense612ToFHIRConversion response message }}

=Examples=

# Medicatieproces has a wiki page that contains [https://informatiestandaarden.nictiz.nl/wiki/mp:V9.0_Voorbeelden_doseringen examples in FHIR and CDA for dosage instructions]. 
# Every profile or resource on Simplifier has a reference tab. The reference tab shows all references from and to the selected resource. So the listed profiles in these use cases have a reference tab on Simplifier where examples are listed that declare conformance to the specific profile.
# Examples are accessible through the Simplifier project by going to the resources tab of the project. It is possible to filter on examples and underlying FHIR resource. This is clarified with the following URL, which lists all medication examples available in the NictizSTU3-zib2017 project: https://simplifier.net/NictizSTU3-Zib2017/~resources?category=Example&exampletype=MedicationDispense|MedicationStatement|MedicationRequest|Medication&fhirVersion=STU3&sortBy=DisplayName

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