Delete or Cancel a Appointment resource by id
Delete or Cancel a single Appointment resource.
Path parameters
The identifier of the resource.
Headers
The X-Request-Id for the request header, when supplied, mirrored back by the receiver.
The X-Correlation-Id for the request header, when supplied, mirrored back by the receiver.
Identifier
The identifier of the Target system. A Base64 encoded object containing value and system properties. More information for this can be found in our implementation guidance.
Example object before encoding
{
"value": "2000011147",
"system": "https://fhir.nhs.uk/Id/dos-service-id"
}
Requesting Organization described in an object based on a FHIR 'Organization' resource (Standard Base64 encoded JSON). Different BaRS Applications may have different standards and requirements for the Access Control which these headers are used for.
In this example an ODS code and the Organisation name is provided. Other identifiers are permitted if required.
Requesting Organization described in an object based on a FHIR 'Organization' resource (Standard Base64 encoded JSON). Different BaRS Applications may have different standards and requirements for the Access Control which these headers are used for. In the example given an ODS code and the Organisation name is provided. Other identifiers are permitted if required.
Example object before encoding
{
"resourceType": "Organization",
"identifier": [
{
"value": "A1001",
"system": "https://fhir.nhs.uk/Id/ods-organization-code"
}
],
"name": "My service provider name"
}
Requesting Practitioner described in an object based on a FHIR 'PractitionerRole' resource (Standard Base64 encoded JSON).
This item is not mandatory, however if the information is available it must be included in the request. Only in the event that it is not available, should it be omitted.
The example below shows a General Practitioner and their SDS Role profile Id. The Base64 encoded example below shows a General Practitioner and their SDS Role profile Id.
Requesting Practitioner described in an object based on a FHIR 'PractitionerRole' resource (Standard Base64 encoded JSON).
This item is not mandatory, however if the information is available it must be included in the request. Only in the event that it is not available, should it be omitted.
The example given shows a General Practitioner and their SDS Role profile Id.
Example object before encoding
{
"resourceType": "PractitionerRole",
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/sds-role-profile-id",
"value": "100334993514"
}
],
"code": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "62247001",
"display": "General practitioner"
}
]
}
]
}
Requesting Software described in an object based on a FHIR 'Device' resource (Standard Base64 encoded JSON). Different BaRS Applications may have different standards and requirements for the Access Control which these headers are used for.
The identifier used here, though arbitrary, should be consistent across instances of a product, the name and version of the product should also be accurate and consistent.
Requesting Software described in an object based on a FHIR 'Device' resource (Standard Base64 encoded JSON). Different BaRS Applications may have different standards and requirements for the Access Control which these headers are used for.
The identifier used, though arbitrary, should be consistent across instances of a product, the name and version of the product should also be accurate and consistent.
Example object before encoding
{
"resourceType": "Device",
"identifier": [
{
"system": "https://consumersupplier.com/Id/device-identifier",
"value": "SUPP-APP-1"
}
],
"deviceName": {
"name": "Supplier product name",
"type": "manufacturer-name"
},
"version": {
"value": "1.0.0"
}
}
The Accept header must also contain version of BaRS Core the Sender is expecting to interoperate on.
This header is for usage statistics for the BaRS Proxy for NHS England.
Response
Successful response