Base Path: /fhir/4.0/MedicationRequest
Version: 1.2.0
The FHIR MedicationRequest API allows you to look up and retrieve a list of the medications that were requested (prescribed) for a patient.. The endpoint provides the ability to:
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.
GET /fhir/4.0/MedicationRequest/
This method returns all requested medications for the patient identified either by patient.identifier or by patient. Optionally filtering by the date the medication was requested, and the request status.
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:
authoredon
optional
Type:
query
Data Type:
array
Description:
Filters the requested medications to those with an request 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: gt2015-09-03
Name:
status
optional
Type:
query
Data Type:
string
Description:
Filters the requested medications to those having the specified status. Possible values are
Sample Value: active
Name:
intent
optional
Type:
query
Data Type:
string
Description:
Filters the requested medications to those with the specified intent. Possible values are
Sample Value: order
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
200
Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* MedicationRequest resources
400
This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.
curl -X GET "https://developer-solution/fhir/4.0/MedicationRequest/?patient=GU2TAMJWIBJVSU27IE&authoredon=gt2015-09-03&status=active" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='
POST /fhir/4.0/MedicationRequest/_search
This method returns all requested medications for the patient identified either by patient.identifier or by patient. Optionally filtering by the date-time the medication was requested, and the request status. This is the secure alternative to the GET search.
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:
authoredon
optional
Type:
formData
Data Type:
array
Description:
Filters the requested medications to those with an request 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 requested medications to those having the specified status. Possible values are
Sample Value: active
Name:
intent
optional
Type:
query
Data Type:
string
Description:
Filters the requested medications to those with the specified intent. Possible values are
Sample Value: order
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
200
Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* MedicationRequest resources
400
This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.
curl -X POST "https://developer-solution/fhir/4.0/MedicationRequest/_search?intent=order" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'patient.identifier=SYS_A%7C55016'
GET /fhir/4.0/MedicationRequest/{id}
This method returns the MedicationRequest resource matching the requested resource ID.
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the MedicationRequest resource
Sample Value: sha4CH4NYMVLY6PTYXJVAKEIYP74L3SW4IJHGJZRHLMUJAQS6BDN4HA
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
200
Returns a MedicationRequest resource matching the the requested resource ID.
400
This code is returned when the resource ID is empty or not valid.
404
No MedicationRequest resource found with the requested resource ID.
curl -X GET "https://developer-solution/fhir/4.0/MedicationRequest/sha4CH4NYMVLY6PTYXJVAKEIYP74L3SW4IJHGJZRHLMUJAQS6BDN4HA" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='