Appointment Resource
Below are examples of each of the described interactions. The appointment resource adheres to the UKCore-Appointment definition.
Any operations that modify an existing resource must perform a read before a write, as outlined below.
Book
Making an initial booking through Appointment Management Foundation, outside of the prescribed BaRS Applications, must follow the workflow outlined using the discete booking endpoints.
If undertaking a booking within the context of an Application, the guidance stated there takes precedence over this documentation. NB: BaRS Applications are likely to utilise the $process-message endpoint (contact BaRS Team for guidance on use outside of the published Applications - bookingandreferralstandard@nhs.net), rather than independent resources. Steps to perform an initial booking:
- Select the service to book an appointment with
- Confirm BaRS Capabilities
- Request Available slots
- Select a slot
- Perform a POST operation to complete the booking NB: the returned Appointment.id for future operations
- Once processed, the Receiver of the booking must make a POST request to create a pointer in the central Registry, as described in Document Reference Standard Pattern - Receiver
Request Body
{
"resourceType": "Appointment",
"id":"aca94bdb-2e38-4399-9ece-2ba083ce65b5",
"meta": {
"lastUpdated": "2024-01-11T15:01:30.8185338+00:00",
"profile": [
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment"
]
},
"status": "booked",
"slot": [
{
"reference": "Slot/deb4c4b3-870b-4599-84df-5e54cef7afda"
}
],
"description": "Reason for calling",
"start": "2024-02-12T12:30:30+00:00",
"end": "2024-02-12T12:40:30+00:00",
"created": "2024-10-08T15:01:30+00:00",
"participant": [
{
"actor": {
"reference": "Patient/788660eb-d2c9-4773-abd4-318484673fb2"
},
"status": "accepted"
}
]
}
