Details the Cancel a Registered Appointment interaction

Important: Site under development by NHS Digital, it is advised not to develop against these specifications until a formal announcement has been made.

Use case

A system wishes to cancel an Appointment which was previously registered and has since been cancelled.

Security

• Utilises a JSON Web Token (JWT) to transmit Consumer system identity and authorisation details.
• Utilises TLS Mutual Authentication for system level authentication.

Request Body

The request body is sent using an http PUT method.

The body is a valid Appointment resource which conforms to the relevant profile. NB The appointment resource MUST be retrieved from the Registry in order to ensure that no data is lost.

The update is protected using the approach described in the FHIR standard therefore an update may be rejected to prevent the loss of data.

Response

Success

Where the request succeeded, the response WILL include a status of 200 OK. The response WILL include a Location header giving the absolute URL including the version as per the FHIR standard i.e: Location: [base]/Appointment/[id]/_history/[vid] where [id] and [vid] are the newly created id and version id for the resource version. This URL WILL remain stable, and the resource WILL support RESTful updates using a PUT request to this URL. The response body WILL include the updated Appointment.

Failure

• If the request fails because of a business rule (for example if differences are detected between the existing and updated Appointment), the response WILL include a status of 422 Unprocessable Entity as described here. This WILL be accompanied by an OperationOutcome resource providing additional detail.
• If the request fails because the request body failed validation against the relevant profiles, the response WILL include a status of 422 Unprocessable Entity as described here. This WILL be accompanied by an OperationOutcome resource providing additional detail.
• If the request fails because either no valid JWT is supplied or the supplied JWT failed validation, the response WILL include a status of 403 Forbidden. This WILL be accompanied by an OperationOutcome resource providing additional detail.
• If the request fails because a version conflict was detected, the response WILL include a status of 409 Conflict. This WILL be accompanied by an OperationOutcome resource providing additional detail.

• If the request fails because an update is attempted which does not include an If-Match header, the response WILL include a status of 412 Pre-condition failed. This WILL be accompanied by an OperationOutcome resource providing additional detail.

• If the request fails because the request body was simply invalid, the response WILL include a status of 400 Bad Request.
• If the request fails because of a server error, the response WILL include a status of 500 Internal Server Error.

Failure responses with a 4xx status SHOULD NOT be retried without taking steps to address the underlying cause of the failure.

Failure responses with a 500 status MAY be retried.

Sample request body

<Appointment xmlns="http://hl7.org/fhir">
	<id value="b7e99463-00a1-45fc-98aa-02301c103aba"/>
	<meta>
		<versionId value="1"/>
		<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Appointment-1"/>
	</meta>
	<identifier>
		<system value="urn:ietf:rfc:3986"/>
		<value value="http://test.nhs.uk/test3"/>
	</identifier>
	<status value="cancelled"/>
	<start value="2019-02-01T10:51:23.620+00:00"/>
	<end value="2019-01-17T15:10:00.000Z"/>
	<created value="2019-01-17T14:00:00.000Z"/>
	<participant>
		<actor>
			<identifier>
				<use value="official"/>
				<system value="https://fhir.nhs.uk/Id/nhs-number"/>
				<value value="1234554321"/>
			</identifier>
		</actor>
		<status value="accepted"/>
	</participant>
</Appointment>