Document Type - Encounter Document
Document Type - Encounter Document. The encounter document is a feature which allows the user to retrieve, modify or add encounter document details. There are 4 types of Encounter documents - procedure, imaging, progress note and health history questionnaire. These documentation is are captured only during the encounter visit.
Encounter Document
By default, encounter documents are created in a closed status, as the documents are considered documentation in support of a practice’s own encounter. For example, data the practice has already viewed in some other way but needs to be added to the patient’s chart for record keeping. A document subclass is required for this document class.
Encounter Document – Health History Questionnaire: Validated assessment forms completed by the family at home, school, or in a medical office or questionnaires given during the patient’s visit, e.g., lead or TB risk assessments forms.
Encounter Document – Image Documentation: Photos taken during procedures performed as part of an ambulatory encounter, not prior or after.
Encounter Document – Procedure Documentation: Documentation of procedures done during office visits, not previously scheduled separate surgeries.
Encounter Document – Progress Note: Detailed descriptions of a patient’s office visit taken on paper and faxed or scanned into 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
-
Primary
Get encounter document's action
note
GET
/v1/{practiceid}/documents/encounterdocument/{encounterdocumentid}/actions
Retrieves action note information of a specific encounter 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
encounterdocumentid
integer
encounterdocumentid
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 encounter document action
note
POST
/v1/{practiceid}/documents/encounterdocument/{encounterdocumentid}/actions
Creates an action note for a specific encounter 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
encounterdocumentid
integer
encounterdocumentid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput 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 list of patient's encounter
documents
GET
/v1/{practiceid}/patients/{patientid}/documents/encounterdocument
Retrieves a list of encounters document information 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
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
number
The appointment ID for this document,
assignedto
string
Person the document is assigned to
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.
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
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 (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
encounterdocumentid
number
The primary key for encounterdocument class of documents
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
observationdatetime
string
Date/time (ISO 8601) the observation was taken
priority
number
Document priority, when available.
providerid
number
Provider ID for this document
receivernote
string
External note sent to the receiving facility
status
string
Status of the document
subject
string
Subject of the document
tietoorderid
number
Order ID of the order this document is tied to, if any
Example Code
Add encounter document to patient's
chart
POST
/v1/{practiceid}/patients/{patientid}/documents/encounterdocument
Creates a document record 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
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
encounterdocumentid
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 patient's encounter
document
GET
/v1/{practiceid}/patients/{patientid}/documents/encounterdocument/{encounterdocumentid}
Retrieves a specific encounter document information
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
encounterdocumentid
integer
encounterdocumentid
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
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.
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
documentdata
string
Text data associated with this document.
documentsource
string
Explains where this document originated.
documentsubclass
string
Specific type of document
encounterdate
string
Date of the encounter associated with this document
encounterdocumentid
integer
The primary key for encounter document class of documents
encounterid
string
Encounter ID
entitytype
string
Type of entity creating the document. Possible values are PROVIDER, PATIENT and OTHERS.
internalnote
string
The 'Internal Note' attached to this document
lastmodifieddate
string
Date/time (ISO 8601) the document was last modified
lastmodifieduser
string
The user who last modified this 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
Example Code
Update patient's encounter
document
PUT
/v1/{practiceid}/patients/{patientid}/documents/encounterdocument/{encounterdocumentid}
Modifies a specific encounter document information
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
encounterdocumentid
integer
encounterdocumentid
patientid
integer
patientid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
encounterdocumentid
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 encounter document as
deleted
DELETE
/v1/{practiceid}/patients/{patientid}/documents/encounterdocument/{encounterdocumentid}
Deletes the record of a specified encounter 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
encounterdocumentid
integer
encounterdocumentid
patientid
integer
patientid
Output Parameters
Expand all
encounterdocumentid
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 encounter
document
GET
/v1/{practiceid}/patients/{patientid}/documents/encounterdocument/{encounterdocumentid}/pages/{pageid}
Retrieves a specific page from the specific encounter 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
encounterdocumentid
integer
encounterdocumentid
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