NHnhs
Appointment Management

Amend or cancel an appointment

put/Appointment/{id}

Request

  • Base URL
    https://orange.testlab.nhs.uk/B82617/STU3/1/gpconnect/fhir
  • URL
    https://orange.testlab.nhs.uk/B82617/STU3/1/gpconnect/fhir/Appointment/{id}
  • Auth
    none declared. Required headers: Ssp-TraceID, Ssp-From, Ssp-To, Ssp-InteractionID, Authorization

Path parameters

idstring required

Appointment logical identifier

Headers

Ssp-TraceIDstring required

Consumer trace identifier

Ssp-Fromstring required

Consumer ASID

Ssp-Tostring required

Provider ASID

Ssp-InteractionID'urn:nhs:names:services:gpconnect:fhir:rest:update:appointment-1' | 'urn:nhs:names:services:gpconnect:fhir:rest:cancel:appointment-1' required

SDS interaction identifier

Authorizationstring required

Authorization header containing JWT

Request body

object required

Example request

{
  "resourceType": "Appointment",
  "id": "3",
  "meta": {
    "profile": [
      "https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-Appointment-1"
    ]
  },
  "contained": [
    {
      "resourceType": "Organization",
      "id": "1",
      "meta": {
        "profile": [
          "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1"
        ]
      },
      "identifier": [
        {
          "system": "https://fhir.nhs.uk/Id/ods-organization-code",
          "value": "GPC001"
        }
      ],
      "name": "GP Connect Demonstrator",
      "telecom": [
        {
          "system": "phone",
          "value": "0113 258 2569"
        }
      ]
    }
  ],
  "status": "booked",
  "created": "2018-11-14T14:31:55+00:00",
  "description": "A test appointment booked through Interactive Swagger API",
  "start": "2018-11-16T10:00:00+00:00",
  "end": "2018-11-16T10:10:00+00:00",
  "slot": [
    {
      "reference": "Slot/1"
    }
  ],
  "participant": [
    {
      "actor": {
        "reference": "Patient/2"
      },
      "status": "accepted"
    },
    {
      "actor": {
        "reference": "Location/1"
      },
      "status": "accepted"
    }
  ],
  "extension": [
    {
      "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-GPConnect-BookingOrganisation-1",
      "valueReference": {
        "reference": "#1"
      }
    }
  ]
}

Response

OK

Changes

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