MedicalAdministration
These FHIR MedicalAdministration 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
Endpoints
- Primary
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