Encounter Reasons
The Encounter Reason feature allows the user to view the present illness of the patient during the encounter visit. These include the list of encounter reasons for this encounter and the associated freetext note. These also correspond to the reasons checked off in the 'Encounter Reasons / Chief Complaint' section of the encounter.
Encounter reasons are limited to a set that is configured on an admin page. The Encounter Reason Configuration feature allows the user to get the list of possible encounter reasons with this endpoint. You will need the encounterreasonid to add an encounter reason using POST /chart/encounter/{encounterid}/encounterreasons.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
- Reference
Get list of reasons for given encounter
GET
/v1/{practiceid}/chart/encounter/{encounterid}/encounterreasons
Retrieves the list of reasons or present illness documented during the specific encounter visit
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
encounterid
integer
encounterid
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
encounterreasonnote
string
The reason for visit note associated with the encounter.
encounterreasons
array
The text and ID of the encounter reason
notelastmodifieddatetime
string
Date and time when encounter reason note was last modified.
notelastmodifieduser
string
Username of the user who last modified encounter reason note.
Example Code
Delete an reason from the given encounter
DELETE
/v1/{practiceid}/chart/encounter/{encounterid}/encounterreasons
Deletes an encounter reason from the encounter instance
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
encounterid
integer
encounterid
encounterreasonid
integer
Encounter reason ID. Must be from the list returned by /configuration/encounterreason
Output Parameters
Expand all
encounterreasonid
integer
The ID of the encounter reason
errormessage
string
If not successful, will contain an error message.
success
string
Whether the operation succeeded.
Example Code
Add an reason to the given encounter
POST
/v1/{practiceid}/chart/encounter/{encounterid}/encounterreasons
Adds or updates an encounter reason in the specific encounter instance
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
encounterid
integer
encounterid
Content-Type
string
Content type of the payload
Output Parameters
Expand all
encounterreasonid
integer
The ID of the encounter reason
errormessage
string
If not successful, will contain an error message.
success
string
Whether the operation succeeded.
Example Code
Set the freetext reason note for the encounter
POST
/v1/{practiceid}/chart/encounter/{encounterid}/encounterreasonnote
Sets the freetext encounter reason note for the specific encounter.
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
encounterid
integer
encounterid
Content-Type
string
Content type of the payload
Output Parameters
Expand all
errormessage
string
If not successful, will contain an error message.
note
string
The complete note that was saved.
success
string
Whether the operation succeeded.
Example Code
Get the list of configured encounter reasons
GET
/v1/{practiceid}/configuration/encounterreasons
Encounter Reason
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
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
encounterreasonid
integer
The ID of the encounter reason
lateralityflag
string
One of "Y" or "N": whether the reason has laterality
name
string
The display name of the encounter reason
Example Code