Create Appointment

POST {{baseUrl}}/api/v2/Appointment

Overview:

A targeted request for programmatically scheduling patient visits by flexibly specifying provider, location, services, verification requirements and visit timing attributes to drive automated workflows for appointment slot coordination behind patient scheduling interfaces.

Use Cases:

• Self-Service Scheduling Portals: Enable patient self-scheduling

• Referral Management Systems: Post follow-up specialist appointments

• Queue Management Processes: Develop dynamic scheduling from queues

• Patient Monitoring Systems: Schedule risk-based follow-ups

• Workflow Integration Layers: Wrap posting for integration

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"}}]