MedicationOrder

These FHIR MedicationOrder endpoints are a partial implementation of the FHIR DSTU2 specification. We will consider expanding these and adding additional FHIR endpoints, as well as future versions, based on usage and requests from API users.

Note: these endpoints do not follow the same naming conventions as many of the other APIs offered.

Note: If you are accessing a practice without Communicator Brands and are using one of the endpoints that require BRANDID in the path, you can use any positive integer for BRANDID.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Gets a list of medications and orders for a given patient.

GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationOrder
List of MedicationOrder resources from the results of the search
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
departmentid integer departmentid
identifier integer Medication order ID
datewritten string Date written
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).
status string Status code specifying the state of the order.
medication integer Medication ID
_lastupdated string Last updated filter
code integer Medication code (RxNorm).

Output Parameters

Expand all
dateended string When prescription was stopped
datewritten string When prescription was authorized
dispenserequest object Medication supply authorization
dosageinstruction array How medication should be taken
encounter object Created during encounter/admission/stay
id string Logical id of this artifact
identifier array External identifier
medicationreference object Medication to be taken
patient object Who prescription is for
prescriber object Who ordered the medication(s)
reasonended object Why prescription was stopped
resourcetype string The type of resource
status string active | on-hold | completed | entered-in-error | stopped | draft
text object Text summary of the resource, for human interpretation
Example Code

Get a specific medication order by ID

GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationOrder/{medicationorderid}
MedicationOrder resource from given ID
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
medicationorderid integer medicationorderid
departmentid integer departmentid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
dateended string When prescription was stopped
datewritten string When prescription was authorized
dispenserequest object Medication supply authorization
dosageinstruction array How medication should be taken
encounter object Created during encounter/admission/stay
id string Logical id of this artifact
identifier array External identifier
medicationreference object Medication to be taken
patient object Who prescription is for
prescriber object Who ordered the medication(s)
reasonended object Why prescription was stopped
resourcetype string The type of resource
status string active | on-hold | completed | entered-in-error | stopped | draft
text object Text summary of the resource, for human interpretation
Example Code

Gets a list of medications and orders for a given patient.

GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationOrder
List of MedicationOrder resources from the results of the search
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
brandid integer brandid
chartsharinggroupid integer chartsharinggroupid
identifier integer Medication order ID
datewritten string Date written
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).
status string Status code specifying the state of the order.
medication integer Medication ID
code integer Medication code (RxNorm).

Output Parameters

Expand all
dateended string When prescription was stopped
datewritten string When prescription was authorized
dispenserequest object Medication supply authorization
dosageinstruction array How medication should be taken
encounter object Created during encounter/admission/stay
id string Logical id of this artifact
identifier array External identifier
medicationreference object Medication to be taken
patient object Who prescription is for
prescriber object Who ordered the medication(s)
reasonended object Why prescription was stopped
resourcetype string The type of resource
status string active | on-hold | completed | entered-in-error | stopped | draft
text object Text summary of the resource, for human interpretation
Example Code

Get a specific medication order by ID

GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationOrder/{medicationorderid}
MedicationOrder resource from given ID
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
medicationorderid integer medicationorderid
brandid integer brandid
chartsharinggroupid integer chartsharinggroupid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
dateended string When prescription was stopped
datewritten string When prescription was authorized
dispenserequest object Medication supply authorization
dosageinstruction array How medication should be taken
encounter object Created during encounter/admission/stay
id string Logical id of this artifact
identifier array External identifier
medicationreference object Medication to be taken
patient object Who prescription is for
prescriber object Who ordered the medication(s)
reasonended object Why prescription was stopped
resourcetype string The type of resource
status string active | on-hold | completed | entered-in-error | stopped | draft
text object Text summary of the resource, for human interpretation
Example Code