Document

Document feature allows the user to add or view the documents for a specific patient, and retrieves types of documents 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

Endpoints

Get possible assignment usernames for document
GET
/v1/{practiceid}/documentassignment/{documentid}

Retrieves the usernames that can be assigned any single document

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
documentid integer documentid
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
availableforassignment array List of usernames available to assign this document
currentassignment string Person the document is assigned to
documentstatus string Status of the document
Example Code
Get list of document types
GET
/v1/{practiceid}/documenttypes

Retrieves a list of document types based on the documentsubclass filter.

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 The search string as a list of search words.
documentsubclass string Limit the results to document types that could apply to a document of the type specified. If omitted, the results will not be filtered.
limit integer Number of entries to return (default 100, max 500)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
documenttypeid integer The ID for this document type.
name string A long form description of this document type.
Example Code
Add document to patient's chart
POST
/v1/{practiceid}/patients/{patientid}/documents

Create a document in patient's chart based on the document subclass

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

❙ Request Body

Expand all
actionnote string Any note to accompany the creation of this document.
appointmentid integer The appointment ID associated with this document, for certain document classes. These can only be uploaded AFTER check-in. The department ID is looked up from the appointment. (Department ID takes precedence if both are supplied.)
attachmentcontents string The file that will become the document. PDFs are recommended. Generally, this implies that this is a multipart/form-data content-type submission. This does NOT work correctly in I/O Docs. The filename itself is not used by athenaNet, but it is required to be sent.
attachmenttype string The file type of the attachment.
autoclose boolean Documents will, normally, automatically appear in the clinical inbox for providers to review. In some cases, you might want to force the document to skip the clinical inbox, and go directly to the patient chart with a "closed" status. For that case, set this to true.
departmentid integer The department ID associated with the uploaded document. Except when appointmentid is supplied, this is required.
documentsubclass string The document subclass.
entityid string Identifier of entity creating the document. entitytype is required while passing entityid.
entitytype string Type of entity creating the document. entityid is required while passing entitytype.
internalnote string The 'Internal Note' attached to this document
originalfilename string The original file name of this document without the file extension. Filename should not exceed 200 characters.
providerid integer The provider ID attached to this document. This populates the provider name field.

Output Parameters

Expand all
documentid string The document ID of the created document.
Example Code
Get list of patient's documents
GET
/v1/{practiceid}/patients/{patientid}/documents

Retrieve a list of documents 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
Try in Postman

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.
getentityinfo boolean If true, entityid and entitytype will be returned. entityid will be populated in createduser attribute.
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.
departmentid integer The athenaNet department id.
showmetadata boolean When "true" is passed we will return filetype, filesize and originalfilename if applicable
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
acogid number The primary key for acog class of documents. This is in place of a documentid.
adminid number The primary key for admin class of documents. This is in place of a documentid.
advertisementid number The primary key for advertisement class of documents. This is in place of a documentid.
appointmentid number The appointment ID for this document,
appointmentrequestid number The primary key for appointmentrequest class of documents. This is in place of a documentid.
assignedto string Person the document is assigned to
chartabstractionid number The primary key for chartabstraction class of documents. This is in place of a documentid.
clinicaldocumentid number The primary key for clinicaldocument class of documents. This is in place of a documentid.
clinicalproviderid number The clinical provider ID of the performing provider
contraindicationreason array List of codes indicating why the order was contraindicated (for vaccines only). If this field is not present, the order does not contain a contraindication reason.
coordinatortaskid number The primary key for coordinatortask class of documents. This is in place of a documentid.
correctivelensid number The primary key for correctivelens class of documents. This is in place of a documentid.
coversheetid number The primary key for coversheet class of documents. This is in place of a documentid.
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
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
dmeid number The primary key for dme class of documents. This is in place of a documentid.
documentclass string Class of document
documentdescription string Description of the document type
documentid string ID for the document. Note that in documents/{documentclass} calls, this will become an ID named after the document class (e.g. rtoid or letterid).
documentroute string Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource string Explains where this document originated (e.g. ENCOUNTER, PORTAL, etc.)
documentsubclass string Specific type of document
documenttype string The description for this document
documenttypeid number The ID of the description for this document
electronicreferralid number The primary key for electronicreferral class of documents. This is in place of a documentid.
encounterdocumentid number The primary key for encounterdocument class of documents. This is in place of a documentid.
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
fileextension string The file extension of this document.
filesize number The file size of this document.
hospitalid number The primary key for hospital class of documents. This is in place of a documentid.
htmlid number The primary key for html class of documents. This is in place of a documentid.
imagingresultid number The primary key for imagingresult class of documents. This is in place of a documentid.
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
interpretationid number The primary key for interpretation class of documents. This is in place of a documentid.
labresultid number The primary key for labresult class of documents. This is in place of a documentid.
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
letterid number The primary key for letter class of documents. This is in place of a documentid.
medicalrecordid number The primary key for medicalrecord class of documents. This is in place of a documentid.
mednotificationid number The primary key for mednotification class of documents. This is in place of a documentid.
observationdatetime string Date/time (ISO 8601) the observation was taken
officenoteid number The primary key for officenote class of documents. This is in place of a documentid.
orderid number The primary key for order class of documents. This is in place of a documentid.
originalfilename string The original file name of this document.
patientcaseid number The primary key for patientcase class of documents. This is in place of a documentid.
patientinfoid number The primary key for patientinfo class of documents. This is in place of a documentid.
patientrecordid number The primary key for patientrecord class of documents. This is in place of a documentid.
phonemessageid number The primary key for phonemessage class of documents. This is in place of a documentid.
physicianauthid number The primary key for physicianauth class of documents. This is in place of a documentid.
prescriptionid number The primary key for prescription class of documents. This is in place of a documentid.
priority number Document priority, when available.
providerid number Provider ID for this document
receivernote string External note sent to the receiving facility
requisitionid number The primary key for requisition class of documents. This is in place of a documentid.
rtoid number The primary key for rto class of documents. This is in place of a documentid.
shareableid number The primary key for shareable class of documents. This is in place of a documentid.
status string Status of the document
subject string Subject of the document
surgeryid number The primary key for surgery class of documents. This is in place of a documentid.
surgicalresultid number The primary key for surgicalresult class of documents. This is in place of a documentid.
tietoorderid number Order ID of the order this document is tied to, if any
unknownid number The primary key for unknown class of documents. This is in place of a documentid.
vaccineid number The primary key for vaccine class of documents. This is in place of a documentid.
Example Code
Get XML from document
GET
/v1/{practiceid}/patients/{patientid}/documents/clinicaldocument/{documentid}/xml

Retrieves certain types of clinical documents which contain XML ( e.g. CCDA)

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
documentid integer documentid
patientid integer patientid

Output Parameters

Expand all
xml string The JSON-encoded XML for this document, if present.
Example Code