API Delete Interaction

References

Delete

Provider interaction to support the deletion of NRL pointers. The delete interaction is a FHIR RESTful delete interaction.

Prerequisites

In addition to the requirements on this page, the general guidance and requirements detailed on the Development Overview page MUST be followed when using this interaction.

Delete Request Headers

Provider API delete requests support the following HTTP request headers:

Delete Operation

Provider systems MUST only delete pointers for records where they are the pointer owner (custodian).

For all delete requests the custodian ODS code in the DocumentReference to be deleted MUST be affiliated with the Client System ASID value in the fromASID HTTP request header sent to the NRL.

Delete by id

The API supports the delete by ID interaction, which allows a provider to delete an existing pointer based on the pointer’s logical ID.

The logical ID can be obtained from the Location header contained in the create response - see the Create API Interaction for details.

To accomplish this, the provider issues an HTTP DELETE as shown:

DELETE [baseUrl]/DocumentReference/da2b6e8a-3c8f-11e8-baae-6c3be5a609f5-584d385036514c383142

Delete the DocumentReference resource for a pointer with a logical id of 'da2b6e8a-3c8f-11e8-baae-6c3be5a609f5-584d385036514c383142'.

Conditional Delete by id

The API supports the conditional delete by id interaction which allows a provider to delete an existing pointer based on the search parameter _id which refers to the pointer’s logical ID.

The logical ID can be obtained from the Location header contained in the create response - see the Create API Interaction for details.

To accomplish this, the provider issues an HTTP DELETE as shown:

DELETE [baseUrl]/DocumentReference?_id=da2b6e8a-3c8f-11e8-baae-6c3be5a609f5-584d385036514c383142

Delete the DocumentReference resource for a pointer conditionally with a logical ID of 'da2b6e8a-3c8f-11e8-baae-6c3be5a609f5-584d385036514c383142'.

Conditional Delete by masterIdentifier

The API supports the conditional delete by masterIdentifier interaction which allows a provider to delete an existing pointer using the master identifier negating the requirement to persist or query the NRL to obtain the generated logical ID for the pointer.

To accomplish this, the provider issues an HTTP DELETE as shown:

• [nhsNumber] - The NHS Number of the patient related to the DocumentReference.
• [system] - The namespace of the masterIdentifier value associated with the DocumentReference.
• [value] - The value of the masterIdentifier associated with the DocumentReference.

DELETE [baseUrl]/DocumentReference?subject=https%3A%2F%2Fdemographics.spineservices.nhs.uk%2FSTU3%2FPatient%2F9876543210%26identifier%3Durn%3Aietf%3Arfc%3A3986%257Curn%3Aoid%3A1.3.6.1.4.1.21367.2005.3.71

Delete the DocumentReference resource for a pointer with a subject and identifier.

Response

The delete interaction removes an existing DocumentReference resource.

Success

A successful execution of the delete interaction will return:

• a 200 OK HTTP status code confirming pointer deletion.
• a response body containing an OperationOutcome resource (see below for full details).

OperationOutcome

The OperationOutcome in the response body will conform to the Spine-OperationOutcome-1 FHIR resource:

Example success response body (XML)

<OperationOutcome xmlns="http://hl7.org/fhir">
  <id value="01be50a1-f755-4461-aa64-90ad41b68055-00000000000000000000" />
  <meta>
    <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/Spine-OperationOutcome-1" />
  </meta>
  <issue>
    <severity value="information" />
    <code value="informational" />
    <details>
      <coding>
        <system value="https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1" />
        <code value="RESOURCE_DELETED" />
        <display value="Resource removed" />
      </coding>
      <text value="5b01d97f-68ac-4faa-85d1-dda3af28a2d2" />
    </details>
    <diagnostics value="Successfully removed resource DocumentReference: http://data.developer.nhs.uk/nrls-ri/DocumentReference/5f5247c68ae8c40001ba7d91" />
  </issue>
</OperationOutcome>

Example success response body (JSON)

{
  "resourceType": "OperationOutcome",
  "id": "01be50a1-f755-4461-aa64-90ad41b68055-00000000000000000000",
  "meta": {
    "profile": [
      "https://fhir.nhs.uk/STU3/StructureDefinition/Spine-OperationOutcome-1"
    ]
  },
  "issue": [
    {
      "severity": "information",
      "code": "informational",
      "details": {
        "coding": [
          {
            "system": "https://fhir.nhs.uk/STU3/CodeSystem/Spine-ErrorOrWarningCode-1",
            "code": "RESOURCE_DELETED",
            "display": "Resource removed"
          }
        ],
        "text": "5b01d97f-68ac-4faa-85d1-dda3af28a2d2"
      },
      "diagnostics": "Successfully removed resource DocumentReference: http://data.developer.nhs.uk/nrls-ri/DocumentReference/5f5247c68ae8c40001ba7d91"
    }
  ]
}

Failure

The following errors can be triggered when performing this operation:

• No record found
• Invalid Resource

Explore the NRL

You can explore and test the delete interaction using Swagger in the NRL API Reference Implementation.