MedicationAdministration
Overview
The Medication Administration resource provides information about medications and vaccines administered to a patient or consumed by a patient including injections, intravenous solutions, and self administered oral medications.
- IMPORTANT NOTE: Infuse or Bolus administration results for continuous infusion orders may require additional calculations to determine the actual amount of medication administered per ingredient. An additional calculation is required when the dosage quantity does not equal the contained Medication product ingredient amount denominator. In this case, calculate the ratio between the ingredient’s numerator divided by the denominator and multiply by dosage quantity. This will be the actual amount of medication administered.
- NOTE: These corrections may be breaking changes for your use cases. Current users of the MedicationAdministration API should test in their non-production domains. Cerner will coordinate with you and your developers of 3rd party applications to enable in your production domains.
The following fields are returned if valued:
- Medication Administration id
- Infuse Over Time Extension
- Status
- Patient
- Practitioner
- Encounter
- Prescription
- Effective Time
- Medication
- Details of medication administered:
Terminology Bindings
| MedicationAdministration.medicationCodeableConcept |
|
| MedicationAdministration.dosage.siteCodeableConcept |
|
| MedicationAdministration.dosage.route |
|
Contained Medication Bindings
| Medication.code |
|
Extensions
Custom Extensions
All URLs for custom extensions are defined as https://fhir-ehr.cerner.com/dstu2/StructureDefinition/{id}
| ID | Value[x] Type | Description |
|---|---|---|
infuse-over-time |
Quantity |
The length of time in minutes it took to infuse a medication. |
Search
Search for MedicationAdministrations that meet supplied query parameters:
GET /MedicationAdministration?:parameters
Implementation Notes
- MedicationAdministration.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 within the context of a MedicationAdministration and cannot be referenced independently.
- IMPORTANT NOTE: Infuse or Bolus administration results for continuous infusion orders may require additional calculations to determine the actual amount of medication administered per ingredient. An additional calculation is required when the dosage quantity does not equal the contained Medication product ingredient amount denominator. In this case, calculate the ratio between the ingredient’s numerator divided by the denominator and multiply by dosage quantity. This will be the actual amount of medication administered.
- NOTE: These corrections may be breaking changes for your use cases. Current users of the MedicationAdministration API should test in their non-production domains. Cerner will coordinate with you and your developers of 3rd party applications to enable in your production domains.
Authorization Types
Parameters
| Name | Required? | Type | Description |
|---|---|---|---|
_id |
This, or patient
|
token |
The logical resource id associated with the resource. |
patient |
This, or _id
|
reference |
The patient who has received the medication administration. Example: patient=12345
|
status |
N | token |
The status of the medication administration, may be a list separated by commas. Example: status=completed
|
practitioner |
N | reference |
The performing clinician, may be a list separated by commas. Example: practitioner=12345
|
notgiven |
N | token |
Administrations that were not made. A value of ‘true’ will search for these, and a value of ‘false’ will exclude them. Example: true
|
effectivetime |
N | date |
The effectivetime search may be provided once with either the ge or le prefix or twice with the ge and le prefixes to indicate a specific range. Example: effectivetime=ge2010-08-18 or effectivetime=le2015-07-17 or effectivetime=ge2010-08-18&effectivetime=le2015-07-17
|
_count |
N | number |
The maximum number of results to return. |
Notes:
- Either the
_id, or a combination ofpatient,status,practitioner,notgiven,effectivetime, or_countparameters must be provided. Default sort is by administration end date time.
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>Example
Request
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationAdministration?patient=12724066
Response
Status: 200 OK{
"resourceType": "Bundle",
"id": "b3e1848e-92db-482f-a7b1-62808aacd8ec",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationAdministration?patient=12724066"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationAdministration/197292849",
"resource": {
"resourceType": "MedicationAdministration",
"id": "197292849",
"meta": {
"versionId": "197292850",
"lastUpdated": "2020-07-06T21:13:24.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Medication Administration</b></p><p><b>Patient Name</b>: SMART, NANCY</p><p><b>Medication Display</b>: acetaminophen</p><p><b>Administered</b>: Yes</p><p><b>Dosage Quantity</b>: 650 mg</p><p><b>Medication Status</b>: Completed</p><p><b>Effective Time</b>: Jul 6, 2020 9:11 P.M. UTC</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/infuse-over-time",
"valueQuantity": {
"value": 6.0,
"unit": "minutes",
"system": "http://unitsofmeasure.org",
"code": "min"
}
}
],
"status": "completed",
"patient": {
"reference": "Patient/12724066",
"display": "SMART, NANCY"
},
"practitioner": {
"reference": "Practitioner/12724064",
"display": "Spence, Open Platform IA, Stephen"
},
"encounter": {
"reference": "Encounter/97953477"
},
"prescription": {
"reference": "MedicationOrder/313764715"
},
"wasNotGiven": false,
"effectiveTimeDateTime": "2020-07-06T21:11:00.000Z",
"medicationCodeableConcept": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "313782",
"display": "Acetaminophen 325 MG Oral Tablet",
"userSelected": false
}
],
"text": "acetaminophen"
},
"dosage": {
"route": {
"coding": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C38288",
"display": "ORAL",
"userSelected": false
},
{
"system": "http://snomed.info/sct",
"code": "26643006",
"display": "Oral route (qualifier value)",
"userSelected": false
}
],
"text": "Oral"
},
"quantity": {
"value": 650,
"unit": "mg",
"system": "http://unitsofmeasure.org",
"code": "mg"
}
}
}
}
]
}Request
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationAdministration?_id=197375293
Response
Status: 200 OK{
"resourceType": "Bundle",
"id": "6a897d29-daca-4f04-b6f5-7e2cdec12f09",
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationAdministration?_id=197375293"
}
],
"entry": [
{
"fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationAdministration/197375293",
"resource": {
"resourceType": "MedicationAdministration",
"id": "197375293",
"meta": {
"versionId": "197375292",
"lastUpdated": "2020-09-24T13:41:07.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Medication Administration</b></p><p><b>Patient Name</b>: TEST, BOB</p><p><b>Medication Display</b>: Dopamine Hydrochloride 80 MG/ML Injection</p><p><b>Administered</b>: Yes</p><p><b>Dosage Quantity</b>: 12.76 milliliter (iso1000)</p><p><b>Medication Status</b>: Completed</p><p><b>Effective Start Time</b>: Sep 24, 2020 2:00 P.M. UTC</p><p><b>Effective End Time</b>: Sep 24, 2020 2:59 P.M. UTC</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/infuse-over-time",
"valueQuantity": {
"value": 6.0,
"unit": "minutes",
"system": "http://unitsofmeasure.org",
"code": "min"
}
}
],
"contained": [
{
"resourceType": "Medication",
"id": "197375293",
"product": {
"ingredient": [
{
"item": {
"reference": "#197375295-1",
"display": "Dopamine Hydrochloride 80 MG/ML Injection"
},
"amount": {
"numerator": {
"value": 400,
"unit": "milligram (mass)",
"system": "http://unitsofmeasure.org",
"code": "mg"
},
"denominator": {
"value": 500,
"unit": "milliliter (iso1000)",
"system": "http://unitsofmeasure.org",
"code": "mL"
}
}
},
{
"item": {
"reference": "#197375297-2",
"display": "50 ML Glucose 50 MG/ML Injection"
},
"amount": {
"numerator": {
"value": 500,
"unit": "milliliter (iso1000)",
"system": "http://unitsofmeasure.org",
"code": "mL"
},
"denominator": {
"value": 500,
"unit": "milliliter (iso1000)",
"system": "http://unitsofmeasure.org",
"code": "mL"
}
}
}
]
}
},
{
"resourceType": "Medication",
"id": "197375295-1",
"code": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "1743951",
"display": "Dopamine Hydrochloride 80 MG/ML Injection",
"userSelected": false
}
],
"text": "DOPamine"
}
},
{
"resourceType": "Medication",
"id": "197375297-2",
"code": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "1795616",
"display": "50 ML Glucose 50 MG/ML Injection",
"userSelected": false
}
],
"text": "Dextrose 5% in Water"
}
}
],
"status": "completed",
"patient": {
"reference": "Patient/12545984",
"display": "TEST, BOB"
},
"practitioner": {
"reference": "Practitioner/1",
"display": "SYSTEM, SYSTEM Cerner"
},
"encounter": {
"reference": "Encounter/97887460"
},
"prescription": {
"reference": "MedicationOrder/316367035"
},
"wasNotGiven": false,
"effectiveTimePeriod": {
"start": "2020-09-24T14:00:00.000Z",
"end": "2020-09-24T14:59:00.000Z"
},
"medicationReference": {
"reference": "#197375293",
"display": "Dopamine Hydrochloride 80 MG/ML Injection"
},
"dosage": {
"siteCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "66480008",
"display": "Structure of left forearm (body structure)",
"userSelected": false
}
],
"text": "Arm, Lower, Left"
},
"quantity": {
"value": 12.76,
"unit": "milliliter (iso1000)",
"system": "http://unitsofmeasure.org",
"code": "mL"
},
"rateRatio": {
"numerator": {
"value": 12.76,
"unit": "milliliter (iso1000)",
"system": "http://unitsofmeasure.org",
"code": "mL"
},
"denominator": {
"value": 1,
"unit": "hour (iso1000)",
"system": "http://unitsofmeasure.org",
"code": "h"
}
}
}
}
}
]
}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.
Retrieve by id
List an individual MedicationAdministration by its id:
GET /MedicationAdministration/:id
Implementation Notes
- MedicationAdministration.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 within the context of a MedicationAdministration and cannot be be referenced independently.
- IMPORTANT NOTE: Infuse or Bolus administration results for continuous infusion orders may require additional calculations to determine the actual amount of medication administered per ingredient. An additional calculation is required when the dosage quantity does not equal the contained Medication product ingredient amount denominator. In this case, calculate the ratio between the ingredient’s numerator divided by the denominator and multiply by dosage quantity. This will be the actual amount of medication administered.
- NOTE: These corrections may be breaking changes for your use cases. Current users of the MedicationAdministration API should test in their non-production domains. Cerner will coordinate with you and your developers of 3rd party applications to enable in your production domains.
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/MedicationAdministration/197292849
Response
Status: 200 OK{
"resourceType": "MedicationAdministration",
"id": "197292849",
"meta": {
"versionId": "197292850",
"lastUpdated": "2020-07-06T21:13:24.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Medication Administration</b></p><p><b>Patient Name</b>: SMART, NANCY</p><p><b>Medication Display</b>: acetaminophen</p><p><b>Administered</b>: Yes</p><p><b>Dosage Quantity</b>: 650 mg</p><p><b>Medication Status</b>: Completed</p><p><b>Effective Time</b>: Jul 6, 2020 9:11 P.M. UTC</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/infuse-over-time",
"valueQuantity": {
"value": 6.0,
"unit": "minutes",
"system": "http://unitsofmeasure.org",
"code": "min"
}
}
],
"status": "completed",
"patient": {
"reference": "Patient/12724066",
"display": "SMART, NANCY"
},
"practitioner": {
"reference": "Practitioner/12724064",
"display": "Spence, Open Platform IA, Stephen"
},
"encounter": {
"reference": "Encounter/97953477"
},
"prescription": {
"reference": "MedicationOrder/313764715"
},
"wasNotGiven": false,
"effectiveTimeDateTime": "2020-07-06T21:11:00.000Z",
"medicationCodeableConcept": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "313782",
"display": "Acetaminophen 325 MG Oral Tablet",
"userSelected": false
}
],
"text": "acetaminophen"
},
"dosage": {
"route": {
"coding": [
{
"system": "http://ncimeta.nci.nih.gov",
"code": "C38288",
"display": "ORAL",
"userSelected": false
},
{
"system": "http://snomed.info/sct",
"code": "26643006",
"display": "Oral route (qualifier value)",
"userSelected": false
}
],
"text": "Oral"
},
"quantity": {
"value": 650,
"unit": "mg",
"system": "http://unitsofmeasure.org",
"code": "mg"
}
}
}Request
GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/MedicationAdministration/197375293
Response
Status: 200 OK{
"resourceType": "MedicationAdministration",
"id": "197375293",
"meta": {
"versionId": "197375292",
"lastUpdated": "2020-09-24T13:41:07.000Z"
},
"text": {
"status": "generated",
"div": "<div><p><b>Medication Administration</b></p><p><b>Patient Name</b>: TEST, BOB</p><p><b>Medication Display</b>: Dopamine Hydrochloride 80 MG/ML Injection</p><p><b>Administered</b>: Yes</p><p><b>Dosage Quantity</b>: 12.76 milliliter (iso1000)</p><p><b>Medication Status</b>: Completed</p><p><b>Effective Start Time</b>: Sep 24, 2020 2:00 P.M. UTC</p><p><b>Effective End Time</b>: Sep 24, 2020 2:59 P.M. UTC</p></div>"
},
"extension": [
{
"url": "https://fhir-ehr.cerner.com/dstu2/StructureDefinition/infuse-over-time",
"valueQuantity": {
"value": 6.0,
"unit": "minutes",
"system": "http://unitsofmeasure.org",
"code": "min"
}
}
],
"contained": [
{
"resourceType": "Medication",
"id": "197375293",
"product": {
"ingredient": [
{
"item": {
"reference": "#197375295-1",
"display": "Dopamine Hydrochloride 80 MG/ML Injection"
},
"amount": {
"numerator": {
"value": 400,
"unit": "milligram (mass)",
"system": "http://unitsofmeasure.org",
"code": "mg"
},
"denominator": {
"value": 500,
"unit": "milliliter (iso1000)",
"system": "http://unitsofmeasure.org",
"code": "mL"
}
}
},
{
"item": {
"reference": "#197375297-2",
"display": "50 ML Glucose 50 MG/ML Injection"
},
"amount": {
"numerator": {
"value": 500,
"unit": "milliliter (iso1000)",
"system": "http://unitsofmeasure.org",
"code": "mL"
},
"denominator": {
"value": 500,
"unit": "milliliter (iso1000)",
"system": "http://unitsofmeasure.org",
"code": "mL"
}
}
}
]
}
},
{
"resourceType": "Medication",
"id": "197375295-1",
"code": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "1743951",
"display": "Dopamine Hydrochloride 80 MG/ML Injection",
"userSelected": false
}
],
"text": "DOPamine"
}
},
{
"resourceType": "Medication",
"id": "197375297-2",
"code": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "1795616",
"display": "50 ML Glucose 50 MG/ML Injection",
"userSelected": false
}
],
"text": "Dextrose 5% in Water"
}
}
],
"status": "completed",
"patient": {
"reference": "Patient/12545984",
"display": "TEST, BOB"
},
"practitioner": {
"reference": "Practitioner/1",
"display": "SYSTEM, SYSTEM Cerner"
},
"encounter": {
"reference": "Encounter/97887460"
},
"prescription": {
"reference": "MedicationOrder/316367035"
},
"wasNotGiven": false,
"effectiveTimePeriod": {
"start": "2020-09-24T14:00:00.000Z",
"end": "2020-09-24T14:59:00.000Z"
},
"medicationReference": {
"reference": "#197375293",
"display": "Dopamine Hydrochloride 80 MG/ML Injection"
},
"dosage": {
"siteCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "66480008",
"display": "Structure of left forearm (body structure)",
"userSelected": false
}
],
"text": "Arm, Lower, Left"
},
"quantity": {
"value": 12.76,
"unit": "milliliter (iso1000)",
"system": "http://unitsofmeasure.org",
"code": "mL"
},
"rateRatio": {
"numerator": {
"value": 12.76,
"unit": "milliliter (iso1000)",
"system": "http://unitsofmeasure.org",
"code": "mL"
},
"denominator": {
"value": 1,
"unit": "hour (iso1000)",
"system": "http://unitsofmeasure.org",
"code": "h"
}
}
}
}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.