Update Appointment

PUT {{baseUrl}}/api/v2/Appointment/:appointment-id

Overview:

A targeted request to update or amend the details of a specific appointment ID - enabling programmatic management of visit attributes like services, providers, patients, timing, and locations to drive integrated downstream workflows dependent on appointment state.

Use Cases:

• Wait Time Updates: Update duration and wait times

• Staff Rescheduling Algorithms: Reroute if providers unavailable

• Patient Visit Updates: Amend location or service needs

• Telehealth Conversions: Pivot in-person to virtual

• Referral Workflow Amends: Sync between systems

Request Body

{"context"=>{"requestId"=>"<string>", "source"=>"<string>", "quorum"=>"<boolean>", "notify"=>"<boolean>"}, "data"=>{"resourceType"=>"<string>", "id"=>"<string>", "participant"=>[{"actor"=>{"reference"=>"<string>", "extension"=>[{"url"=>"<string>", "valueString"=>"<string>"}, {"url"=>"<string>", "valueString"=>"<string>"}]}}, {"actor"=>{"reference"=>"<string>", "extension"=>[{"url"=>"<string>", "valueString"=>"<string>"}, {"url"=>"<string>", "valueString"=>"<string>"}]}}], "minutesDuration"=>"<integer>", "start"=>"<dateTime>", "appointmentType"=>{"coding"=>[{"display"=>"<string>", "code"=>"<string>"}, {"display"=>"<string>", "code"=>"<string>"}], "text"=>"<string>"}, "status"=>"<string>", "extension"=>[{"url"=>"<string>", "valueString"=>"<string>", "valueCoding"=>{"system"=>"<string>", "code"=>"<string>", "display"=>"<string>"}, "valueAnnotation"=>[{"text"=>"<string>", "id"=>"<string>", "author"=>{"authorString"=>"<string>"}, "time"=>"<dateTime>"}, {"text"=>"<string>", "id"=>"<string>", "author"=>{"authorString"=>"<string>"}, "time"=>"<dateTime>"}]}, {"url"=>"<string>", "valueString"=>"<string>", "valueCoding"=>{"system"=>"<string>", "code"=>"<string>", "display"=>"<string>"}, "valueAnnotation"=>[{"text"=>"<string>", "id"=>"<string>", "author"=>{"authorString"=>"<string>"}, "time"=>"<dateTime>"}, {"text"=>"<string>", "id"=>"<string>", "author"=>{"authorString"=>"<string>"}, "time"=>"<dateTime>"}]}], "supportingInformation"=>[{"reference"=>"<string>"}, {"reference"=>"<string>"}]}}

HEADERS

RESPONSES

status: OK

[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"id":"\u003cinteger\u003e","status":"\u003cstring\u003e"}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"id":"\u003cinteger\u003e","status":"\u003cstring\u003e"}}]