Encounter

The Encounter feature allows the user to view encounter details and modify the patient location and their statuses.

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

Endpoints

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

Update patient location/status encounter information

PUT
/v1/{practiceid}/chart/encounter/{encounterid}
Modifies the patient location and patient status for 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
Content-Type string Content type of the payload

❙ Request Body

Expand all
patientlocationid integer The practice patient location id. You can get a list of valid values by department via GET /chart/configuration/patientlocations.
patientstatusid integer The practice patient status id. You can get a list of valid values by department via GET /chart/configuration/patientstatuses.

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code