Update Encounter

PUT {{baseUrl}}/api/v2/Encounter/:encounter-id?patient=<integer>&departmentId=<integer>

Overview:

Updates existing encounter data, empowering developers to modify specific details associated with a particular patient's visit, ensuring accurate and current information for optimized clinical workflows.

This is only supported in ATHENA.

Use Cases:

  • Update Encounter Information: Modify details of an encounter

  • Revise Encounter Notes: Edit and update clinical notes

  • Amend Encounter Diagnoses: Update diagnoses information

  • Modify Encounter Procedures: Make changes to procedures

  • Edit Encounter Details: Adjust specific encounter information

Request Params

KeyDatatypeRequiredDescription
patientstring(Required) The patient identifier associated with the encounter.
departmentIdstring(Required) The department identifier

Request Body

{"context"=>{"requestId"=>"<string>", "source"=>"<string>", "quorum"=>"<boolean>", "notify"=>"<boolean>"}, "data"=>{"resourceType"=>"<string>", "id"=>"<string>", "status"=>"<string>", "type"=>[{"coding"=>[{"system"=>"<string>", "code"=>"<string>", "display"=>"<string>"}, {"system"=>"<string>", "code"=>"<string>", "display"=>"<string>"}]}, {"coding"=>[{"system"=>"<string>", "code"=>"<string>", "display"=>"<string>"}, {"system"=>"<string>", "code"=>"<string>", "display"=>"<string>"}]}], "participant"=>[{"individual"=>{"reference"=>"<string>"}}, {"individual"=>{"reference"=>"<string>"}}], "appointment"=>[{"reference"=>"<string>"}, {"reference"=>"<string>"}], "period"=>{"start"=>"<dateTime>"}, "location"=>[{"location"=>{"reference"=>"<string>", "type"=>"<string>", "display"=>"<string>"}}, {"location"=>{"reference"=>"<string>", "type"=>"<string>", "display"=>"<string>"}}], "contained"=>[{"resourceType"=>"<string>", "telecom"=>[{"system"=>"<string>", "value"=>"<string>", "use"=>"<string>"}, {"system"=>"<string>", "value"=>"<string>", "use"=>"<string>"}], "name"=>[{"given"=>["<string>", "<string>"], "family"=>"<string>", "use"=>"<string>"}, {"given"=>["<string>", "<string>"], "family"=>"<string>", "use"=>"<string>"}]}, {"resourceType"=>"<string>", "telecom"=>[{"system"=>"<string>", "value"=>"<string>", "use"=>"<string>"}, {"system"=>"<string>", "value"=>"<string>", "use"=>"<string>"}], "name"=>[{"given"=>["<string>", "<string>"], "family"=>"<string>", "use"=>"<string>"}, {"given"=>["<string>", "<string>"], "family"=>"<string>", "use"=>"<string>"}]}], "extension"=>[{"url"=>"<string>", "valueString"=>"<string>", "valueInteger"=>"<integer>", "valueDate"=>"<date>", "valueId"=>"<integer>"}, {"url"=>"<string>", "valueString"=>"<string>", "valueInteger"=>"<integer>", "valueDate"=>"<date>", "valueId"=>"<integer>"}]}}

HEADERS

KeyDatatypeRequiredDescription
x-source-idstring(Required) The source id provided for connecting to the data source
Content-Typestring
Authorizationstring

RESPONSES

status: OK

{&quot;context&quot;:{&quot;requestId&quot;:&quot;\u003cstring\u003e&quot;,&quot;source&quot;:&quot;\u003cstring\u003e&quot;,&quot;quorum&quot;:&quot;\u003cboolean\u003e&quot;,&quot;notify&quot;:&quot;\u003cboolean\u003e&quot;},&quot;data&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;}}