Historical Medication
The Historical Medication Changed Subscription feature will allow the user to retrieve changes to the patient medication data. For more information about subscriptions, please refer Changed Data Subscriptions
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
-
Subscription
Get list of medication list change events to which you can
subscribe
GET
/v1/{practiceid}/chart/healthhistory/medication/changed/subscription/events
Retrieves the list of events that can be input for the Historical Medications changed subscription
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
Output Parameters
Expand all
status
string
Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions
array
List of events you are subscribed to.
Example Code
Subscribe to all/specific change events for medication
list
POST
/v1/{practiceid}/chart/healthhistory/medication/changed/subscription
Subscribe for changed historical medications events
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
Content-Type
string
Content type of the payload
Output Parameters
Expand all
success
string
Returns if the call to manipulate subscriptions for historical medications was successful.
Example Code
Get list of medication list change
subscription(s)
GET
/v1/{practiceid}/chart/healthhistory/medication/changed/subscription
Retrieves list of events for Historical Medications
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
Output Parameters
Expand all
status
string
Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions
array
List of events you are subscribed to.
Example Code
Get list of changes in medication list based on subscribed
events
GET
/v1/{practiceid}/chart/healthhistory/medication/changed
Retrieves list of modified historical medications
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
leaveunprocessed
boolean
For testing purposes, do not mark records as processed
showprocessedenddatetime
string
See showprocessedstartdatetime
patientid
array
Patient ID. Multiple Patient IDs are allowed, either comma separated or with multiple values.
showprocessedstartdatetime
string
Show already processed changes. This will show changes that you previously retrieved at some point after this datetime mm/dd/yyyy hh24:mi:ss (Eastern). Can be used to refetch data if there was an error, such as a timeout, and records are marked as already retrieved. This is intended to be used with showprocessedenddatetime and for a short period of time only. Also note that all messages will eventually be deleted.
limit
integer
Number of entries to return (default 1000, max 5000)Please note that this endpoint has a different default than normal.
offset
integer
Starting point of entries; 0-indexed
Output Parameters
Expand all
approvedby
string
For clinical prescriptions, the athenaNet username of the person who approved this prescription.
billingndc
string
The billing NDC code for this medication.
chartsharinggroupid
integer
The chart charing group for this medication. For more information on chart sharing groups see /configuration/chartsharinggroups.
createdby
string
The athenaNet username of the person who entered or ordered the medication. Downloaded medications have INTERFACE for this field.
deletedby
string
The athenaNet username of the person who deleted the medication.
earliestfilldate
string
The earliest date a prescription may be filled, in the format mm/dd/yyyy.
encounterid
integer
If this was a prescription, this contains the ID of the encounter where it was ordered or administered
events
array
The list of events for this medication. Can be START, END, ORDER, ENTER, FILL, or HIDE.
futuresubmitdate
string
The date a medication will be submitted. Included if the medication is in PEND status and attached to a approved future order.
issafetorenew
string
isstructuredsig
string
Whether the sig for this entry is structured.
lastupdated
string
The last time any of the medications were updated
medication
string
The name of the medication.
medicationentryid
string
Primary ID for this medication entry. Those starting with C are clinical prescriptions, and those starting with H are historical (entered, downloaded, etc).
medicationid
integer
Athena ID for this medication.
ndcoptions
string
The list of NDC numbers that correspond to this medication.
orderingmode
string
The ordering mode for prescriptions. Can be PRESCRIBE, DISPENSE, or ADMINISTER.
organclass
string
The organ class for this medication. This is equivalent to a medication class.
patientid
integer
The patient that this medication was prescribed to.
patientnote
string
Patient-facing note for this prescription. Labeled "note" in the UI.
pharmacy
string
The name of the pharmacy where this medication was filled.
pharmacyncpdpid
string
The NCPDP ID of the pharmacy for this medication.. See http://www.ncpdp.org/ for details.
prescribedby
string
The user who prescribed this medication.
providernote
string
Non-patient facing note for ths prescription. Labeled "internal note" in the UI.
refillsallowed
integer
The number of refills allowed when this medication was ordered.
route
string
The route for the prescription.
rxnorm
string
The list of RxNorm Identifiers that correspond to this medication. This list may contain both branded and generic identifiers. Note: Not All medications would include RX Norm.
source
string
How this medication was entered. This can be the ordering provider, a medication history download (express scripts, medco, etc), ATHENA (which means it was entered manually), etc.
status
string
The status of this medication. Medications in PEND status are associated with approved future orders and have not yet been submitted.
stopreason
string
The reason why this medication was stopped.
structuredsig
array
Components of the structured sig.
therapeuticclass
string
The therapeutic class for this medication. This is equivalent to a medication subclass.
unstructuredsig
string
The unstructured sig for this medication, if any. If there is a structured sig, this will contain the formatted version of that sig.
Example Code
Unsubscribe to all/specific change events for medication
list
DELETE
/v1/{practiceid}/chart/healthhistory/medication/changed/subscription
Delete an specific event which is no longer required
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
eventname
string
By default, you are unsubscribed from all possible events. If you only wish to unsubscribe from an individual event, pass the event name with this argument.
Output Parameters
Expand all
success
string
Returns if the call to manipulate subscriptions for historical medications was successful.
Example Code