Document Type - Prescription
Document Type - Prescription requires a physician or staff member to take action by either approving or denying the prescription and then faxing the document back to the pharmacy or closing the document to the patient’s chart. This feature allows the user to retrieve, add or modify prescription document information of a specific patient or a specific prescription document. The Document Type - Prescription Changed Subscription feature will allow the user to retrieve any changes made to the prescriptions documents since the last time this request was run. The user will need to initiate subscription. For more information about subscriptions, please refer Changed Data Subscriptions.
Prescription
By default, prescription documents are created in an open status.
Prescription – Change: Requests from pharmacies to substitute prescribed drugs, e.g., a request to substitute an on-formulary medication of the same class.
Prescription – Clarification: Clarifying questions from pharmacies regarding prescriptions, e.g., correct dosage amounts or the original quantity provided on the prescription.
Prescription – New: Requests from pharmacies for new prescriptions. This document class should not be used for adding new orders to an existing encounter or order group. See Order Prescription for more details.
Prescription – Prior Authorization Request: Requests from pharmacies for further authorization, typically for insurance reasons.
Prescription – Renewal: Requests to refill previously prescribed medication. The words “refill,” “renewal,” or “renew” typically appear on these forms.
Note: Subclassification is necessary for this document class.
Prescription Document Reassignment
Prescription documents can be reassigned to any username configured for the practice (including non-person usernames like PRACTICE). The prescription document must be in REVIEW status to be reassigned. API users need to use the document assignment GET endpoint to retrieve the list of valid usernames the document could be reassigned to in the practice.
Document Assignment Options
Before a prescription document can be reassigned, the API user needs to retrieve the list of valid usernames the document could be reassigned to in the practice. The GET /documentassignment/{documentid} endpoint retrieves the current status of the document and the list of all the usernames available for reassignment.
Document Reassignment
API users can reassign a prescription document using the PUT /patients/{patientid}/documents/prescription/{prescriptionid} endpoint. After retrieving the desired username with the document assignment GET, the API user uses the assignedto field to reassign the document to the chosen username.
Note: The prescription document must be in REVIEW to be reassigned. The reassignment of a prescription document in any other status causes an error.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
- Subscription
Get list of prescriptions for given patient
GET
/v1/{practiceid}/patients/{patientid}/documents/prescription
Retrieves a list of prescription document information for a specific patient
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
patientid
integer
patientid
showdeleted
boolean
By default, deleted documents are not listed. Set to list these.
status
string
The status of the task to filter document results.
startdate
string
An optional filter to specify the start of the documents search date range (MM/DD/YYYY). Inclusive.
encounterid
integer
Show only documents attached to this encounter.
documentsubclass
string
The document subclass to filter document results.
showdeclinedorders
boolean
If set, include orders that were declined
documentclass
string
The class(es) of document(s) comma separated.
enddate
string
An optional filter to specify the end of the documents search date range (MM/DD/YYYY). Inclusive.
departmentid
integer
The athenaNet department id.
limit
integer
Number of entries to return (default 1500, max 5000)
offset
integer
Starting point of entries; 0-indexed
Output Parameters
Expand all
appointmentid
integer
The appointment ID for this document
assignedto
string
Person the document is assigned to
createddate
string
Date the document was created. Please use createddatetime instead.
createddatetime
string
Date/Time (ISO 8601) the document was created
deaschedule
integer
A number corresponding to the level of restriction the drug is placed under by the DEA.
declinedreason
array
List of codes indicating why the order was not given. If this field is not present, the order was not declined. If the array is empty, no reason has been chosen.
declinedreasontext
string
The user-facing description of the reason the order was not given.
deleteddatetime
string
Date/time (ISO 8601) the document was deleted
departmentid
string
Department for the document
documentclass
string
Class of document
documentdescription
string
Description of the document type
documentroute
string
Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource
string
Explains where this document originated.
documentsubclass
string
Specific type of document
documenttypeid
integer
A specific document type identifier.
encounterid
string
Encounter ID
externalaccessionid
string
The external accession ID for this document. Format depends on the system the ID belongs to.
externalnote
string
External note for the patient.
facilityid
integer
The ID of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies.
internalaccessionid
string
The internal accession ID for this document. Format depends on the system the ID belongs to.
internalnote
string
The 'Internal Note' attached to this document
lastmodifieddatetime
string
Date/time (ISO 8601) the document was last modified
observationdate
string
observationdatetime
string
Date/time (ISO 8601) the observation was taken
orderingmode
string
Ordering Mode for a prescription. One of Prescribe, Adminster, Dispense
ordertype
string
Order type group name
patientcaseid
string
The patient case id
prescriptionid
integer
ID of a prescription document
priority
string
Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid
integer
Provider ID for this document
providernpi
string
NPI (National Provider Identity) of the provider for this prescription.
status
string
Status of the document
subject
string
Subject of the document
tietoorderid
integer
Order ID of the order this document is tied to, if any
Example Code
Get specific prescription document for given patient
GET
/v1/{practiceid}/patients/{patientid}/documents/prescription/{prescriptionid}
Retrieves a specific prescription document information for a specific patient
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
prescriptionid
integer
prescriptionid
patientid
integer
patientid
Output Parameters
Expand all
actionnote
string
The most recent action note for a document
administereddatetime
string
Date/time (ISO 8601) medication was administered
administerexpirationdate
string
Expiration of the medication or vaccine administered
administerlotnumber
string
Lot number of the medication or vaccine administered
administermanufacturer
string
Manufacturer of the administered medication
administernote
string
Adminster note
administerroute
string
The route the medication was administered using
administersite
string
The site on the patient that the medication/vaccine/etc was administered
administeruser
string
The username of the person who administered the prescription
assignedto
string
Person the document is assigned to
billingndc
string
The National Drug Code for the document
createddatetime
string
Date/Time (ISO 8601) the document was created
createduser
string
The user who created this document.
deaschedule
integer
A number corresponding to the level of restriction the drug is placed under by the DEA.
declinedreason
array
List of codes indicating why the order was not given. If this field is not present, the order was not declined. If the array is empty, no reason has been chosen.
declinedreasontext
string
The user-facing description of the reason the order was not given.
deleteddatetime
string
Date/time (ISO 8601) the document was deleted
departmentid
string
Department for the document
diagnosislist
array
Diagnoses for this document
dispenseaswritten
string
Whether this prescription is labeled Dispense As Written
documentclass
string
Class of document
documentdescription
string
Description of the document type
documentroute
string
Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource
string
Explains where this document originated.
documentsubclass
string
Specific type of document
documenttypeid
integer
A specific document type identifier.
dosageadditionalinstructions
string
Additional instructions for the medication
dosagedurationunit
string
Units for the dosage duration
dosagedurationvalue
number
Duration (in DOSAGEDURATIONUNITS) of the dosage
dosagefrequencyunit
string
Units for the dosage frequency
dosagefrequencyvalue
number
Frequency (in DOSAGEFREQUENCYUNITS) of the dosage
dosagequantityunit
string
Units for the dosage quantity
dosagequantityvalue
number
Quantity (in DOSAGEQUANTITYUNITS) of the dosage
earliestfilldate
string
The earliest date a prescription may be filled, in the format mm/dd/yyyy.
encounterid
string
Encounter ID
externalaccessionid
string
The external accession ID for this document. Format depends on the system the ID belongs to.
externalnote
string
External note for the patient.
facilityid
integer
The ID of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies.
futuresubmitdate
string
The future submit date in the format mm/dd/yyyy.
internalaccessionid
string
The internal accession ID for this document. Format depends on the system the ID belongs to.
internalnote
string
The 'Internal Note' attached to this document
isstructuredsig
string
If sig for a prescription was specified as structured entry, versus unstructured free text
lastmodifieddatetime
string
Date/time (ISO 8601) the document was last modified
lastmodifieduser
string
The user who last modified this document.
medid
integer
The medication ID of this medication
ndcs
array
List of NDCs associated with this prescription
notetopharmacy
string
A note to send to the pharmacy.
observationdatetime
string
Date/time (ISO 8601) the observation was taken
orderingmode
string
Ordering Mode for a prescription. One of Prescribe, Adminster, Dispense
ordertype
string
Order type group name
pages
array
An array of image pages associated with this document.
patientcaseid
string
The patient case id
prescriptionid
integer
ID of a prescription document
priority
string
Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid
integer
Provider ID for this document
providernpi
string
NPI (National Provider Identity) of the provider for this prescription.
quantityndc
string
National Drug Code
quantityunit
string
Unit for prescription quantity
quantityvalue
number
Value for prescription quantity
refillsallowed
integer
Number of refills allowed
rxnorm
string
RXNORM code for this drug
sampleexpirationdate
string
Expiration of the medication or vaccine sample
samplelotnumber
string
Lot number of the medication or vaccine sample
sig
string
Text sig for a prescription
status
string
Status of the document
subject
string
Subject of the document
Example Code
Update specific prescription document for given patient
PUT
/v1/{practiceid}/patients/{patientid}/documents/prescriptions/{prescriptionid}
Modifies the information for a specific prescription document
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
prescriptionid
integer
prescriptionid
patientid
integer
patientid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput 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 specific page from given prescription
GET
/v1/{practiceid}/patients/{patientid}/documents/prescription/{prescriptionid}/pages/{pageid}
Retrieves a specific page from the specific prescription document of the patient
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
pageid
integer
pageid
prescriptionid
integer
prescriptionid
patientid
integer
patientid
filesize
string
The file size of the document being requested.
Output Parameters
Expand all
attachment
string
The image of the page in jpeg format.
Example Code
Get list of change events for prescriptions
GET
/v1/{practiceid}/prescriptions/changed/subscription/events
Retrieves a list of all events that can be input for this subscription. Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see Permissioned Rollout of APIs for more information if you are experiencing issues.
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
departmentids
array
List of Departmentids subscribed
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 prescriptions
POST
/v1/{practiceid}/prescriptions/changed/subscription
Subscribes for changed prescription events Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see Permissioned Rollout of APIs for more information if you are experiencing issues.
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
❙ Request Body
Expand allOutput Parameters
Expand all
success
string
Returns if the call to manipulate subscriptions for prescription was successful.
Example Code
Get list of subscribed events for changes in prescriptions
GET
/v1/{practiceid}/prescriptions/changed/subscription
Retrieves list of events applicable for prescription Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see Permissioned Rollout of APIs for more information if you are experiencing issues.
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
departmentids
array
List of Departmentids subscribed
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 prescriptions
GET
/v1/{practiceid}/prescriptions/changed
Retrieves list of records of modified prescription data Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see Permissioned Rollout of APIs for more information if you are experiencing issues.
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
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
administeryn
string
True if the order is marked as administered.
approvedby
string
The user who approved this order. Blank if the order has not been approved.
approvedtimestamp
string
The timestamp when this order was approved. Blank if the order has not been approved.
assigneduser
string
User this order is assigned to.
class
string
The document class of this order.
classdescription
string
A description of the document class for this order.
clinicalordertypeid
integer
The athena ID for this type of order. Can be used to create another order of this type.
clinicalproviderordertypeid
integer
The Unique ID for the type of order referred to by a clinical provider. A clinical provider here refers to a facility.
dateordered
string
Timestamp for when this order was created.
deniedby
string
The user who denied this order. Blank if the order has not been denied.
deniedtimestamp
string
The timestamp when this order was denied. Blank if the order has not been denied.
departmentid
integer
The ID of the department this order is associated with.
description
string
A description of this document.
documentationonly
string
A boolean field describing if this order is documentation only.
documentid
integer
The id of this order.
encounterid
integer
The ID of the clinical encounter this order is associated with.
externalnote
string
Note to the provider.
ordergenusname
string
It represents a class of vaccine.
orderingprovider
string
The username of the provider who created the order.
outofnetworkreason
string
Out of network reason
patientid
integer
The ID of the patient this order is associated with.
status
string
Current status of the order.
Example Code
Unsubscribe to all/specific events for changes in prescriptions
DELETE
/v1/{practiceid}/prescriptions/changed/subscription
Delete an specific event which is no longer required Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see Permissioned Rollout of APIs for more information if you are experiencing issues.
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 prescription was successful.
Example Code