Booking

Retrieve a booking

get/nhsapi/v1/Booking/{id}

Request

  • Base URL: https://www.example.com
  • URL: https://www.example.com/nhsapi/v1/Booking/{id}
  • Auth: none declared

Path parameters

idunknown required

Booking ID

Headers

X-External-Account-Tokenstring

External account token for authentication

Response

booking retrieved

idstring
resourceTypestring
statusstring
costCentrestring

Example response

{
  "id": "9b6c2c7e-5e7a-4e86-8c1e-8c1e4e86c7e5",
  "resourceType": "Booking",
  "meta": {
    "profile": "https://api.patchwork.health/Booking"
  },
  "status": "confirmed",
  "organization": [
    {
      "type": "Organization",
      "identifier": {
        "system": "Patchwork",
        "value": "1"
      },
      "display": "Unique Test Hospital NHS API",
      "coding": {
        "code": "1"
      }
    }
  ],
  "Worker": {
    "workerReference": {
      "identifier": {
        "value": "123456"
      },
      "display": "John Smith"
    }
  },
  "costCentre": "validcostcentre",
  "basedOn": {
    "type": "Vacancy",
    "system": "Patchwork",
    "reference": "some-vacancy-id"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.