MedMij FHIR use case Medication Information

Uit informatiestandaarden
Versie door Maarten Ligtvoet (Overleg | bijdragen) op 25 jul 2019 om 08:56

(wijz) ← Oudere versie | Huidige versie (wijz) | Nieuwere versie → (wijz)

Ga naar: navigatie, zoeken

Issue icon.png

This version is obsolete - See current publication here.


PatientBijsluiter Icoon MedMij.png



Go to functional design

This page technically describes how a client, e.g. a PHE, should retrieve medication information from a server, maintained by College ter Beoordeling Geneesmiddelen (CBG). This use case makes use of the IHE MHD profile and PDF/A use case, which are described in detail here.

Note: this page is part of the MedMij FHIR Implementation Guide and is a technical representation of the functional design published on this wiki page.

Retrieve Medication information by patients

Go to Afsprakenstelsel

This section summarizes the IHE MHD profile to exchange PDF/A documents in a MedMij context.

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.

Actors and transactions involved

Table 1 shows the relevant actors, systems and FHIR capability statements in a MedMij context. The capability statements demonstrate the minimum requirements to be conformant to the Medication Information use case specification.

Actors 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 FHIR Client requirements
College ter Beoordeling Geneesmiddelen (CBG) The owner of the medication information XIS Healthcare information system Verwijzing.png CapabilityStatement: Server FHIR Server requirements

Table 1. Actors, systems and FHIR capability statements

Table 2 shows the MHD actors and transactions in perspective of the systems used in a MedMij context.

Actors System MHD Actors MHD Transactions
Document Consumer
Find Document Reference
Retrieve Document
College ter Beoordeling Geneesmiddelen (CBG)
Document Responder
Find Document Reference
Retrieve Document

Table 2. MHD actors and transactions in perspective of systems in a MedMij context and the medication information use case.

Transactions in scope

  • Find Document References – This transaction is used to issue parameterized queries that result in a list of Document Reference resources.
  • Retrieve Document – This transaction is used to get documents.

Find and retrieve medication information document

Find medication information document

Discovery of medication information documents is done with the MHD defined transaction Find Document Reference. The Find Document Reference retrieves FHIR DocumentReference Resources that represents a single reference to document per resource, for example one PDF/A file containing the medication information.

The Document Consumer requests DocumentReference, matching a set of criteria, from the Document Responder. The Document Responder returns DocumentReference or DocumentManifest Resources that match the search criteria provided by the Document Consumer.

Request message


The Document Consumer executes an HTTP GET conform to the FHIR RESTfull and search specification. A search query would have the following format.

GET [base]DocumentReference?[parameters]{&_format=[mime-type]}

Search Parameters The Document Consumer may supply, and the Document Responder 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: DocumentReference).

Name Type Description
type token Kind of document. This element is used to specifically search for the right document based on the G-Standard (ZI-nummers or HPK)
class token Categorization of document. The relevant categories for this use case are: patient's Instructions, scientific information, additional risk minimization information and assessment reports.

Example queries to search for DocumentReferences containing medication information.

1. GET [base]/DocumentReference?class=|patientinstructions&type=urn:oid:2.16.840.1.113883.|14668157
2. GET [base]/DocumentReference?class=|patientinstructions&type=urn:oid:2.16.840.1.113883.|01474707
3. GET [base]/DocumentReference?class=|patientinstructions&type=urn:oid:2.16.840.1.113883.|081140

1. Search on class (Patient Instructions) and type (ZI number for PARACETAMOL/CODEINEFOSFAAT RP TABLET 500/50MG (30 ST)).
2. Search on class (Patient Instructions) and type (HPG number for PARACETAMOL/CODEINEFOSFAAT RP TABLET 500/50MG).
3. Search on class (Patient Instructions) and type (GPK number for PARACETAMOL/CODEINE TABLET 500/50MG).

Response message

The Document Responder shall process the query to discover the DocumentReference entries that match the search parameters given. The Document Responder returns a HTTP Status code appropriate to the processing as well as a Bundle including the matching DocumentReference Resources. When the Document Responder needs to report an error or warning, it shall use HTTP error response codes and should include a FHIR OperationOutcome with more details on the failure or warning. If the request message is processed successfully, whether or not any DocumentReference or DocumentManifest Resources are found, the HTTP status code shall be 200.

The Document Responder shall place into the 'DocumentReference.content.attachment.url' element a full URL that can be used by the Document Consumer to retrieve the document using Retrieve Document transaction.

Example of a response message

    <id value="021aeba5-1d9d-4c06-92cd-d7c037bbcc" />
        <lastUpdated value="2018-02-16T14:57:34+00:00" />
    <type value="searchset" />
    <total value="1" />
        <relation value="self" />
        <url value="|patientinstructions&type=urn:oid:2.16.840.1.113883.|14668157" />
        <fullUrl value="" />
                <id value="example" />
                    <versionId value="1" />
                    <lastUpdated value="2017-11-28T08:30:39+00:00" />
                        <id value="a2" />
                            <family value="Smitty" />
                            <given value="Gerald" />
                    <system value="urn:ietf:rfc:3986" />
                    <value value="urn:oid:" />
                    <system value="urn:ietf:rfc:3986" />
                    <value value="urn:oid:" />
                <status value="current" />
                <docStatus value="preliminary" />
                        <system value="urn:oid:2.16.840.1.113883." />
                        <code value="14668157" />
                        <display value="PARACETAMOL/CODEINEFOSFAAT RP TABLET 500/50MG (30 ST)" />
                        <system value="" />
                        <code value="patientsinstructions" />
                        <display value="Patient Medication Instructions" />
                    <reference value="Patient/xcda" />
                <created value="2005-12-24T09:35:00+11:00" />
                <indexed value="2005-12-24T09:43:41+11:00" />
                    <reference value="Practitioner/xcda1" />
                    <reference value="#a2" />
                    <reference value="Organization/f001" />
                    <reference value="Organization/f001" />
                    <code value="appends" />
                        <reference value="DocumentReference/example" />
                <description value="Patients Medication Instruction for " />
                        <contentType value="application/hl7-v3+xml" />
                        <language value="en-US" />
                        <url value="" />
                        <size value="3654" />
                        <hash value="2jmj7l5rSw0yVb/vlWAYkK/YBwk=" />
            <mode value="match" />

Retrieve medication information document(s)

After obtaining the location of the medication information document in the DocumentReference.content.attachment.url, the Document Consumer requests the document from the Document Responder. The Document Responder sequentially serves the document to the Document Consumer. The context that was established in the initial request shall also apply when retrieving/serving the document contents.

Request Message

This message is an HTTP GET request to retrieve the document. See an example below.

GET http://example:9556/svc/fhir/Binary/1e404af3-077f-4bee-b7a6-a9be97e1ce32

The Document Consumer may provide a HTTP Accept header, according to the semantics of the HTTP protocols (see RFC2616, Section 14.1). The only MIME type assured to be returned is the MIME type indicated in the DocumentReference.content.attachment.contentType'. The HTTP If-Unmodified-Since header shall not be included in the GET request.

Response Message

The Document Responder shall process the request message. The Document Responder returns a HTTP Status code appropriate to the processing as well as a Bundle with the medication information in a FHIR Binary Resource. Binary resources behave slightly differently to all other resources on the RESTful API. Specifically, when a read request is made for the binary resource that doesn't explicitly specify the FHIR content types "application/fhir+xml" or "application/fhir+json", then the content should be returned using the content type stated in the resource. e.g. if the content type in the resource is "application/pdf", then the content should be returned as a PDF directly.[1]

When the Document Responder needs to report an error or warning, it shall use HTTP error response codes and should include a OperationOutcome with more details on the failure or warning. If the Retrieve Document message is processed successfully the HTTP status code shall be 200.

Example of a response message

<Bundle xmlns="">
    <id value="5905e2ee-8505-4f13-8701-63b33b531291" />
        <versionId value="f80e4263-f7ef-4a6f-9996-95ee7607f553" />
        <lastUpdated value="2017-10-25T12:24:26.69+00:00" />
    <type value="searchset" />
    <total value="1" />
        <relation value="self" />
        <url value="http://example:9556/svc/fhir/Binary/1e404af3-077f-4bee-b7a6-a9be97e1ce32" />
        <fullUrl value="http://example:9556/svc/fhir/Binary/1e404af3-077f-4bee-b7a6-a9be97e1ce32" />
                <id value="1e404af3-077f-4bee-b7a6-a9be97e1ce32" />
                    <versionId value="948f3653-c9a3-4831-bae5-f629319c194f" />
                    <lastUpdated value="2017-09-20T17:55:14.098+00:00" />
                <contentType value="application/pdf" />
                <content value="JVBERi0xLjUNJeLjz9MNCjU1I........"/>   

Interactions, operations, search parameters


The following logical interactions are needed for this use case:


There are no defined operations for this use case.

Search parameters

The following search parameter types need to be supported for this use case. No search result parameters need to be supported.

Search parameter types:

List of StructureDefinitions

The following HL7 FHIR STU3 StructureDefinitions are defined for MHD: