Document Type - Admin Document

The Document Type - Admin feature allows users to add, edit, remove or retrieve a list of admin documents for the practice or a patient.

Admin
Miscellaneous administrative documents, may be associated with a patient or not, e.g., registration information, conference invitations, payer notices, etc. These documents are accessible through the chart, but not typically viewed by clinical staff. By default, admin documents are created in an open status. 

Admin – Billing Document: Documents with claim billing information, e.g., invoices, benefit investigation forms. 
Admin – Consent: General patient consent forms, e.g., HIV testing, vaccination, surgical consent forms. 
Admin – HIPAA/Privacy: Practice-generated forms signed by patients acknowledging they were made aware of their patient rights. 
Admin – Insurance Approval Notification: Letters sent from an insurance organization (state or private) indicating that a provider may bill for certain types of medical care, e.g., imaging studies, medications, procedures. 
Admin – Insurance Card: Photocopies of patient insurance cards taken during patient visits. Admin – Insurance Denial Notification: Letters from insurance organizations indicating that a provider may not bill for certain types of medical care, e.g., imaging studies, procedures, medications. 
Admin – Legal: Legal documents, e.g., DNRs, police reports, birth or death certificates. 
Admin – Medical Records Request: Patient-signed forms authorizing the release of their medical records to a third party, e.g., medical practices, legal representatives, Social Security Administration. 
Admin – Referral: All incoming referral orders from an outside provider for consultation or treatment, e.g., appointment scheduling requests, supporting documentation. 
Admin – Signed Forms and Letters: Patient-related forms or letters signed by the provider that require no further action, e.g., school health forms, disability eligibility forms, compassionate "do not shut off service” utility company letters. 

Note: Subclassification is not necessary for this document class. Admin documents are one of the only documents that can be created without a patient ID because some documents may apply to no patients or to >1 patient.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Add admin document without linking to a patient
POST
/v1/{practiceid}/documents/admin

Create and record a admin document not specific to a 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
Content-Type string Content type of the payload

❙ Request Body

Expand all
attachmentcontents string The file contents that will be attached to this document. PDFs are recommended.
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 athenaNet department ID associated with the uploaded document.
documentdata string Text data stored with document
documentdate string The date an observation was made (mm/dd/yyyy).
documentsubclass string Subclasses for ADMIN documents
documenttypeid integer A specific document type identifier.
internalnote string An internal note for the provider or staff. Updating this will append to any previous notes.
originalfilename string The original file name of this document without the file extension. Filename should not exceed 200 characters.
priority string Priority of this result. 1 is high; 2 is normal.
providerid integer The ID of the ordering provider.

Output Parameters

Expand all
adminid integer The document ID of the new or modified document.
errormessage string If the operation failed, this will contain an error message.
success string Returns true/false if the operation was successful.
Example Code
Get list of admin documents not linked to a patient
GET
/v1/{practiceid}/documents/admin

Retrieve list of admin documents

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
showdeleted boolean Allow documents that have been deleted to be returned.
status string Show only documents of this status. CLOSED will also set SHOWCLOSED to true. DELETED will set SHOWDELETED to true.
startdate string The start date in a range (mm/dd/yyyy).
showdocumentswithpatientid boolean Allow documents with patient IDs assigned to be returned.
documentsubclass string The subclass of the documents being processed.
enddate string The end date in a range (mm/dd/yyyy).
providerid integer The ID of the ordering provider.
departmentid integer The athenaNet department ID associated with the uploaded document.
showclosed boolean Allow documents in the CLOSED status to be returned.
limit integer Number of entries to return (default 1000, max 1000)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
adminid integer The primary key for administrative class of documents
appointmentid integer The appointment ID for this document
assignedto string Person the document is assigned to
clinicalproviderid 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.
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
createduser string The user who created this document.
deleteddatetime string Date/time (ISO 8601) the document was deleted
departmentid string Department for the document
description string Description of the document type
documentclass string Class of document
documentdate string Date/time the observation was taken
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
entitytype string Type of entity creating the document. Possible values are PROVIDER, PATIENT and OTHERS.
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.
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
lastmodifieddate string Date/time (ISO 8601) the document was last modified
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
originalfilename string The original file name of this document.
patientid integer The athenaNet patient ID.
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
providerusername string The username of the provider associated with this lab result document.
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 admin document without specifying patient ID
GET
/v1/{practiceid}/documents/admin/{adminid}

Retrieve an admin document specific to the admin ID

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
adminid integer adminid

Output Parameters

Expand all
actionnote string The most recent action note for a document
adminid integer The primary key for administrative class of documents
appointmentid integer The appointment ID for this document
assignedto string Person the document is assigned to
clinicalproviderid 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.
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
createduser string The user who created this document.
deleteddatetime string Date/time (ISO 8601) the document was deleted
departmentid string Department for the document
description string Description of the document type
documentclass string Class of document
documentdata string Text data associated with this document.
documentdate string Date/time the observation was taken
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
entitytype string Type of entity creating the document. Possible values are PROVIDER, PATIENT and OTHERS.
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.
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
lastmodifieddate string Date/time (ISO 8601) the document was last modified
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
lastmodifieduser string The user who last modified this document.
originaldocument object URL and content-type to download the original document
pages array An array of image pages associated with this document.
patientid integer The athenaNet patient ID.
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
providerusername string The username of the provider associated with this lab result document.
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
Update admin document without specifying patient ID
PUT
/v1/{practiceid}/documents/admin/{adminid}

Modify an admin document specific to the admin ID

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

❙ Request Body

Expand all
adminid integer The document ID of the edited document.
documentdate string The date an observation was made (mm/dd/yyyy).
documenttypeid integer A specific document type identifier.
internalnote string An internal note for the provider or staff. Updating this will append to any previous notes.
priority string Priority of this result. 1 is high; 2 is normal.
providerid integer The ID of the ordering provider.

Output Parameters

Expand all
adminid integer The document ID of the new or modified document.
errormessage string If the operation failed, this will contain an error message.
success string Returns true/false if the operation was successful.
Example Code
Get admin document's action notes
GET
/v1/{practiceid}/documents/admin/{adminid}/actions

Retrieve a list of all action notes on a specific admin 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
adminid integer adminid
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
actionnote string The action notes that are attached to the document.
assignedto string This field will describe who was assigned this document during this document action.
createdby string The username of the person that created this document action.
createddatetime string The datetime this action note was created.
patientid integer The patient ID this document is tied to.
priority integer Priority given for this document action.
status string Status given for this document action.
Example Code
Add admin document action note
POST
/v1/{practiceid}/documents/admin/{adminid}/actions

Create a record of an action note on a specific admin 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
adminid integer adminid
Content-Type string Content type of the payload

❙ Request Body

Expand all
actionnote string The new action note to add to the document.

Output Parameters

Expand all
errormessage string If there was an error with this call and SUCCESS is set to false, this field may provide additional information.
newdocumentid string The document ID of newly created document as a result of action of Deny-New Prescription To Follow (DNTF).
success string Returns true if the update was a success.
versiontoken string A token representing the current state of this document. Will only be set if VERSIONTOKEN was originally sent to the endpoint.
Example Code
Get page from admin document
GET
/v1/{practiceid}/documents/admin/{adminid}/pages/{pageid}

Retrieves a single page from a admin document that does not have a patientid

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
pageid integer pageid
adminid integer adminid
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
Add admin document to patient's chart
POST
/v1/{practiceid}/patients/{patientid}/documents/admin

Create a record of admin document specific to a 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
Content-Type string Content type of the payload

❙ Request Body

Expand all
attachmentcontents string The file contents that will be attached to this document. PDFs are recommended.
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 athenaNet department ID associated with the uploaded document.
documentdata string Text data stored with document
documentdate string The date an observation was made (mm/dd/yyyy).
documentsubclass string Subclasses for ADMIN documents
documenttypeid integer A specific document type identifier.
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 An internal note for the provider or staff. Updating this will append to any previous notes.
originalfilename string The original file name of this document without the file extension. Filename should not exceed 200 characters.
priority string Priority of this result. 1 is high; 2 is normal.
providerid integer The ID of the ordering provider.

Output Parameters

Expand all
adminid integer The document ID of the new or modified document.
errormessage string If the operation failed, this will contain an error message.
success string Returns true/false if the operation was successful.
Example Code
Get list of patient's admin documents
GET
/v1/{practiceid}/patients/{patientid}/documents/admin

Retrieve a list of patient's admin documents

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.
departmentid integer The athenaNet department id.
getentityinfo boolean If true, entityid and entitytype will be returned. entityid will be populated in createduser attribute.
showmetadata boolean When "true" is passed we will return filetype, filesize and originalfilename if applicable
encounterid integer Show only documents attached to this encounter.
documentsubclass string The document subclass to filter document results.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
adminid integer The primary key for administrative class of documents
appointmentid integer The appointment ID for this document
assignedto string Person the document is assigned to
clinicalproviderid 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.
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
createduser string The user who created this document.
deleteddatetime string Date/time (ISO 8601) the document was deleted
departmentid string Department for the document
description string Description of the document type
documentclass string Class of document
documentdate string Date/time the observation was taken
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
entitytype string Type of entity creating the document. Possible values are PROVIDER, PATIENT and OTHERS.
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.
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
lastmodifieddate string Date/time (ISO 8601) the document was last modified
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
originalfilename string The original file name of this 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
providerusername string The username of the provider associated with this lab result document.
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 patient's admin document
GET
/v1/{practiceid}/patients/{patientid}/documents/admin/{adminid}

Retrieves the data from a specific admin document of a 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
adminid integer adminid
patientid integer patientid
getentityinfo boolean If true, entityid and entitytype will be returned. entityid will be populated in createduser attribute.

Output Parameters

Expand all
actionnote string The most recent action note for a document
adminid integer The primary key for administrative class of documents
appointmentid integer The appointment ID for this document
assignedto string Person the document is assigned to
clinicalproviderid 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.
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
createduser string The user who created this document.
deleteddatetime string Date/time (ISO 8601) the document was deleted
departmentid string Department for the document
description string Description of the document type
documentclass string Class of document
documentdata string Text data associated with this document.
documentdate string Date/time the observation was taken
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
entitytype string Type of entity creating the document. Possible values are PROVIDER, PATIENT and OTHERS.
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.
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
lastmodifieddate string Date/time (ISO 8601) the document was last modified
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
lastmodifieduser string The user who last modified this document.
originaldocument object URL and content-type to download the original document
pages array An array of image pages associated with this 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
providerusername string The username of the provider associated with this lab result document.
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
Update patient's admin document
PUT
/v1/{practiceid}/patients/{patientid}/documents/admin/{adminid}

Modifies the data of a specific admin document of a 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
adminid integer adminid
patientid integer patientid
Content-Type string Content type of the payload

❙ Request Body

Expand all
adminid integer The document ID of the edited document.
documentdate string The date an observation was made (mm/dd/yyyy).
documenttypeid integer A specific document type identifier.
internalnote string An internal note for the provider or staff. Updating this will append to any previous notes.
priority string Priority of this result. 1 is high; 2 is normal.
providerid integer The ID of the ordering provider.

Output Parameters

Expand all
adminid integer The document ID of the new or modified document.
errormessage string If the operation failed, this will contain an error message.
success string Returns true/false if the operation was successful.
Example Code
Mark patient's admin document as deleted
DELETE
/v1/{practiceid}/patients/{patientid}/documents/admin/{adminid}

Deletes the specific admin document of a 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
adminid integer adminid
patientid integer patientid

Output Parameters

Expand all
adminid integer The document ID of the new or modified document.
errormessage string If the operation failed, this will contain an error message.
success string Returns true/false if the operation was successful.
Example Code
Get page from patient's admin document
GET
/v1/{practiceid}/patients/{patientid}/documents/admin/{adminid}/pages/{pageid}

Retrieves a single page from a specific admin document of a 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
pageid integer pageid
adminid integer adminid
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 patient's original admin document
GET
/v1/{practiceid}/patients/{patientid}/documents/admin/{adminid}/originaldocument

Retrieves original admin 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
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
adminid integer adminid
patientid integer patientid

Output Parameters

Expand all
attachment string The original document in uploaded format.
Example Code