Use Case | Remove RA Record | FHIR® Reasonable Adjustments API

Description of Removal of enire Reasonable Adjustments Record from Spine via the FHIR® Reasonable Adjustments API

Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® Reasonable Adjustments API. This project is being developed using an agile methodology so iterative updates to content will be added on a regular basis.

Warning: This site is provided for information only and is intended for those engaged with NHS Digital. It is advised not to develop against these specifications until a formal announcement has been made.

1 Remove RA Record

Trigger

Practitioner wishes to remove an entire Reasonable Adjustment record

Summary

Practitioner enters Removal Reason. System inactivates all Reasonable Adjustment resources for Patient.

Pre

Practitioner has retrieved Patient’s RA Flag.

Trigger

Practitioner selects Remove Reasonable Adjustments Flag
or Practitioner removes Consent

Main

Practitioner enters Removal Reason and Supporting Comment
- ClientSystem generates new Parameter resource
- ClientSystem submits Remove RA Record (xml) (json)
  - ServerSystem submits Remove RA Record response(xml) (json)

2 Interaction Examples

2.1 Remove RA Record - xml example

http request & headers

POST https://clinicals.spineservices.nhs.uk/STU3/$removerarecord HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 123456123456
ToASID: 987654456789
TraceID: 0fd9c402-3bca-48a4-a5c3-06c5dd064a76
Content-Type: application/fhir+xml
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:removerarecord.write:1

http body

RemoveRARecord Operation Request XML Example

<!-- RemoveRARecord-OperationRequest.xml -->
<Parameters>
    <parameter>
        <name value="removeRARecord"/>
        <part>
            <name value="nhsNumber"/>
            <valueString value="999999998"/>
        </part>
        <part>
            <name value="removalReason"/>
            <valueCodeableConcept>
                <coding>
                    <system value="https://fhir.nhs.uk/STU3/CodeSystem/RARecord-RemovalReason-1"/>
                    <code value="DoesntApply"/>
                    <display value="The Reasonable Adjustment flag no longer applies to the patient"/>
                </coding>
            </valueCodeableConcept>
        </part>
        <part>
            <name value="supportingComment"/>
            <valueString value="No longer applies"/>
        </part>
    </parameter>
</Parameters>

2.2 Remove RA Record - json example

http request & headers

POST https://clinicals.spineservices.nhs.uk/STU3/$removerarecord HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 123456123456
ToASID: 987654456789
TraceID: 0fd9c402-3bca-48a4-a5c3-06c5dd064a76
Content-Type: application/fhir+json
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:removerarecord.write:1

http body

RemoveRARecord Operation Request JSON Example

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "removerarecord",
      "part": [
        {
          "name": "nhsNumber",
          "valueString": "999999998"
        },
        {
          "name": "removalReason",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "https://fhir.nhs.uk/STU3/CodeSystem/RARecord-RemovalReason-1",
                "code": "DoesntApply",
                "display": "The Reasonable Adjustment Flag no longer applies to the patient"
              }
            ]
          }
        },
        {
          "name": "supportingComment",
          "valueString": "No longer applies"
        }
      ]
    }
  ]
}

2.3 Remove RA Record outcome - xml example

http request & headers

HTTP/1.1 200 OK
Date: Tue, 25 Jul 2018 11:00:00 GMT
Content-Type: application/fhir+xml

http body

RemoveRARecord Operation Outcome XML Example

<!-- RemoveRARecord-OperationOutcome.xml -->
<OperationOutcome xmlns="http://hl7.org/fhir">
    <id value="89842084-66c6-4b3c-9eb2-63d43e5ab074"/>
    <meta>
        <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/Spine-OperationOutcome-1"/>
    </meta>
  <issue>
    <severity value="information"/>
    <code value="informational"/>
    <details>
      <text value="OK"/>
    </details>
 </issue>
</OperationOutcome>

2.4 Remove RA Record outcome - json example

http request & headers

HTTP/1.1 200 OK
Date: Tue, 25 Jul 2018 11:00:00 GMT
Content-Type: application/fhir+json

http body

RemoveRARecord Operation Outcome JSON Example

{
  "resourceType": "OperationOutcome",
  "id": "89842084-66c6-4b3c-9eb2-63d43e5ab074",
  "meta": {
    "profile": "https://fhir.nhs.uk/STU3/StructureDefinition/Spine-OperationOutcome-1"
  },
  "issue": [
    {
      "severity": "information",
      "code": "informational",
      "details": {
        "text": "OK"
      }
    }
  ]
}

Tags: