Appointment_GET
GET {{baseUrl}}/Appointment?actor=<string>&incomingreferral=<string>&location=<string>&patient=<string>&practitioner=<string>&_id=<string>&_lastUpdated=<date>&_profile=<string>&_security=<string>&_tag=<string>&appointment-type=<string>&date=<date>&identifier=<string>&part-status=<string>&service-type=<string>&status=<string>&_format=<string>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
actor | string | Any one of the individuals participating in the appointment | |
incomingreferral | string | The ReferralRequest provided as information to allocate to the Encounter | |
location | string | This location is listed in the participants of the appointment | |
patient | string | One of the individuals of the appointment is this patient | |
practitioner | string | One of the individuals of the appointment is this practitioner | |
_id | string | Logical id of this artifact | |
_lastUpdated | string | When the resource version last changed | |
_profile | string | Profiles this resource claims to conform to | |
_security | string | Security Labels applied to this resource | |
_tag | string | Tags applied to this resource | |
appointment-type | string | The style of appointment or patient that has been booked in the slot (not service type) | |
date | string | Appointment date/time. | |
identifier | string | An Identifier of the Appointment | |
part-status | string | The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. | |
service-type | string | The specific service that is to be performed during this appointment | |
status | string | The overall status of the appointment | |
_format | string |
RESPONSES
status: OK
[{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"status":"\u003cstring\u003e","serviceCategory":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"serviceType":[{"coding":[{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}],"specialty":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}],"appointmentType":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"priority":"\u003cnumber\u003e","description":"\u003cstring\u003e","start":"\u003cstring\u003e","end":"\u003cstring\u003e","created":"\u003cstring\u003e","comment":"\u003cstring\u003e","participant":[{"required":"\u003cstring\u003e","status":"\u003cstring\u003e","type":[{"coding":[{"system":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}],"actor":{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]},{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","text":{"status":"\u003cstring\u003e","div":"\u003cstring\u003e"},"status":"\u003cstring\u003e","serviceCategory":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"serviceType":[{"coding":[{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}],"specialty":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}],"appointmentType":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"priority":"\u003cnumber\u003e","description":"\u003cstring\u003e","start":"\u003cstring\u003e","end":"\u003cstring\u003e","created":"\u003cstring\u003e","comment":"\u003cstring\u003e","participant":[{"required":"\u003cstring\u003e","status":"\u003cstring\u003e","type":[{"coding":[{"system":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}],"actor":{"reference":"\u003cstring\u003e","display":"\u003cstring\u003e"}}]}]