FHIR MedicationRequest
Base Path: /fhir/4.0/MedicationRequest
Version: 2.0.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:
- Retrieve all MedicationRequest resources that match a search criteria for a given patient.
- Retrieve a specific MedicationRequest resource based on its resource ID
- Retrieve the history of a MedicationRequest resource based on its FHIR ID
- Retrieve a specific version of a MedicationRequest resource based on its FHIR ID and Version ID.
- Retrieve summaries of all MedicationRequest resources that match a search criteria for a given patient
- Retrieve MedicationRequest results from third-party sources.
- Supports 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.
The MedicationRequest API aggregates data from multiple sources, to learn about working with aggregated APIs refer to the Working with Aggregation guide in the Knowledge Hub.
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 MedicationRequests for a Patient
GET /fhir/4.0/MedicationRequest/
This method returns all requested medications for the patient identified either by patient.identifier or by patient. Optionally filtering using the other parameters.
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.identifierorpatient, not both. - In addition to having the required
patient.identifierorpatient, you can defined chainedpatientelements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.
Sample format of the query is
patient.identifier={namespace}|{identifier}patient.identifier={namespace}|{identifier} & patient.gender=male & patient.birthdate=2002-05-01
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.identifierorpatient, not both. In addition to having the required
patient.identifierorpatient, you can defined chainedpatientelements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.Sample format of the query is
patient={patient FHIRID}patient={patient FHIRID} & patient.gender=male & patient.birthdate=2002-05-01
Sample Value: IFAUCQJNGAYTENBNHBAE6USJJ5HA
Name:
authoredon
optional
Type:
query
Data Type:
array
Description:
Filters the MedicationRequest to those with an authoredOn on, before, or after a specific date or date-time.
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.
Note: Date range searches are not supported in solutions containing Orion Health Problem List since the patient may have non-date onsets.
The format of the query is
authoredon=gt{dateTimeValue}authoredon=ge{dateTimeValue}&authoredon=le{dateTimeValue}
Sample Value: gt1990-01-01T01:00:00+13:00
Name:
status
optional
Type:
query
Data Type:
array
Description:
Filters the MedicationRequest to those that match the specified status. The status may consists of a coding system and a code separated using a URL encoded | character i.e. %7c
The supported values are:
- active
- on-hold
- cancelled
- completed
- entered-in-error
- stopped
- draft
- unknown
Note:
- Supports passing in a comma-separated list of values.
- If a status system is specified it can only be http://hl7.org/fhir/CodeSystem/medicationrequest-status
Sample Value: completed
Name:
intent
optional
Type:
query
Data Type:
array
Description:
Filters the MedicationRequest to those that match the specified intent. The intent may consists of a coding system and a code separated using a URL encoded | character i.e. %7c
The supported values are:
- proposal
- plan
- order
- original-order
- reflex-order
- filler-order
- instance-order
- option
Note:
- Supports passing in a comma-separated list of values.
- If a status system is specified it can only be http://hl7.org/fhir/CodeSystem/medicationrequest-intent
Sample Value: order
Name:
category
optional
Type:
query
Data Type:
array
Description:
Filters the prescriptions with different categories of MedicationRequest to ones that matches the specified category or categories. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c
Note: Supports passing in a comma-separated list of values
Sample Value: http://terminology.hl7.org/CodeSystem/medication-statement-category|inpatient
Name:
code
optional
Type:
query
Data Type:
array
Description:
Filters the prescriptions of this medicine to ones that matches the specified code or codes. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c
Note: Supports passing in a comma-separated list of values
Sample Value: http://snomed.info/sct|261000
Name:
date
optional
Type:
query
Data Type:
array
Description:
Filters the MedicationRequest to those with a performed date on, before, or after a specific date or date-time.
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.
Note: Date range searches are not supported in solutions containing Orion Health Problem List since the patient may have non-date onsets.
The format of the query is
date=gt{dateTimeValue}date=ge{dateTimeValue}&date=le{dateTimeValue}
Sample Value: gt1990-01-01T01:00:00+13:00
Name:
encounter
optional
Type:
query
Data Type:
array
Description:
Filters MedicationRequest by the prescriptions with this encounter identifier, identified by their MedicationRequest.encounter reference.
Note: encounter can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.
Sample Value: encounter.identifier=SYS_A|visti123
Name:
identifier
optional
Type:
query
Data Type:
array
Description:
Filters MedicationRequest by the identifier associated with this prescriptions.
Note: The identifier can be a single item or a comma separated list of identifiers. Each identifier is defined by system and value , separated using a URL encoded | character i.e. %7c.,
Sample Value: urn:oid:1.3.4.5.6.7|2345234234234, urn:text:sysA|2345
Name:
intended-dispenser
optional
Type:
query
Data Type:
array
Description:
Filters MedicationRequest by prescriptions intended to be dispensed by this, identified by their MedicationRequest.dispenseRequest.performer reference.
Note: intended-dispenser can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.
Sample Value: intended-dispenser: Organization.name=Auckland%20Hospital
Name:
intended-performer
optional
Type:
query
Data Type:
array
Description:
Filters MedicationRequest by prescriptions intended performer of the administration of the medication request, identified by their MedicationRequest.performer reference.
Note: intended-performer can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.
Sample Value: intended-performer:Practitioner.family=Smith&intended-performer:Practitioner.given=Bob,Robert
Name:
intended-performertype
optional
Type:
query
Data Type:
array
Description:
Filters MedicationRequest by specific type of performer that matches the specified performerType or performerTypes. The performerType value consists of a coding system and a code separated using a URL encoded | character i.e. %7c
Note: Supports passing in a comma-separated list of values
Sample Value: http://snomed.info/sct|1421009
Name:
medication
optional
Type:
query
Data Type:
array
Description:
Filters MedicationRequest by prescriptions of this medicine resource, identified by their MedicationRequest.medication reference.
Note: medication can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.
Sample Value: medication:Medication.code=http://snomed.info/sct|261000
Name:
priority
optional
Type:
query
Data Type:
array
Description:
Filters the MedicationRequest to those that match the specified priority. The priority may consists of a coding system and a code separated using a URL encoded | character i.e. %7c
The supported values are:
- routine
- urgent
- asap
- stat
Note:
- Supports passing in a comma-separated list of values.
- If a priority system is specified it can only be http://hl7.org/fhir/request-priority
Sample Value: asap
Name:
requester
optional
Type:
query
Data Type:
array
Description:
Filters MedicationRequest by prescriptions prescribed by this prescriber, identified by their MedicationRequest.requester reference.
Note: medication can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.
Sample Value: requester:Practitioner.family=Smith&performer:Practitioner.given=Bob,Robert
Name:
-include-sources
optional
Type:
query
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.
Sample Value: -include-sources=Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems
Name:
-exclude-sources
optional
Type:
query
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.
Sample Value: -exclude-sources=Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems
Name:
_summary
optional
Type:
query
Data Type:
string
Description:
Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are
- true: return summaries only
- false: return full resources
- count: return the count of search matches
- text: return only the text, id, meta, and top-level mandatory elements
- data: remove the text element
Sample Value: true
Name:
_lastUpdated
optional
Type:
query
Data Type:
array
Description:
Filters based on when the resource version was last changed, 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.
The format of the query is
_lastUpdated=gt{dateTimeValue}_lastUpdated=ge{dateTimeValue}&_lastUpdated=le{dateTimeValue}
Sample Value: ge2012-01-01T01:00:00+13:00
Name:
_elements
optional
Type:
query
Data Type:
array
Description:
Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.
Sample Value: _elements=code,category,status,_elements:exclude=*.code
Name:
-cursor
optional
Type:
query
Data Type:
string
Description:
A server internal parameter to navigate different pages.
This parameter is returned by the server as part of the Bundle 'next' link of a paginated query. And is used to retrieve the next page
Name:
_count
optional
Type:
query
Data Type:
integer
Description:
Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.
The returned bundle may contain a next link if more results could be available.
Sample Value: 30
Name:
_sort
optional
Type:
query
Data Type:
array
Description:
Request which order results should be returned in.
Supported _sort parameters are:
authoredonto sort by MedicationRequest.authoredOn ascending-authoredonto sort by MedicationRequest.authoredOn_lastUpdatedto sort by MedicationRequest.Meta.lastUpdated ascending-_lastUpdatedto sort by MedicationRequest.Meta.lastUpdated descending
You can use any combination of the parameters
Default Value: -authoredon
Sample Value: _sort=-authoredon,_sort=-authoredon, -_lastUpdated
Name:
X-Request-Id
optional
Type:
header
Data Type:
string
Description:
Supply a request Id to track the request.
Sample Value: adUEctf6urd
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.
Default Value: application/json
Sample Value: application/json
Name:
Accept-Language
optional
Type:
header
Data Type:
string
Description:
Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)
Sample Value: en-US
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.
Default Value: json
Sample Value: json
Name:
_pretty
optional
Type:
query
Data Type:
string
Description:
Ask for a pretty printed response for human convenience.
Default Value: true
Sample Value: true
Name:
CSRF-Token
required
Type:
header
Data Type:
string
Description:
This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.
System will validate the token and reject the request if the token is invalid or not present.
Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.
Name:
X-Send-Open-API
required
Type:
header
Data Type:
string
Description:
This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.
System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request
Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.
Responses
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.
Sample Requests
Retrieve specific MedicationRequests for a Patient identified by patient resource id
curl -X GET "https://developer-solution/fhir/4.0/MedicationRequest?patient=IFAUCQJNGAYTENBNHBAE6USJJ5HA&authoredon=gt1990-01-01T01:00:00+13:00&status=completed" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve MedicationRequests for a Patient
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 using the other parameters. 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.identifierorpatient, not both. - In addition to having the required
patient.identifierorpatient, you can defined chainedpatientelements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.
Sample format of the query is
patient.identifier={namespace}|{identifier}patient.identifier={namespace}|{identifier} & patient.gender=male & patient.birthdate=2002-05-01
Sample Value: ORION|AAAA-0124-8
Name:
patient
required
Type:
formData
Data Type:
string
Description:
The patient resource id.
Note:
- You must either define the
patient.identifierorpatient, not both. In addition to having the required
patient.identifierorpatient, you can defined chainedpatientelements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.Sample format of the query is
patient={patient FHIRID}patient={patient FHIRID} & patient.gender=male & patient.birthdate=2002-05-01
Sample Value: IFAUCQJNGAYTENBNHBAE6USJJ5HA
Name:
authoredon
optional
Type:
formData
Data Type:
array
Description:
Filters the MedicationRequest to those with an authoredOn on, before, or after a specific date or date-time.
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.
Note: Date range searches are not supported in solutions containing Orion Health Problem List since the patient may have non-date onsets.
The format of the query is
authoredon=gt{dateTimeValue}authoredon=ge{dateTimeValue}&authoredon=le{dateTimeValue}
Sample Value: gt1990-01-01T01:00:00+13:00
Name:
status
optional
Type:
formData
Data Type:
array
Description:
Filters the MedicationRequest to those that match the specified status. The status may consists of a coding system and a code separated using a URL encoded | character i.e. %7c
The supported values are:
- active
- on-hold
- cancelled
- completed
- entered-in-error
- stopped
- draft
- unknown
Note:
- Supports passing in a comma-separated list of values.
- If a status system is specified it can only be http://hl7.org/fhir/CodeSystem/medicationrequest-status
Sample Value: completed
Name:
intent
optional
Type:
formData
Data Type:
array
Description:
Filters the MedicationRequest to those that match the specified intent. The intent may consists of a coding system and a code separated using a URL encoded | character i.e. %7c
The supported values are:
- proposal
- plan
- order
- original-order
- reflex-order
- filler-order
- instance-order
- option
Note:
- Supports passing in a comma-separated list of values.
- If a status system is specified it can only be http://hl7.org/fhir/CodeSystem/medicationrequest-intent
Sample Value: order
Name:
category
optional
Type:
formData
Data Type:
array
Description:
Filters the prescriptions with different categories of MedicationRequest to ones that matches the specified category or categories. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c
Note: Supports passing in a comma-separated list of values
Sample Value: http://terminology.hl7.org/CodeSystem/medication-statement-category|inpatient
Name:
code
optional
Type:
formData
Data Type:
array
Description:
Filters the prescriptions of this medicine to ones that matches the specified code or codes. The code value consists of a coding system and a code separated using a URL encoded | character i.e. %7c
Note: Supports passing in a comma-separated list of values
Sample Value: http://snomed.info/sct|261000
Name:
date
optional
Type:
formData
Data Type:
array
Description:
Filters the MedicationRequest to those with a performed date on, before, or after a specific date or date-time.
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.
Note: Date range searches are not supported in solutions containing Orion Health Problem List since the patient may have non-date onsets.
The format of the query is
date=gt{dateTimeValue}date=ge{dateTimeValue}&date=le{dateTimeValue}
Sample Value: gt1990-01-01T01:00:00+13:00
Name:
encounter
optional
Type:
formData
Data Type:
array
Description:
Filters MedicationRequest by the prescriptions with this encounter identifier, identified by their MedicationRequest.encounter reference.
Note: encounter can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.
Sample Value: encounter.identifier=SYS_A|visti123
Name:
identifier
optional
Type:
formData
Data Type:
array
Description:
Filters MedicationRequest by the identifier associated with this prescriptions.
Note: The identifier can be a single item or a comma separated list of identifiers. Each identifier is defined by system and value , separated using a URL encoded | character i.e. %7c.,
Sample Value: urn:oid:1.3.4.5.6.7|2345234234234, urn:text:sysA|2345
Name:
intended-dispenser
optional
Type:
formData
Data Type:
array
Description:
Filters MedicationRequest by prescriptions intended to be dispensed by this, identified by their MedicationRequest.dispenseRequest.performer reference.
Note: intended-dispenser can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.
Sample Value: intended-dispenser: Organization.name=Auckland%20Hospital
Name:
intended-performer
optional
Type:
formData
Data Type:
array
Description:
Filters MedicationRequest by prescriptions intended performer of the administration of the medication request, identified by their MedicationRequest.performer reference.
Note: intended-performer can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.
Sample Value: intended-performer:Practitioner.family=Smith&intended-performer:Practitioner.given=Bob,Robert
Name:
intended-performertype
optional
Type:
formData
Data Type:
array
Description:
Filters MedicationRequest by specific type of performer that matches the specified performerType or performerTypes. The performerType value consists of a coding system and a code separated using a URL encoded | character i.e. %7c
Note: Supports passing in a comma-separated list of values
Sample Value: http://snomed.info/sct|1421009
Name:
medication
optional
Type:
formData
Data Type:
array
Description:
Filters MedicationRequest by prescriptions of this medicine resource, identified by their MedicationRequest.medication reference.
Note: medication can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.
Sample Value: medication:Medication.code=http://snomed.info/sct|261000
Name:
priority
optional
Type:
formData
Data Type:
array
Description:
Filters the MedicationRequest to those that match the specified priority. The priority may consists of a coding system and a code separated using a URL encoded | character i.e. %7c
The supported values are:
- routine
- urgent
- asap
- stat
Note:
- Supports passing in a comma-separated list of values.
- If a priority system is specified it can only be http://hl7.org/fhir/request-priority
Sample Value: asap
Name:
requester
optional
Type:
formData
Data Type:
array
Description:
Filters MedicationRequest by prescriptions prescribed by this prescriber, identified by their MedicationRequest.requester reference.
Note: medication can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.
Sample Value: requester:Practitioner.family=Smith&performer:Practitioner.given=Bob,Robert
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.
Sample Value: -include-sources=Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems
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.
Sample Value: -exclude-sources=Orion%20Health%E2%84%A2%20R4%20HL7V2%20Generic%20Problems
Name:
_summary
optional
Type:
formData
Data Type:
string
Description:
Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are
- true: return summaries only
- false: return full resources
- count: return the count of search matches
- text: return only the text, id, meta, and top-level mandatory elements
- data: remove the text element
Sample Value: true
Name:
_lastUpdated
optional
Type:
formData
Data Type:
array
Description:
Filters based on when the resource version was last changed, 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.
The format of the query is
_lastUpdated=gt{dateTimeValue}_lastUpdated=ge{dateTimeValue}&_lastUpdated=le{dateTimeValue}
Sample Value: ge2012-01-01T01:00:00+13:00
Name:
_elements
optional
Type:
formData
Data Type:
array
Description:
Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.
Sample Value: _elements=code,category,status,_elements:exclude=*.code
Name:
-cursor
optional
Type:
formData
Data Type:
string
Description:
A server internal parameter to navigate different pages.
This parameter is returned by the server as part of the Bundle 'next' link of a paginated query. And is used to retrieve the next page
Name:
_count
optional
Type:
formData
Data Type:
integer
Description:
Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.
The returned bundle may contain a next link if more results could be available.
Sample Value: 30
Name:
_sort
optional
Type:
formData
Data Type:
array
Description:
Request which order results should be returned in.
Supported _sort parameters are:
authoredonto sort by MedicationRequest.authoredOn ascending-authoredonto sort by MedicationRequest.authoredOn_lastUpdatedto sort by MedicationRequest.Meta.lastUpdated ascending-_lastUpdatedto sort by MedicationRequest.Meta.lastUpdated descending
You can use any combination of the parameters
Default Value: -authoredon
Sample Value: _sort=-authoredon,_sort=-authoredon, -_lastUpdated
Name:
X-Request-Id
optional
Type:
header
Data Type:
string
Description:
Supply a request Id to track the request.
Sample Value: adUEctf6urd
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.
Default Value: application/json
Sample Value: application/json
Name:
Accept-Language
optional
Type:
header
Data Type:
string
Description:
Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)
Sample Value: en-US
Name:
_format
optional
Type:
formData
Data Type:
string
Description:
Media type of the response. It takes precedence over the Accept header. Possible values are json and xml.
Default Value: json
Sample Value: json
Name:
_pretty
optional
Type:
formData
Data Type:
string
Description:
Ask for a pretty printed response for human convenience.
Default Value: true
Sample Value: true
Name:
CSRF-Token
required
Type:
header
Data Type:
string
Description:
This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.
System will validate the token and reject the request if the token is invalid or not present.
Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.
Name:
X-Send-Open-API
required
Type:
header
Data Type:
string
Description:
This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.
System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request
Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.
Responses
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.
Sample Requests
Retrieve specific MedicationRequests for a Patient identified by patient identifier
curl -X POST "https://developer-solution/fhir/4.0/MedicationRequest/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'patient.identifier=ORION%7CAAAA-0124-8' \
-d 'authoredon=gt1990-01-01T01:00:00+13:00' \
-d 'status=completed'Retrieve a single MedicationRequest
GET /fhir/4.0/MedicationRequest/{id}
This method returns the MedicationRequest 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 MedicationRequest resource
Sample Value: shaA36KXXLH3GISNVY6F5FYZJKFBIJPDZKFYAZRRYP5DYZMFHBRJW4A
Name:
Accept-Language
optional
Type:
header
Data Type:
string
Description:
The language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)
Sample Value: en-US
Name:
X-Request-Id
optional
Type:
header
Data Type:
string
Description:
Supply a request Id to track the request.
Sample Value: adUEctf6urd
Name:
_elements
optional
Type:
query
Data Type:
array
Description:
Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.
Sample Value: _elements=code,category,status,_elements:exclude=*.extension,*.encounter
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.
Default Value: json
Sample Value: json
Name:
_pretty
optional
Type:
query
Data Type:
string
Description:
Ask for a pretty printed response for human convenience.
Default Value: true
Sample Value: true
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.
Default Value: application/json
Sample Value: application/json
Name:
CSRF-Token
required
Type:
header
Data Type:
string
Description:
This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.
System will validate the token and reject the request if the token is invalid or not present.
Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.
Name:
X-Send-Open-API
required
Type:
header
Data Type:
string
Description:
This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.
System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request
Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.
Responses
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.
Sample Requests
Retrieve specific Medication Statements identified by resource ID
curl -X GET "https://developer-solution/fhir/4.0/MedicationRequest/shaA36KXXLH3GISNVY6F5FYZJKFBIJPDZKFYAZRRYP5DYZMFHBRJW4A" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve a MedicationRequest's history
GET /fhir/4.0/MedicationRequest/{id}/_history
This method returns the change history for an MedicationRequest resource matching the requested resource ID. MedicationRequest resources can be retrieved from multiple data sources, and not all sources are able to return history information. This operation will return an empty set of data if no versions of the specified MedicationRequest can be found, which includes cases where:
- The specified MedicationRequest resource cannot be found.
- The data source for the MedicationRequest is unable to return history information.
Parameters
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the MedicationRequest resource
Sample Value: shaA36KXXLH3GISNVY6F5FYZJKFBIJPDZKFYAZRRYP5DYZMFHBRJW4A
Name:
Accept-Language
optional
Type:
header
Data Type:
string
Description:
The language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)
Sample Value: en-US
Name:
X-Request-Id
optional
Type:
header
Data Type:
string
Description:
Supply a request Id to track the request.
Sample Value: adUEctf6urd
Name:
_elements
optional
Type:
query
Data Type:
array
Description:
Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.
Sample Value: _elements=code,category,status,_elements:exclude=*.extension,*.encounter
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.
Default Value: json
Sample Value: json
Name:
_pretty
optional
Type:
query
Data Type:
string
Description:
Ask for a pretty printed response for human convenience.
Default Value: true
Sample Value: true
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.
Default Value: application/json
Sample Value: application/json
Name:
CSRF-Token
required
Type:
header
Data Type:
string
Description:
This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.
System will validate the token and reject the request if the token is invalid or not present.
Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.
Name:
X-Send-Open-API
required
Type:
header
Data Type:
string
Description:
This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.
System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request
Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.
Responses
200
A FHIR Bundle containing 1..* MedicationRequest resources matching the requested resource ID.
400
The source providing the MedicationRequest resource is not capable of returning history of MedicationRequest resources.
404
No MedicationRequest resource found with the requested resource ID.
Sample Requests
Retrieve the history of MedicationRequests identified by a resource id
curl -X GET "https://developer-solution/fhir/4.0/MedicationRequest/shaA36KXXLH3GISNVY6F5FYZJKFBIJPDZKFYAZRRYP5DYZMFHBRJW4A/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='Retrieve a specific version of a MedicationRequest
GET /fhir/4.0/MedicationRequest/{id}/_history/{versionid}
This method returns a specific version of the MedicationRequest resource matching the requested resource ID. MedicationRequest resources can be retrieved from multiple data sources. This operation will return an empty set of data if no versions of the specified MedicationRequest can be found, which includes cases where:
- The specified MedicationRequest resource cannot be found.
Parameters
Name
Type
Data Type
Description
Name:
id
required
Type:
path
Data Type:
string
Description:
The id of the MedicationRequest resource
Sample Value: shaA36KXXLH3GISNVY6F5FYZJKFBIJPDZKFYAZRRYP5DYZMFHBRJW4A
Name:
versionid
required
Type:
path
Data Type:
string
Description:
The version of the MedicationRequest resource
Sample Value: 1
Name:
Accept-Language
optional
Type:
header
Data Type:
string
Description:
The language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)
Sample Value: en-US
Name:
X-Request-Id
optional
Type:
header
Data Type:
string
Description:
Supply a request Id to track the request.
Sample Value: adUEctf6urd
Name:
_elements
optional
Type:
query
Data Type:
array
Description:
Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.
Sample Value: _elements=code,category,status,_elements:exclude=*.extension,*.encounter
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.
Default Value: json
Sample Value: json
Name:
_pretty
optional
Type:
query
Data Type:
string
Description:
Ask for a pretty printed response for human convenience.
Default Value: true
Sample Value: true
Name:
Accept
optional
Type:
header
Data Type:
string
Description:
Media type of the response. Possible values are application/json and application/xml. If both _format and Accept are specified, _format takes precedence.
Default Value: application/json
Sample Value: application/json
Name:
CSRF-Token
required
Type:
header
Data Type:
string
Description:
This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.
System will validate the token and reject the request if the token is invalid or not present.
Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.
Name:
X-Send-Open-API
required
Type:
header
Data Type:
string
Description:
This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.
System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request
Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.
Responses
200
Returns a MedicationRequest resource matching the the requested resource ID and version id.
400
- The source providing the MedicationRequest resource is not capable of returning history of MedicationRequest resources.
404
- No MedicationRequest resource found with the requested resource ID.
- The version id specified does not exist for the MedicationRequest resource with the requested resource ID.
Sample Requests
Retrieve the version of MedicationRequest identified by a resource id and a version id
curl -X GET "https://developer-solution/fhir/4.0/MedicationRequest/shaA36KXXLH3GISNVY6F5FYZJKFBIJPDZKFYAZRRYP5DYZMFHBRJW4A/_history/1" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='