Get a list of Appointments
GET {{baseUrl}}/api/v2/Appointment?_id=<string>&date=<date>&scheduled-start-date=<dateTime>&ignore-restrictions=<boolean>&appointment-type-id=<string>&end-last-modified=<dateTime>&status=<string>&start-last-modified=<dateTime>&patient=<string>&scheduled-end-date=<dateTime>&count=<integer>&_offset=<integer>&end-date=<date>&start-date=<date>&sort-order=<string>&include=<string>&include=<string>&departmentId=<integer>&practitioner=<string>
Overview:
A streamlined request for surfacing patient visit scheduling details including provider, location, timing, and telehealth workflow triggers for driving tailored frontend experiences and nuanced operational optimization in the healthcare setting.
Use Cases:
Patient Reminder Apps: Build patient reminder apps
Provider Schedule Optimization: Identify visit duration overruns
Telehealth Workflow Launch: Initiate telehealth protocols
Referral Management: Check post-referral for conflicts
Resource Planning: Aggregate for planning
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
_id | string | Unique identifier for the resource. | |
date | string | Date of the appointment in YYYY-MM-DD format. | |
scheduled-start-date | string | Scheduled start date and time of the appointment in ISO 8601 format. | |
ignore-restrictions | string | Flag to ignore restrictions when retrieving data. | |
appointment-type-id | string | Identifier for the type of appointment. | |
end-last-modified | string | The end of the period during which the resource was last modified, in ISO 8601 format. | |
status | string | The status of the appointment. | |
start-last-modified | string | The start of the period during which the resource was last modified, in ISO 8601 format. | |
patient | string | (Required) Identifier for the patient associated with the appointment. | |
scheduled-end-date | string | Scheduled end date and time of the appointment in ISO 8601 format. | |
count | string | Number of records to retrieve. | |
_offset | string | Offset for pagination. | |
end-date | string | The end date for the period in which appointments are scheduled. | |
start-date | string | The start date for the period in which appointments are scheduled. | |
sort-order | string | Sort order for the results, either ascending or descending. | |
include | string | List of additional elements to include in the response. | |
include | string | List of additional elements to include in the response. | |
departmentId | string | (Required) The department identifier | |
practitioner | string | (Required) Identifier of the practitioner |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-source-id | string | (Required) The source id provided for connecting to the data source | |
Authorization | string |
RESPONSES
status: OK
[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","type":"\u003cstring\u003e","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","participant":[{"actor":{"reference":"\u003cstring\u003e"}},{"actor":{"reference":"\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":{},"valueCoding":{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}},{"url":"\u003cstring\u003e","valueString":{},"valueCoding":{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]}},{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","participant":[{"actor":{"reference":"\u003cstring\u003e"}},{"actor":{"reference":"\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":{},"valueCoding":{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}},{"url":"\u003cstring\u003e","valueString":{},"valueCoding":{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]}}]}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","type":"\u003cstring\u003e","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","participant":[{"actor":{"reference":"\u003cstring\u003e"}},{"actor":{"reference":"\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":{},"valueCoding":{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}},{"url":"\u003cstring\u003e","valueString":{},"valueCoding":{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]}},{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","participant":[{"actor":{"reference":"\u003cstring\u003e"}},{"actor":{"reference":"\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":{},"valueCoding":{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}},{"url":"\u003cstring\u003e","valueString":{},"valueCoding":{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]}}]}}]