Encounter

An Encounter is created when a patient has an office visit or if a patient is prescribed a medical order, even if the patient is not present in the doctor's office. This feature allows the user to view or modify encounter specific data.

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 encounters

GET
/v1/{practiceid}/chart/{patientid}/encounters
Retrieves a list of patient encounters
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
startdate string Omit any encounters earlier than this date
showallstatuses boolean By default only encounters in OPEN, CLOSED, or REVIEW status are retrieved, with this flag, encounters aren't filtered by status.
showalltypes boolean Retrieve all encounter types, by default only VISIT and ORDERSONLY are retrieved.
appointmentid integer Find the encounter for this appointment.
enddate string Omit any encounters later than this date
showdiagnoses boolean Query diagnosis information for every encounter
providerid integer The ID of the provider for this encounter
departmentid integer The athenaNet department id.
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
appointmentid integer Athena appointment ID resulting in this encounter
closeddate string date when this encounter was closed
closeduser string Username of the provider who closed this encounter
departmentid integer The athena department ID of this encounter
diagnoses array List of diagnoses for this encounter
encounterdate string Date when this encounter occured
encounterid integer Athena ID for this encounter
encountertype string Type of encounter (FLOWSHEET, ORDERSONLY, VISIT, etc.). By default only VISIT and ORDERSONLY are shown, use INCLUDEALLtypeS flag to see others.
encountervisitname string The visit name for this encounter
lastreopened string The date the encounter was last reopened. The field will not be present if the encounter has not be closed.
lastupdated string The date the encounter was last updated
patientlocation string Patient location
patientlocationid integer Athena ID for the patient location
patientstatus string Patient status
patientstatusid integer Athena ID for the patient status
providerfirstname string First name of the provider for this encounter
providerid integer The ID of the provider for this encounter
providerlastname string Last name of the provider for this encounter
providerphone string Phone number of the provider for this encounter
stage string Last stage of the encounter
status string Status of this encounter (CLOSED, OPEN, PEND). By default only OPEN, CLOSED, and REVIEW statuses are shown, use INCLUDEALLSTATUSES flag to see others.
Example Code

Get appointment-specific encounter summary content

GET
/v1/{practiceid}/chart/{patientid}/encounters/{appointmentid}/summary
Retrieves appointment specific encounter summary. Note: It is an HTML Summary for an encounter wrapped in JSON.
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
appointmentid integer appointmentid
mobile boolean Flag to skip many details to make the html smaller
skipamendments boolean Flag to skip encounter amendments

Output Parameters

Expand all
summaryhtml string The summary HTML wrapped in JSON. Use Accept header of text/html or application/pdf to get a non-JSON encoded version.
Example Code

Get encounter information

GET
/v1/{practiceid}/chart/encounter/{encounterid}
Retrieves information of a specific encounter
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
encounterid integer encounterid

Output Parameters

Expand all
appointmentid integer Athena appointment ID resulting in this encounter
closeddate string date when this encounter was closed
closeduser string Username of the provider who closed this encounter
departmentid integer The athena department ID of this encounter
diagnoses array List of diagnoses for this encounter
encounterdate string Date when this encounter occured
encounterid integer Athena ID for this encounter
encountertype string Type of encounter (FLOWSHEET, ORDERSONLY, VISIT, etc.). By default only VISIT and ORDERSONLY are shown, use INCLUDEALLtypeS flag to see others.
encountervisitname string The visit name for this encounter
lastreopened string The date the encounter was last reopened. The field will not be present if the encounter has not be closed.
lastupdated string The date the encounter was last updated
patientlocation string Patient location
patientlocationid integer Athena ID for the patient location
patientstatus string Patient status
patientstatusid integer Athena ID for the patient status
providerfirstname string First name of the provider for this encounter
providerid integer The ID of the provider for this encounter
providerlastname string Last name of the provider for this encounter
providerphone string Phone number of the provider for this encounter
stage string Last stage of the encounter
status string Status of this encounter (CLOSED, OPEN, PEND). By default only OPEN, CLOSED, and REVIEW statuses are shown, use INCLUDEALLSTATUSES flag to see others.
Example Code

Get encounter-specific encounter summary content

GET
/v1/{practiceid}/chart/encounters/{encounterid}/summary
Retrieves information about an appointment specific encounter along with diagnoses data.
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
encounterid integer encounterid
mobile boolean Flag to skip many details to make the html smaller
skipamendments boolean Flag to skip encounter amendments

Output Parameters

Expand all
summaryhtml string The summary HTML wrapped in JSON. Use Accept header of text/html or application/pdf to get a non-JSON encoded version.
Example Code