MedicationStatement
These FHIR MedicationStatement 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 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 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