Document Type - Letter

Document Type - Letter are patient-related forms or letters that have already been signed by the provider and require no further action, for example, school health forms, disability eligibility forms, compassionate "do not shut off service" utility company letters, etc. This feature allows the user to retrieve, add or modify information of a specific patient or a specific Letter 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

Endpoints

Get list of patient's letter documents

GET
/v1/{practiceid}/patients/{patientid}/documents/letter
Retrieves a list of letter document of 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.
departmentid integer The athenaNet department id.
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
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
createfromorderid integer Id of the order document which created this document
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.
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
letterid integer The ID for this letter document.
observationdate string
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
recipientname string Name of the recipient of this document
status string Status of the document
subject string Subject of the document
Example Code

Get patient's letter document

GET
/v1/{practiceid}/patients/{patientid}/documents/letter/{letterid}
Retrieves a specific letter document information
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
letterid integer letterid
patientid integer patientid
excludexml boolean If true, do not return the xml content of this document
getentityinfo boolean If true, entityid and entitytype will be returned. entityid will be populated in createduser attribute.
excludehtml boolean If true, do not return the html content of this document

Output Parameters

Expand all
actionnote string The most recent action note for a document
appointmentid integer The appointment ID for this document
approveddate string The date this document was approved
approveduser string The username of the person who approved this document
assignedto string Person the document is assigned to
attachmentslink string Link to an endpoint that can be used to retrieve the clinical letter attachments
callbacknumber string The phone number to use to call back the patient.
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.
createfromorderid integer Id of the order document which created this document
deleteddatetime string Date/time (ISO 8601) the document was deleted
departmentid string Department for the document
description string DEPRECATED - This field is now deprecated. Use documentdescription.
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
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.
html string The contents of this document in html format
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 DEPRECATED: The last modified date. The information can now be found in the field entitled lastmodifieddatetime
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
lastmodifieduser string The user who last modified this document.
letterid integer The ID for this letter document.
lettertext string Text of this letter. May contain html
observationdatetime string Date/time the observation was taken
pages array An array of image pages associated with this document.
paperformname string Name of the paper form used to generate 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.
recipientname string Name of the recipient of this document
status string Status of the document
subject string Subject of the document
xml string If there is XML with this letter, the raw XML.
xmltitle string If there is XML with this letter, the title associated with the XML
xmltype string If there is XML with this letter, the type. For example, CCDAs are associated with patient care summaries.
Example Code

Get page from patient's letter document

GET
/v1/{practiceid}/patients/{patientid}/documents/letter/{letterid}/pages/{pageid}
Retrieves a specific page from the specific letter 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
pageid integer pageid
letterid integer letterid
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 letter document's action note

GET
/v1/{practiceid}/documents/letter/{letterid}/actions
Retrieves action note information of a specific letter 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
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
letterid integer letterid
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 letter document action note

POST
/v1/{practiceid}/documents/letter/{letterid}/actions
Creates an action note for a specific letter 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
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
letterid integer letterid
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