Booking

Partially update a specific Appointment

Partially update a single Appointment resource.

patch/Appointment/{id}

Request

Base URL
https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4
URL
https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4/Appointment/{id}
Auth
HTTP bearer

Headers

use-contextstring required

Example:a4t2|validation|servicerequest-response|new

This header is for usage statistics for the BaRS Proxy for NHS England.

Request body

resourceTypestring

idstring uuid

statusstring

descriptionstring

startstring date-time

endstring date-time

createdstring date-time

Example request

{
  "resourceType": "Appointment",
  "id": "91607239-b002-470a-8709-6b25bd50fdd1",
  "meta": {
    "lastUpdated": "2021-10-11T15:01:30+00:00",
    "profile": [
      "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment"
    ]
  },
  "status": "booked",
  "description": "Reason for calling",
  "start": "2021-10-12T12:30:30+00:00",
  "end": "2021-10-12T12:40:30+00:00",
  "slot": [
    {
      "reference": "urn:uuid:deb4c4b3-870b-4599-84df-5e54cef7afda"
    }
  ],
  "created": "2021-10-11T15:01:30+00:00",
  "basedOn": [
    {
      "reference": "ServiceRequest/236bb75d-90ef-461f-b71e-fde7f899802c",
      "type": "serviceRequest"
    }
  ],
  "participant": [
    {
      "actor": {
        "reference": "urn:uuid:788660eb-d2c9-4773-abd4-318484673fb2"
      },
      "status": "accepted"
    }
  ]
}

Response

Successful response