Medication

The Medication feature allows the user to add a new medication, modify an existing medication or retrieve a list of medications of the patient. The Medication Reference will allow the user to retrieve the list of configured medication in the system.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Add medication to patient's medication list
POST
/v1/{practiceid}/chart/{patientid}/medications

Add a new medication to the patient's medication list

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
patientid integer patientid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
medicationentryid string If successful, the athena ID of the newly created historical medication
success string Whether the operation was successful or not.
Example Code
Get patient's medication list
GET
/v1/{practiceid}/chart/{patientid}/medications

Retrieves list of patient's medication and medication details

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
patientid integer patientid
showpend boolean Include pending medications associated with approved future orders. These medications have not yet been submitted.
showrxnorm boolean Shows the list of RxNorm Identifiers related to the medication. The list may contain both branded and generic identifiers. Note: Not All medications would include RX Norm.
departmentid integer The athenanet department ID
medicationtype string Historical or Active or Denied. Will return a list of a patient's active or historical or denied medications.
showndc boolean Shows the list of NDC numbers related to the medication.
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
lastdownloaddenialreason string BETA FIELD: The reason the last medication history download was denied.
lastdownloaddenied string BETA FIELD: Whether or not the last medication history download was denied.
lastdownloadeddate string The time of the last attempted medication history download from SureScripts.
lastupdated string The last time any of the medications were updated
medications array The list of medications
nomedicationsreported string Whether the patient explicitly has no reported medications
patientdownloadconsent string Whether or not the patient has consented to have their medication history downloaded. There are plans to deprecate this field.
patientneedsdownloadconsent string Whether or not the patient needs to consent to have medication history downloaded. This will be true if either the patient has not currently consented, or the practice is not enabled for these downloads. This field is typically used when determining whether to message to the patient that they have not consented to these downloads. Note that regardless of this setting, medication history that has already been downloaded will remain available.
sectionnote string A section-wide note
Example Code
Update patient's medication list
PUT
/v1/{practiceid}/chart/{patientid}/medications

Modifies the patient 's existing medication

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
patientid integer patientid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code
Update patient's medication list
PUT
/v1/{practiceid}/chart/{patientid}/medications/{medicationentryid}

Modifies the properties of a given medication. E.g. reason to stop having the medication, etc.

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
medicationentryid string medicationentryid
patientid integer patientid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code
Hide medication on patient's medication list (mark as hidden)
DELETE
/v1/{practiceid}/chart/{patientid}/medications/{medicationentryid}

BETA: Deletes the record of the medication

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
medicationentryid string medicationentryid
patientid integer patientid
departmentid integer The athenanet department ID

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code
Get list of mediation stop reasons
GET
/v1/{practiceid}/reference/medications/stopreasons

Retrieves a list of medication stop reason configured in the system

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

Output Parameters

Expand all
stopreason string The stop reason. Used when adding or updating medications.
stopreasonid integer The athena ID of this stop reason
Example Code
Search for available medications
GET
/v1/{practiceid}/reference/medications

Retrieves a list of medications for a given search parameters

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
searchvalue string A term to search for. Must be at least 2 characters

Output Parameters

Expand all
medication string The name of the medication
medicationid integer The athena ID of the medication
Example Code