Qodex.ai

Get Appointment by ID

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

Overview:

A focused request for retrieving the details of a specific appointment ID - including patient, provider, timing, and services - to enable precise access to visit information for downstream workflows like care coordination, revenue cycle management, and patient encounter facilitation.

Use Cases:

  • Patient Check-In Kiosks: Prefill intake forms

  • Telehealth Virtual Visits: Load appropriate assessments

  • Referral Order Workflows: Check if orders align

  • Care Team Workflows: Assign pre-visit protocols

HEADERS

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

RESPONSES

status: OK

[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","participant":[{"actor":{"reference":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}},{"actor":{"reference":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}}],"minutesDuration":"\u003cinteger\u003e","start":"\u003cdateTime\u003e","appointmentType":{"coding":[{"display":"\u003cstring\u003e","code":"\u003cstring\u003e"},{"display":"\u003cstring\u003e","code":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"},"status":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueCoding":{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},"valueAnnotation":[{"text":"\u003cstring\u003e","id":"\u003cstring\u003e","author":{"authorString":"\u003cstring\u003e"},"time":"\u003cdateTime\u003e"},{"text":"\u003cstring\u003e","id":"\u003cstring\u003e","author":{"authorString":"\u003cstring\u003e"},"time":"\u003cdateTime\u003e"}]},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueCoding":{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},"valueAnnotation":[{"text":"\u003cstring\u003e","id":"\u003cstring\u003e","author":{"authorString":"\u003cstring\u003e"},"time":"\u003cdateTime\u003e"},{"text":"\u003cstring\u003e","id":"\u003cstring\u003e","author":{"authorString":"\u003cstring\u003e"},"time":"\u003cdateTime\u003e"}]}],"supportingInformation":[{"reference":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e"}]}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","participant":[{"actor":{"reference":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}},{"actor":{"reference":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}}],"minutesDuration":"\u003cinteger\u003e","start":"\u003cdateTime\u003e","appointmentType":{"coding":[{"display":"\u003cstring\u003e","code":"\u003cstring\u003e"},{"display":"\u003cstring\u003e","code":"\u003cstring\u003e"}],"text":"\u003cstring\u003e"},"status":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueCoding":{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},"valueAnnotation":[{"text":"\u003cstring\u003e","id":"\u003cstring\u003e","author":{"authorString":"\u003cstring\u003e"},"time":"\u003cdateTime\u003e"},{"text":"\u003cstring\u003e","id":"\u003cstring\u003e","author":{"authorString":"\u003cstring\u003e"},"time":"\u003cdateTime\u003e"}]},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueCoding":{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},"valueAnnotation":[{"text":"\u003cstring\u003e","id":"\u003cstring\u003e","author":{"authorString":"\u003cstring\u003e"},"time":"\u003cdateTime\u003e"},{"text":"\u003cstring\u003e","id":"\u003cstring\u003e","author":{"authorString":"\u003cstring\u003e"},"time":"\u003cdateTime\u003e"}]}],"supportingInformation":[{"reference":"\u003cstring\u003e"},{"reference":"\u003cstring\u003e"}]}}]