FHIR MedicationDispense

Base Path: /fhir/4.0/MedicationDispense

Version: 1.2.0

The FHIR MedicationDispense API allows you to look up and retrieve a list of the medications that were dispensed to a patient. The endpoint provides the ability to:

  • Retrieve all MedicationDispense resources that match a search criteria for a given patient.
  • Retrieve a specific MedicationDispense resource based on its FHIR ID.
  • Support exporting resources via FHIR Bulk

The data returned in this API is subject to privacy and permissions settings, refer to the Working with Privacy guide to learn how this might affect your application.

This API is based on the R4 release of the FHIR standard, for more information on this API refer to the official FHIR documentation.

Methods

Retrieve Dispensed Medications for a Patient

GET /fhir/4.0/MedicationDispense/

This method returns all dispensed medications for the patient identified either by patient.identifier or by patient. Optionally filtering by the date-time the medication was given to the patient, and the dispense status.

Parameters

Name

Type

Data Type

Description

Name:

patient.identifier

required

Type:

query

Data Type:

string

Description:

The patient identifier consists of patient identifier namespace, also known as the system, and identifier, separated using a URL encoded | character i.e. %7c.

Note: You must either define the patient.identifier or patient, not both.


Sample Value: ORION|AAAA-0124-8

Name:

patient

required

Type:

query

Data Type:

string

Description:

The patient resource id.

Note: You must either define the patient.identifier or patient, not both.


Sample Value: GU2TAMJWIBJVSU27IE

Name:

whenhandedover

optional

Type:

query

Data Type:

array

Description:

Filters the dispensed medications to those with a dispense date on, before, or after a specific date, date-time, or date range. The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied. Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL encoded i.e. %2B.


Sample Value: ge2010-09-16

Name:

status

optional

Type:

query

Data Type:

string

Description:

Filters the dispensed medications to those having the specified status. Possible values are

  • preparation
  • in-progress
  • cancelled
  • on-hold
  • completed
  • entered-in-error
  • stopped
  • declined
  • unknown


Sample Value: completed

Name:

-include-sources

optional

Type:

formData

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.


Name:

-exclude-sources

optional

Type:

formData

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.


Name:

_format

optional

Type:

formData

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header.


Default Value: json

Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response


Default Value: application/xml

Sample Value: application/json

Responses

application/json+fhir

200

Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* MedicationDispense resources

application/json+fhir

400

This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.

Sample Requests

Retrieve specific Dispensed Medication for a Patient identified by patient resource id
curl -X GET "https://developer-solution/fhir/4.0/MedicationDispense/?patient=GU2TAMJWIBJVSU27IE&whenhandedover=ge2010-09-16&status=completed" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve Dispensed Medications for a Patient

POST /fhir/4.0/MedicationDispense/_search

This method returns all dispensed medications for the patient identified either by patient.identifier or by patient. Optionally filtering by the date-time the medication was given to the patient, and the dispense status. This is the secure alternative to the GET search.

Parameters

Name

Type

Data Type

Description

Name:

Content-Type

required

Type:

header

Data Type:

string

Description:

Specifies how to encode the form data. The Content-Type value must be application/x-www-form-urlencoded


Sample Value: application/x-www-form-urlencoded

Name:

patient.identifier

required

Type:

formData

Data Type:

string

Description:

The patient identifier consists of patient identifier namespace, also known as the system, and identifier, separated using a URL encoded | character i.e. %7c.

Note: You must either define the patient.identifier or patient, not both.


Sample Value: SYS_A|55016

Name:

patient

required

Type:

formData

Data Type:

string

Description:

The patient resource id.

Note: You must either define the patient.identifier or patient, not both.


Sample Value: IFAUCQJNGAYTENBNHBAE6USJJ5HA

Name:

whenhandedover

optional

Type:

formData

Data Type:

array

Description:

Filters the dispensed medications to those with a dispense date on, before, or after a specific date, date-time, or date range. The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied. Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL encoded i.e. %2B.


Sample Value: gt2013-01-01T01:00:00%2B13:00

Name:

status

optional

Type:

formData

Data Type:

string

Description:

Filters the dispensed medications to those having the specified status. Possible values are

  • preparation
  • in-progress
  • cancelled
  • on-hold
  • completed
  • entered-in-error
  • stopped
  • declined
  • unknown


Sample Value: completed

Name:

-include-sources

optional

Type:

formData

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.


Name:

-exclude-sources

optional

Type:

formData

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.


Name:

_format

optional

Type:

formData

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header.


Default Value: json

Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response


Default Value: application/xml

Sample Value: application/json

Responses

application/json+fhir

200

Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* MedicationDispense resources

application/json+fhir

400

This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.

Sample Requests

Retrieve specific Dispensed Medication for a Patient identified by patient identifier
curl -X POST "https://developer-solution/fhir/4.0/MedicationDispense/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'patient.identifier=SYS_A%7C55016' \
-d 'whenhandedover=gt2013-01-01T01:00:00%2B13:00' \
-d 'status=completed'

Retrieve a single MedicationDispense

GET /fhir/4.0/MedicationDispense/{id}

This method returns the MedicationDispense resource matching the requested resource ID.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the MedicationDispense resource


Sample Value: shaRX3UJ74E2IMZATDCXTQTUJCN2MESWV3S3AFKKWLOREDT2YWE2HJA

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the Accept header.

Possible values are json and xml. The default value is xml.


Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response.

Possible values are application/json and application/xml. The default value is application/xml.


Sample Value: application/xml

Responses

application/json+fhir

200

Returns a MedicationDispense resource matching the requested resource ID.

application/json+fhir

400

This code is returned when the resource ID is empty or not valid.

application/json+fhir

404

No MedicationDispense resource found with the requested resource ID.

Sample Requests

Retrieve specific Dispensed Medication identified by resource ID.
curl -X GET "https://developer-solution/fhir/4.0/MedicationDispense/shaRX3UJ74E2IMZATDCXTQTUJCN2MESWV3S3AFKKWLOREDT2YWE2HJA" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='