Appointment
Automatic sharing
The resource is automatically shared with all appointment participants referenced in Appointment.participant.actor
Semantical type
The FHIR resource type is also used as semantical type of the resource. Include the FHIR resource name Appointment into your applications access filter if you need to use this resource.
Resource owner
The creator of the resource is always the owner of the resource.
Read
Read a single Appointment by id.
Request:
[GET] /fhir/Appointment/<id>
Read specific version
Read a specific version of a single Appointment by id.
Request:
[GET] /fhir/Appointment/<id>/_history/<version>
Retrieve history
Retrieve all versions of a single resource.
Request:
[GET] /fhir/Appointment/<id>/_history
Search
Search for resources of type Appointment
Request:
[GET] /fhir/Appointment?searchParams
List of supported search parameters:
Supported query parameters:
| Name | Type | Description |
|---|---|---|
| _id | string | The resource identity |
| _lastUpdated | date | Only return resources which were last updated as specified by the given range |
| _page | string | |
| actor | reference | Any one of the individuals participating in the appointment |
| appointment-type | token | The style of appointment or patient that has been booked in the slot (not service type) |
| based-on | reference | The service request this appointment is allocated to assess |
| date | date | Appointment date/time. |
| identifier | token | An Identifier of the Appointment |
| location | reference | This location is listed in the participants of the appointment |
| part-status | token | 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. |
| patient | reference | One of the individuals of the appointment is this patient |
| practitioner | reference | One of the individuals of the appointment is this practitioner |
| reason-code | token | Coded reason this appointment is scheduled |
| reason-reference | reference | Reason the appointment is to take place (resource) |
| service-category | token | A broad categorization of the service that is to be performed during this appointment |
| service-type | token | The specific service that is to be performed during this appointment |
| slot | reference | The slots that this appointment is filling |
| specialty | token | The specialty of a practitioner that would be required to perform the service requested in this appointment |
| status | token | The overall status of the appointment |
| supporting-info | reference | Additional information to support the appointment |
Create
Create a new resource of type Appointment.
Request:
[POST] /fhir/Appointment
Update
Updates a resource of type Appointment.
Request:
[PUT] /fhir/Appointment/<id>