MedicationDispense

These FHIR MedicationDispense 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 dispenses for a given patient.

GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationDispense
List of MedicationDispense 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 dispense ID
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
authorizingprescriptions array Medication order that authorizes the dispense
dayssupply object Days Supply
destination object Where the medication was sent
dispenser object Practitioner responsible for dispensing medication
dosageinstruction array Medicine administration instructions to the patient/caregiver
id string Logical id of this artifact
identifier string External identifier
medicationreference object What medication was supplied
note string Information about the dispense
patient object Who the dispense is for
quantity object Amount dispensed
receiver array Who collected the medication
resourcetype string The type of resource
status string in-progress | on-hold | completed | entered-in-error | stopped
text object Text summary of the resource, for human interpretation
type object Trial fill, partial fill, emergency fill, etc.
whenhandedover string When product was given out
whenprepared string Dispense processing time
Example Code

Get a specific medication dispense by ID

GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationDispense/{medicationdispenseid}
MedicationDispense 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
departmentid integer departmentid
medicationdispenseid integer medicationdispenseid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
authorizingprescriptions array Medication order that authorizes the dispense
dayssupply object Days Supply
destination object Where the medication was sent
dispenser object Practitioner responsible for dispensing medication
dosageinstruction array Medicine administration instructions to the patient/caregiver
id string Logical id of this artifact
identifier string External identifier
medicationreference object What medication was supplied
note string Information about the dispense
patient object Who the dispense is for
quantity object Amount dispensed
receiver array Who collected the medication
resourcetype string The type of resource
status string in-progress | on-hold | completed | entered-in-error | stopped
text object Text summary of the resource, for human interpretation
type object Trial fill, partial fill, emergency fill, etc.
whenhandedover string When product was given out
whenprepared string Dispense processing time
Example Code