NHnhs
DocumentReference

Delete a single document pointer

Delete a single document pointer that you created.

delete/DocumentReference/{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/DocumentReference/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:c3f6145e-1a26-4345-b3f2-dccbcba62049

The identifier of the registry object.

Headers

X-Request-Idstring uuid required
Example:c1ab3fba-6bae-4ba4-b257-5a87c44d4a91

The X-Request-Id for the request header, when supplied, mirrored back by the receiver.

X-Correlation-Idstring uuid required
Example:9562466f-c982-4bd5-bb0e-255e9f5e6689

The X-Correlation-Id for the request header, when supplied, mirrored back by the receiver.

Acceptstring required
Example:application/fhir+json; version=1.4.0

The Accept header must also contain version of BaRS Core the Sender is expecting to interoperate on.

use-contextstring required
Example:a4t2|validation|servicerequest-response|new

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

Response

Successful response

resourceTypestring
idstring uuid

Example response

{
  "resourceType": "OperationOutcome",
  "id": "531e073a-3295-4e67-ae90-e00bd96a9cdd",
  "meta": {
    "profile": [
      "https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome"
    ]
  },
  "issue": [
    {
      "severity": "information",
      "code": "informational",
      "diagnostics": "Resource updated"
    }
  ]
}

Changes

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