MedicationOrder
Overview
The MedicationOrder resource provides orders for all medications with administration instructions for a patient in both the inpatient and outpatient settings (orders or prescriptions filled by a pharmacy and discharge medication orders). This resource does not include historical or home medications documented or reported to have been taken by the patient, significant other, or another provider.
If the medication order represents a prescription the patient takes at home, then the start, stop, and other information may not be a representation of when the medication was taken. For example, the system may not know if the patient ever filled or took the prescribed medication, or when the prescription was filled.
The following fields are returned if valued:
- Medication order ID
- Date/Time order written
- Status
- Date/Time order stopped or to stop
- Patient
- Prescriber
- Patient encounter
- Medication
- Details of medication taken:
- Dispensing details:
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
The common errors and OperationOutcomes may be returned.
Terminology Bindings
MedicationOrder.reasonCodeableConcept |
MedicationOrder.medicationCodeableConcept |
|
MedicationOrder.dosageInstruction.additionalInstructions |
|
MedicationOrder.dosageInstruction.timing.code |
|
MedicationOrder.dosageInstruction.asNeeded[x] |
|
MedicationOrder.dosageInstruction.siteCodeableConcept |
|
MedicationOrder.dosageInstruction.route |
|
Contained Medication Bindings
Medication.code |
|
Medication.product.form |
|
Extensions
Custom Extensions
All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/dstu2/StructureDefinition/{id}
For more information, see the StructureDefinition resource.
ID | Value[x] Type | Description |
---|---|---|
patient-friendly-display |
string |
Extension to MedicationRequest.dosageInstruction. The display name that can be used for this field when producing a view suitable for a patient. |
Search
Search for medication orders that meet supplied query parameters.
GET /MedicationOrder?:parameters
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
Conditionally | token |
The logical resource ID associated with the resource. It may be a list separated by commas. This parameter is required if the patient parameter is not used. Example: _id=1234
|
patient |
Conditionally | reference |
The specific patient to return orders for. This parameter is required if the _id parameter is not used. Example: patient=5678
|
status |
No | token |
The status of the medication order. It may be a list separated by commas. Example: status=active,draft
|
-timing-boundsPeriod |
No | date |
The date and time that should fall within the period when the medication should be given to the patient. This parameter cannot be provided at the same time as the _lastUpdated parameter. Example: -timing-boundsPeriod=ge2014-05-19T20:54:02.000Z
|
_lastUpdated |
No | date |
An explicit or implied date and time range within which the most recent clinically relevant update was made to the medication. This parameter cannot be provided at the same time as the -timing-boundsPeriod parameter. Example: _lastUpdated=ge2014-05-19T20:54:02.000Z
|
_count |
No | number |
The maximum number of results to include on a page. Example: _count=50
|
Notes
- MedicationOrder.medication may be a reference to a contained medication when the medication cannot be represented by a CodeableConcept because it contains a unique combination of ingredients. Medications in the system always exist in the context of a medication order and cannot be referenced independently.
- When searching with the
_id
parameter:- It must not be provided with any other parameters.
- When searching with the
-timing-boundsPeriod
parameter:- It must be provided with a
ge
prefix to imply the date range for the medication orders search. - The time component is optional.
- Example:
-timing-boundsPeriod=ge2014-05-19T20:54:02.000Z
- It must be provided with a
- When searching with the
_lastUpdated
parameter:- The time component is required.
- For a single
_lastUpdated
occurence:- It must be provided with a
le
orge
prefix to imply the date range for the medication orders search. - Example:
_lastUpdated=ge2014-05-19T20:54:02.000Z
- It must be provided with a
- For two
_lastUpdated
occurences:- It must be provided with the
le
andge
prefixes to search for medication orders within the given upper and lower timestamps, respectively. - Example:
_lastUpdated=ge2014-05-19T20:54:02.000Z&_lastUpdated=le2014-05-20T12:00:00.000Z
- It must be provided with the
- It only detects changes that affect the clinical meaning of the order. An example of changes that are not caught by this query are changes that would affect the version, but not the FHIR content.
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationOrder?patient=12724067
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "b4a46440-d23a-4161-9456-1587475fc314",
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationOrder?patient=12724067"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationOrder/309799821",
"resource": {
"resourceType": "MedicationOrder",
"id": "309799821",
"meta": {
"versionId": "1",
"lastUpdated": "2020-03-20T01:00:37.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Medication Order</b></p><p><b>Patient Name</b>: SMART, JOE</p><p><b>Medication Name</b>: levoFLOXacin</p><p><b>Dosage Instructions</b>: 728 mg = 145.6 mL, IV Piggyback, Daily</p><p><b>Status</b>: Active</p></div>"
},
"dateWritten": "2020-03-05T11:26:02.000-06:00",
"status": "active",
"patient": {
"reference": "Patient/12724067",
"display": "SMART, JOE"
},
"prescriber": {
"reference": "Practitioner/4122622",
"display": "Cerner Test, Physician - Hospitalist Cerner"
},
"encounter": {
"reference": "Encounter/97953480"
},
"medicationCodeableConcept": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "82122",
"display": "Levofloxacin",
"userSelected": false
}
],
"text": "levoFLOXacin"
},
"dosageInstruction": [
{
"text": "728 mg = 145.6 mL, IV Piggyback, Daily",
"_text": {
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display",
"valueString": "IV Piggyback every day. Refills: 0."
}
]
},
"timing": {
"repeat": {
"boundsPeriod": {
"start": "2020-03-05T11:26:00.000-06:00"
}
},
"code": {
"coding": [
{
"system": "http://hl7.org/fhir/timing-abbreviation",
"code": "QD",
"display": "QD",
"userSelected": false
}
],
"text": "Daily"
}
},
"route": {
"coding": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C38279",
"display": "INTRAVENOUS DRIP",
"userSelected": false
},
{
"system": "http://snomed.info/sct",
"code": "47625008",
"display": "Intravenous route (qualifier value)",
"userSelected": false
}
],
"text": "IV Piggyback"
},
"doseQuantity": {
"value": 728.0,
"unit": "mg",
"system": "http://unitsofmeasure.org",
"code": "mg"
}
}
],
"dispenseRequest": {
"validityPeriod": {
"start": "2020-03-05T11:26:02.000-06:00"
}
}
}
},
{
"fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationOrder/309799757",
"resource": {
"resourceType": "MedicationOrder",
"id": "309799757",
"meta": {
"versionId": "1",
"lastUpdated": "2020-03-20T01:00:37.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Medication Order</b></p><p><b>Patient Name</b>: SMART, JOE</p><p><b>Medication Name</b>: vancomycin</p><p><b>Dosage Instructions</b>: 2,275 mg, IV Piggyback, Once</p><p><b>Status</b>: Active</p></div>"
},
"dateWritten": "2020-03-05T11:26:02.000-06:00",
"status": "active",
"dateEnded": "2020-03-05T11:26:00.000-06:00",
"patient": {
"reference": "Patient/12724067",
"display": "SMART, JOE"
},
"prescriber": {
"reference": "Practitioner/4122622",
"display": "Cerner Test, Physician - Hospitalist Cerner"
},
"encounter": {
"reference": "Encounter/97953480"
},
"medicationCodeableConcept": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "11124",
"display": "Vancomycin",
"userSelected": false
}
],
"text": "vancomycin"
},
"dosageInstruction": [
{
"text": "2,275 mg, IV Piggyback, Once",
"_text": {
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display",
"valueString": "IV Piggyback once. Refills: 0."
}
]
},
"timing": {
"repeat": {
"boundsPeriod": {
"start": "2020-03-05T11:26:00.000-06:00",
"end": "2020-03-05T11:26:00.000-06:00"
}
},
"code": {
"text": "Once"
}
},
"route": {
"coding": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C38279",
"display": "INTRAVENOUS DRIP",
"userSelected": false
},
{
"system": "http://snomed.info/sct",
"code": "47625008",
"display": "Intravenous route (qualifier value)",
"userSelected": false
}
],
"text": "IV Piggyback"
},
"doseQuantity": {
"value": 2275.0,
"unit": "mg",
"system": "http://unitsofmeasure.org",
"code": "mg"
}
}
],
"dispenseRequest": {
"validityPeriod": {
"start": "2020-03-05T11:26:02.000-06:00"
}
}
}
}
]
}
Retrieve by ID
List an individual medication order by its ID.
GET /MedicationOrder/:id
Authorization Types
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationOrder/309799821
Response
Status: 200 OK
{
"resourceType": "MedicationOrder",
"id": "309799821",
"meta": {
"versionId": "1",
"lastUpdated": "2020-03-20T01:00:37.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Medication Order</b></p><p><b>Patient Name</b>: SMART, JOE</p><p><b>Medication Name</b>: levoFLOXacin</p><p><b>Dosage Instructions</b>: 728 mg = 145.6 mL, IV Piggyback, Daily</p><p><b>Status</b>: Active</p></div>"
},
"dateWritten": "2020-03-05T11:26:02.000-06:00",
"status": "active",
"patient": {
"reference": "Patient/12724067",
"display": "SMART, JOE"
},
"prescriber": {
"reference": "Practitioner/4122622",
"display": "Cerner Test, Physician - Hospitalist Cerner"
},
"encounter": {
"reference": "Encounter/97953480"
},
"medicationCodeableConcept": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "82122",
"display": "Levofloxacin",
"userSelected": false
}
],
"text": "levoFLOXacin"
},
"dosageInstruction": [
{
"text": "728 mg = 145.6 mL, IV Piggyback, Daily",
"_text": {
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/patient-friendly-display",
"valueString": "IV Piggyback every day. Refills: 0."
}
]
},
"timing": {
"repeat": {
"boundsPeriod": {
"start": "2020-03-05T11:26:00.000-06:00"
}
},
"code": {
"coding": [
{
"system": "http://hl7.org/fhir/timing-abbreviation",
"code": "QD",
"display": "QD",
"userSelected": false
}
],
"text": "Daily"
}
},
"route": {
"coding": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C38279",
"display": "INTRAVENOUS DRIP",
"userSelected": false
},
{
"system": "http://snomed.info/sct",
"code": "47625008",
"display": "Intravenous route (qualifier value)",
"userSelected": false
}
],
"text": "IV Piggyback"
},
"doseQuantity": {
"value": 728.0,
"unit": "mg",
"system": "http://unitsofmeasure.org",
"code": "mg"
}
}
],
"dispenseRequest": {
"validityPeriod": {
"start": "2020-03-05T11:26:02.000-06:00"
}
}
}