FHIR DSTU2 - Chart - Medications
These FHIR Medications (Charts) 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-1: that these endpoints do not follow the same naming conventions as many of the other APIs offered.
Note-2: 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
Endpoints
-
Primary
Get a specific medication by
ID
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Medication/{medicationid}
Medication 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
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
departmentid
integer
departmentid
medicationid
integer
medicationid
Output Parameters
Expand all
code
object
Codes that identify this medication
id
string
Logical id of this artifact
resourcetype
string
The type of resource
Example Code
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
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
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 administrations for a given
patient.
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationAdministration
List of MedicationAdministration 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
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
departmentid
integer
departmentid
identifier
integer
Medication administration 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
device
array
Device used to administer
dosage
object
Details of how medication was taken
effectivetimeperiod
object
Start and end time of administration
encounter
object
Encounter administered as part of
id
string
Logical id of this artifact
identifier
array
External identifier
medicationreference
object
What was administered
note
string
Information about the administration
patient
object
Who received medication
practitioner
object
Who administered substance
prescription
object
Order administration performed against
reasongiven
array
Reason administration performed
reasonnotgiven
array
Reason administration not performed
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
wasnotgiven
string
True if medication not administered
Example Code
Get a specific medication administration by
ID
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationAdministration/{medicationadministrationid}
MedicationAdministration 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
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
departmentid
integer
departmentid
medicationadministrationid
integer
medicationadministrationid
patient
integer
The patient ID (same as "PATIENTID" in non-FHIR calls).
Output Parameters
Expand all
device
array
Device used to administer
dosage
object
Details of how medication was taken
effectivetimeperiod
object
Start and end time of administration
encounter
object
Encounter administered as part of
id
string
Logical id of this artifact
identifier
array
External identifier
medicationreference
object
What was administered
note
string
Information about the administration
patient
object
Who received medication
practitioner
object
Who administered substance
prescription
object
Order administration performed against
reasongiven
array
Reason administration performed
reasonnotgiven
array
Reason administration not performed
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
wasnotgiven
string
True if medication not administered
Example Code
Gets a list of medications and statements for a given
patient.
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationStatement
List of MedicationStatement 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
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
departmentid
integer
departmentid
identifier
integer
Medication statement ID
patient
integer
The patient ID (same as "PATIENTID" in non-FHIR calls).
status
string
Status code specifying the state of the order, states: active or completed. Example state=active
medication
integer
Medication ID
_lastupdated
string
Last updated filter
effectivedate
string
Medication statement fill date or created date, not event effective date, example format yyyy-mm-dd
code
integer
Medication code (RxNorm).
THIRDPARTYUSERNAME
string
User name of the patient in the third party application.
PATIENTFACINGCALL
boolean
When 'true' is passed we will collect relevant data and store in our database.
Output Parameters
Expand all
contained
object
Medication contained in statement
dosage
array
Details of how medication was taken
effectiveperiod
object
Over what period was medication consumed?
id
string
Logical id of this artifact
identifier
array
External identifier
medicationreference
object
What medication was taken
patient
object
Who is/was taking the medication
resourcetype
string
The type of resource
status
string
active | completed | entered-in-error(Not Supported) | intended(Not Supported)
text
object
Text summary of the resource, for human interpretation
Example Code
Get a specific medication statement by
ID
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationStatement/{medicationstatementid}
MedicationStatement 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
Input Parameters
Expand all❙ required
medicationstatementid
integer
medicationstatementid
practiceid
integer
practiceid
departmentid
integer
departmentid
patient
integer
The patient ID (same as "PATIENTID" in non-FHIR calls).
Output Parameters
Expand all
dosage
array
Details of how medication was taken
effectiveperiod
object
Over what period was medication consumed?
id
string
Logical id of this artifact
identifier
array
External identifier
medicationreference
object
What medication was taken
patient
object
Who is/was taking the medication
resourcetype
string
The type of resource
status
string
active | completed | entered-in-error | intended
text
object
Text summary of the resource, for human interpretation
Example Code
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
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
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
Get a specific medication by
ID
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Medication/{medicationid}
Medication 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
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
brandid
integer
brandid
medicationid
integer
medicationid
chartsharinggroupid
integer
chartsharinggroupid
Output Parameters
Expand all
code
object
Codes that identify this medication
id
string
Logical id of this artifact
resourcetype
string
The type of resource
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
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
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
Gets a list of medications and statements for a given
patient.
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationStatement
List of MedicationStatement 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
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
brandid
integer
brandid
chartsharinggroupid
integer
chartsharinggroupid
identifier
integer
Medication statement 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
effectivedate
string
Medication statement effective date
code
integer
Medication code (RxNorm).
THIRDPARTYUSERNAME
string
User name of the patient in the third party application.
PATIENTFACINGCALL
boolean
When 'true' is passed we will collect relevant data and store in our database.
Output Parameters
Expand all
contained
object
Medication contained in statement
dosage
array
Details of how medication was taken
effectiveperiod
object
Over what period was medication consumed?
id
string
Logical id of this artifact
identifier
array
External identifier
medicationreference
object
What medication was taken
patient
object
Who is/was taking the medication
resourcetype
string
The type of resource
status
string
active | completed | entered-in-error(Not Supported) | intended(Not Supported)
text
object
Text summary of the resource, for human interpretation
Example Code
Get a specific medication statement by
ID
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationStatement/{medicationstatementid}
MedicationStatement 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
Input Parameters
Expand all❙ required
medicationstatementid
integer
medicationstatementid
practiceid
integer
practiceid
brandid
integer
brandid
chartsharinggroupid
integer
chartsharinggroupid
patient
integer
The patient ID (same as "PATIENTID" in non-FHIR calls).
Output Parameters
Expand all
dosage
array
Details of how medication was taken
effectiveperiod
object
Over what period was medication consumed?
id
string
Logical id of this artifact
identifier
array
External identifier
medicationreference
object
What medication was taken
patient
object
Who is/was taking the medication
resourcetype
string
The type of resource
status
string
active | completed | entered-in-error | intended
text
object
Text summary of the resource, for human interpretation
Example Code
Get an individual substance by
ID
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Substance/{substanceid}
No description
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
substanceid
string
substanceid
departmentid
integer
departmentid
Output Parameters
Expand allExample Code