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

Description of use case on 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 Create RA Record

Trigger:

GP initiates Reasonable Adjustment Flag discussion at annual health check

System Scope:

ClientSystem includes Acute/DepartmentalSystem client, SCRa, 1-click etc.
ServerSystem includes Spine, PDS, SDS, FlagServer etc.

Summary:

Practitioner creates RARecord, recording Consent from Patient and that Impairment is ‘Learning Disability’.
Patient declines to record a specific Adjustment at this time.

Pre

Patient arrives at check
Practitioner logged into ClientSystem, traces & verifies demographic information
Practitioner searches for Patient’s RARecord
- ClientSystem searched and failed to find existing RARecord (see Use Case Initial Read Failure)
Practitioner discusses RARecord with Patient

Main

Patient consents to record RA Flag
- Practitioner creates new RARecord for Patient (by recording Consent)
- Practitioner records Patient consented to record RA info
  - ClientSystem captures and structures Consent information as new RARecord Consent-1 resource (xml) (json)
Patient agrees to record ‘Learning Disability’ as Impairment
- Practitioner adds Impairment from coded picklist (optionally elaborates w separate freetext)
  - ClientSystem captures and structures Impairment information as new Impairment (CareConnect-RARecord-Condition-1) resource (xml) (json)
Patient declines to record any specific Adjustments at this time
Practitioner commits RARecord
- ClientSystem submits Create Consent request (xml) (json)
  - ServerSystem submits Create Consent response (xml) (json)
- ClientSystem captures and structures Provenance information as new Provenance (RARecord-Provenance-1) resource (xml) (json)
- ClientSystem creates new CareConnect-RARecord-List-1 to contain Impairment resource (xml) (json)
- ClientSystem contains new Impairment resource within CareConnect-RARecord-List-1 resource
- ClientSystem contains new Provenance resource within CareConnect-RARecord-List-1 resource (xml) (json)
- ClientSystem submits Create Condition request (xml) (json)
  - ServerSystem submits Create Condition response (xml) (json)

2 Examples

Examples of resources http requests, responses and payloads

resource

<!-- CreateExample-CreateConsentRequest.xml -->
<Consent xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Consent-1"/>
    </meta>
    <extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-ProxyRole-1">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ProxyRole-1"/>
                <code value="003"/>
                <display value="Lasting power of attorney for health and welfare, or court-appointed deputy, or equivalent"/>
            </coding>
        </valueCodeableConcept>
    </extension>
    <status value="active"/>
    <category>
        <coding>
            <system value="https://fhir.nhs.uk/STU3/CodeSystem/RARecord-FlagCategory-1"/>
            <code value="NRAF"/>
            <display value="National Reasonable Adjustments Flag"/>
        </coding>
    </category>
    <patient>
        <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
    </patient>
    <policy>
        <authority value="https://www.gov.uk/"/>
        <uri value="https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/535024/data-security-review.pdf"/>
    </policy>
    <purpose>
        <system value="https://snomed.info/sct"/>
        <code value="370856009"/>
        <display value="Limiting access to confidential patient information"/>
    </purpose>
</Consent>

resource

{
  "resourceType": "Consent",
  "fhir_comments": [
    " CreateExample-CreateConsentRequest.xml "
  ],
  "meta": {
    "profile": [
      "https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Consent-1"
    ]
  },
  "extension": [
    {
      "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-ProxyRole-1",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ProxyRole-1",
            "code": "003",
            "display": "Lasting power of attorney for health and welfare, or court-appointed deputy, or equivalent"
          }
        ]
      }
    }
  ],
  "status": "active",
  "category": [
    {
      "coding": [
        {
          "system": "https://fhir.nhs.uk/STU3/CodeSystem/RARecord-FlagCategory-1",
          "code": "reasonable adjustments flag",
          "display": "Reasonable Adjustments Flag"
        }
      ]
    }
  ],
  "patient": {
    "reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
  },
  "policy": [
    {
      "authority": "https://www.gov.uk/",
      "uri": "https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/535024/data-security-review.pdf"
    }
  ],
  "purpose": [
    {
      "system": "https://snomed.info/sct",
      "code": "370856009",
      "display": "Limiting access to confidential patient information"
    }
  ]
}

2.3 Create Condition Resource - xml example

resource

Create Condition Resource XML Example

<!-- CreateExample-CreateConditionRequest.xml -->
<Condition xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-Condition-1" />
    </meta>
    <clinicalStatus value="active"/>
    <category>
        <coding>
            <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ConditionCategory-1"/>
            <code value="issue"/>
            <display value="Issue"/>
        </coding>
    </category>
        <code>
            <coding>
                <system value="https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ConditionCode-1"/>
                <code value="5"/>
                <display value="Learning or understanding or concentrating"/>
            </coding>
        </code>
    <subject>
        <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
    </subject>
</Condition>

2.4 Create Condition Resource - json example

resource

Create Condition Resource JSON Example

{
  "resourceType": "Condition",
  "fhir_comments": [
    " CreateExample-CreateConditionRequest.xml "
  ],
  "meta": {
    "profile": [
      "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-Condition-1"
    ]
  },
  "clinicalStatus": "active",
  "category": [
    {
      "coding": [
        {
          "system": "https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ConditionCategory-1",
          "code": "issue",
          "display": "Issue"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ConditionCode-1",
        "code": "1855002",
        "display": "Learning Disability(s)"
      }
    ]
  },
  "subject": {
    "reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
  }
}

http request & headers

POST https://clinicals.spineservices.nhs.uk/STU3/Consent 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:Consent.write:1

http body

<!-- CreateExample-CreateConsentRequest.xml -->
<Consent xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Consent-1"/>
    </meta>
    <extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-ProxyRole-1">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ProxyRole-1"/>
                <code value="003"/>
                <display value="Lasting power of attorney for health and welfare, or court-appointed deputy, or equivalent"/>
            </coding>
        </valueCodeableConcept>
    </extension>
    <status value="active"/>
    <category>
        <coding>
            <system value="https://fhir.nhs.uk/STU3/CodeSystem/RARecord-FlagCategory-1"/>
            <code value="NRAF"/>
            <display value="National Reasonable Adjustments Flag"/>
        </coding>
    </category>
    <patient>
        <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
    </patient>
    <policy>
        <authority value="https://www.gov.uk/"/>
        <uri value="https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/535024/data-security-review.pdf"/>
    </policy>
    <purpose>
        <system value="https://snomed.info/sct"/>
        <code value="370856009"/>
        <display value="Limiting access to confidential patient information"/>
    </purpose>
</Consent>

http request & headers

POST https://clinicals.spineservices.nhs.uk/STU3/Consent 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:Consent.write:1

http body

{
  "resourceType": "Consent",
  "fhir_comments": [
    " CreateExample-CreateConsentRequest.xml "
  ],
  "meta": {
    "profile": [
      "https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Consent-1"
    ]
  },
  "extension": [
    {
      "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-ProxyRole-1",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ProxyRole-1",
            "code": "003",
            "display": "Lasting power of attorney for health and welfare, or court-appointed deputy, or equivalent"
          }
        ]
      }
    }
  ],
  "status": "active",
  "category": [
    {
      "coding": [
        {
          "system": "https://fhir.nhs.uk/STU3/CodeSystem/RARecord-FlagCategory-1",
          "code": "reasonable adjustments flag",
          "display": "Reasonable Adjustments Flag"
        }
      ]
    }
  ],
  "patient": {
    "reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
  },
  "policy": [
    {
      "authority": "https://www.gov.uk/",
      "uri": "https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/535024/data-security-review.pdf"
    }
  ],
  "purpose": [
    {
      "system": "https://snomed.info/sct",
      "code": "370856009",
      "display": "Limiting access to confidential patient information"
    }
  ]
}

http response & headers

HTTP/1.1 201 Created
Date: Tue, 23 Jul 2018 11:00:00 GMT
Last-Modified:2018-07-23T11:00:00+00:00
Location: https://clinicals.spineservices.nhs.uk/STU3/Consent/f1dc0ac6-45ff-4d2b-bf91-793971e3e286/_history/cccacb16-e087-45ee-8ddd-5fbd6223e5a2
ETag: W/"cccacb16-e087-45ee-8ddd-5fbd6223e5a2”
Content-Type: application/fhir+xml

http body

<!-- CreateExample-CreateConsentResponse.xml -->
<Consent xmlns="http://hl7.org/fhir">
    <id value="f1dc0ac6-45ff-4d2b-bf91-793971e3e286"/>
    <meta>
        <versionId value="cccacb16-e087-45ee-8ddd-5fbd6223e5a2"/>
        <lastUpdated value="2018-07-23T11:00:00+00:00"/>
        <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Consent-1"/>
    </meta>
    <contained>
        <!-- Provenance constructed and persisted -->
        <Provenance>
            <id value="e0531fd1-212d-4a97-a7a9-d17cec9a6af2"/>
            <meta>
                <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
            </meta>
            <target>
                <reference value="#"/>
            </target>
            <recorded value="2018-07-23T11:00:00+00:00"/>
            <activity>
                <coding>
                    <system value="http://hl7.org/fhir/v3/DataOperation"/>
                    <code value="CREATE"/>
                    <display value="create"/>
                </coding>
            </activity>
            <agent>
                <role>
                    <coding>
                        <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1"/>
                        <code value="R0260"/>
                        <display value="General Medical Practitioner"/>
                    </coding>
                </role>
                <whoReference>
                    <reference value="https://sds.spineservices.nhs.uk/STU3/Practitioner/2ee4tr6a9"/>
                    <display value="Dr.D"/>
                </whoReference>
                <onBehalfOfReference>
                    <reference value="https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7"/>
                    <display value="Some GP Clinic"/>
                </onBehalfOfReference>
            </agent>
        </Provenance>
    </contained>
    <extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-ProxyRole-1">
        <valueCodeableConcept>
            <coding>
                <system value="https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ProxyRole-1"/>
                <code value="003"/>
                <display value="Lasting power of attorney for health and welfare, or court-appointed deputy, or equivalent"/>
            </coding>
        </valueCodeableConcept>
    </extension>
    <status value="active"/>
    <category>
        <coding>
            <system value="https://fhir.nhs.uk/STU3/CodeSystem/RARecord-FlagCategory-1"/>
            <code value="NRAF"/>
            <display value="National Reasonable Adjustments Flag"/>
        </coding>
    </category>
    <patient>
        <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
    </patient>
    <policy>
        <authority value="https://www.gov.uk/"/>
        <uri value="https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/535024/data-security-review.pdf"/>
    </policy>
    <purpose>
        <system value="https://snomed.info/sct"/>
        <code value="370856009"/>
        <display value="Limiting access to confidential patient information"/>
    </purpose>
</Consent>

http response & headers

HTTP/1.1 201 Created
Date: Tue, 23 Jul 2018 11:00:00 GMT
Last-Modified:2018-07-23T11:00:00+00:00
Location: [resourceURL]
ETag: W/"resourceVID”
Content-Type: application/fhir+json

http body

{
  "resourceType": "Consent",
  "id": "f1dc0ac6-45ff-4d2b-bf91-793971e3e286",
  "fhir_comments": [
    " CreateExample-CreateConsentResponse.xml "
  ],
  "meta": {
    "versionId": "cccacb16-e087-45ee-8ddd-5fbd6223e5a2",
    "lastUpdated": "2018-07-23T11:00:00+00:00",
    "profile": [
      "https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Consent-1"
    ]
  },
  "contained": [
    {
      "resourceType": "Provenance",
      "id": "e0531fd1-212d-4a97-a7a9-d17cec9a6af2",
      "fhir_comments": [
        " Provenance constructed and persisted "
      ],
      "meta": {
        "profile": [
          "https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"
        ]
      },
      "target": [
        {
          "reference": "#"
        }
      ],
      "recorded": "2018-07-23T11:00:00+00:00",
      "activity": {
          "system": "http://hl7.org/fhir/v3/DataOperation",
          "code": "CREATE",
          "display": "create"
        },
      "agent": [
        {
          "role": [
            {
              "coding": [
                {
                  "system": "https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1",
                  "code": "R0260",
                  "display": "General Medical Practitioner"
                }
              ]
            }
          ],
          "whoReference": {
            "reference": "https://sds.spineservices.nhs.uk/STU3/Practitioner/2ee4tr6a9",
            "display": "Dr.D"
          },
          "onBehalfOfReference": {
            "reference": "https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7",
            "display": "Some GP Clinic"
          }
        }
      ]
    }
  ],
  "extension": [
    {
      "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-ProxyRole-1",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ProxyRole-1",
            "code": "003",
            "display": "Lasting power of attorney for health and welfare, or court-appointed deputy, or equivalent"
          }
        ]
      }
    }
  ],
  "status": "active",
  "category": [
    {
      "coding": [
        {
          "system": "https://fhir.nhs.uk/STU3/CodeSystem/RARecord-FlagCategory-1",
          "code": "reasonable adjustments flag",
          "display": "Reasonable Adjustments Flag"
        }
      ]
    }
  ],
  "patient": {
    "reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
  },
  "policy": [
    {
      "authority": "https://www.gov.uk/",
      "uri": "https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/535024/data-security-review.pdf"
    }
  ],
  "purpose": [
    {
      "system": "https://snomed.info/sct",
      "code": "370856009",
      "display": "Limiting access to confidential patient information"
    }
  ]
}

2.9 Create Provenance Resource - xml example

resource

Create Provenance Resource XML Example

<!-- CreateExample-CreateProvenanceResource.xml -->
<Provenance>
    <id value="8ce7de6b-1307-432d-8e96-ae6a613ca3e4"/>
    <meta>
        <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
    </meta>
    <target>
        <reference value="Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"/>
    </target>
    <recorded value="2018-07-23T11:00:00+00:00"/>
    <agent>
        <role>
            <coding>
                <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1"/>
                <code value="R0260"/>
                <display value="General Medical Practitioner"/>
            </coding>
        </role>
        <whoReference>
            <reference value="https://sds.spineservices.nhs.uk/STU3/Practitioner/2ee4tr6a9"/>
            <display value="Dr.D"/>
        </whoReference>
        <onBehalfOfReference>
            <reference value="https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7"/>
            <display value="Some GP Clinic"/>
        </onBehalfOfReference>
    </agent>
</Provenance>

2.10 Create Provenance Resource - json example

resource

Create Provenance Resource JSON Example

{
  "resourceType": "Condition",
  "fhir_comments": [
    " json example AAJSONPlaceholder.json "
  ]
}

2.11 Create List Resource - xml example

resource

Create List Resource XML Example

<!-- CreateExample-CreateListResource.xml -->
<List xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-List-1"/>
    </meta>
    <status value="current"/>
    <mode value="changes"/>
    <title value="Reasonable Adjustment List"/>
    <code>
        <coding>
            <system value="http://snomed.info/sct"/>
            <code value="1094391000000102"/>
            <display value="Reasonable adjustments for health and care access"/>
        </coding>
    </code>
    <subject>
        <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
    </subject>
    <date value="2018-07-23T11:00:00+00:00"/>
</List>

2.12 Create List Resource - json example

resource

Create List Resource JSON Example

{
  "resourceType": "Condition",
  "fhir_comments": [
    " json example AAJSONPlaceholder.json "
  ]
}

2.13 Create List Condition Resource - xml example

resource

Create List Condition Resource XML Example

<!-- CreateExample-ListConditionResource.xml -->
<List xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-List-1"/>
    </meta>
    <contained>
        <Condition xmlns="http://hl7.org/fhir">
            <id value="57f04652-6dd0-4135-a560-f9091b1b26fa"/>
            <meta>
                <versionId value="557ccfc3-0c78-48bf-aedd-70cc08af2ba1"/>
                <lastUpdated value="2018-07-23T11:00:00+00:00"/>
                <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-Condition-1" />
            </meta>
            <clinicalStatus value="active"/>
            <category>
                <coding>
                    <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ConditionCategory-1"/>
                    <code value="issue"/>
                    <display value="Issue"/>
                </coding>
            </category>
            <code>
                <coding>
                    <system value="https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ConditionCode-1"/>
                    <code value="5"/>
                    <display value="Learning or understanding or concentrating"/>
                </coding>
            </code>
            <subject>
                <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
            </subject>
        </Condition>
    </contained>
    <contained>
        <Provenance>
            <id value="8ce7de6b-1307-432d-8e96-ae6a613ca3e4"/>
            <meta>
                <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
            </meta>
            <target>
                <reference value="Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"/>
            </target>
            <recorded value="2018-07-23T11:00:00+00:00"/>
            <activity>
                <coding>
                    <system value="http://hl7.org/fhir/v3/DataOperation"/>
                    <code value="CREATE"/>
                    <display value="create"/>
                </coding>
            </activity>
            <agent>
                <role>
                    <coding>
                        <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1"/>
                        <code value="R0260"/>
                        <display value="General Medical Practitioner"/>
                    </coding>
                </role>
                <whoReference>
                    <reference value="https://sds.spineservices.nhs.uk/STU3/Practitioner/2ee4tr6a9"/>
                    <display value="Dr.D"/>
                </whoReference>
                <onBehalfOfReference>
                    <reference value="https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7"/>
                    <display value="Some GP Clinic"/>
                </onBehalfOfReference>
            </agent>
        </Provenance>
    </contained>
    <status value="current"/>
    <mode value="changes"/>
    <title value="Reasonable Adjustment List"/>
    <code>
        <coding>
            <system value="http://snomed.info/sct"/>
            <code value="1094391000000102"/>
            <display value="Reasonable adjustments for health and care access"/>
        </coding>
    </code>
    <subject>
        <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
    </subject>
    <date value="2018-07-23T11:00:00+00:00"/>
    <entry>
        <deleted value="false"/>
        <date value="2018-07-23T11:00:00+00:00"/>
        <item>
            <reference value="urn:uuid:557ccfc3-0c78-48bf-aedd-70cc08af2ba1"/>
        </item>
    </entry>
    <entry>
        <deleted value="false"/>
        <date value="2018-07-23T11:00:00+00:00"/>
        <item>
            <reference value="urn:uuid:8ce7de6b-1307-432d-8e96-ae6a613ca3e4"/>
        </item>
    </entry>
</List>

2.14 Create List Condition Resource - json example

resource

Create List Condition Resource JSON Example

{
  "resourceType": "Condition",
  "fhir_comments": [
    " json example AAJSONPlaceholder.json "
  ]
}

2.15 Create List Condition Request - xml example

http request & headers

POST https://clinicals.spineservices.nhs.uk/STU3/List 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:List.write:1

http body

Create List Condition Request XML Example

<!-- CreateExample-ListConditionResource.xml -->
<List xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-List-1"/>
    </meta>
    <contained>
        <Condition xmlns="http://hl7.org/fhir">
            <id value="57f04652-6dd0-4135-a560-f9091b1b26fa"/>
            <meta>
                <versionId value="557ccfc3-0c78-48bf-aedd-70cc08af2ba1"/>
                <lastUpdated value="2018-07-23T11:00:00+00:00"/>
                <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-Condition-1" />
            </meta>
            <clinicalStatus value="active"/>
            <category>
                <coding>
                    <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ConditionCategory-1"/>
                    <code value="issue"/>
                    <display value="Issue"/>
                </coding>
            </category>
            <code>
                <coding>
                    <system value="https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ConditionCode-1"/>
                    <code value="5"/>
                    <display value="Learning or understanding or concentrating"/>
                </coding>
            </code>
            <subject>
                <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
            </subject>
        </Condition>
    </contained>
    <contained>
        <Provenance>
            <id value="8ce7de6b-1307-432d-8e96-ae6a613ca3e4"/>
            <meta>
                <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
            </meta>
            <target>
                <reference value="Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"/>
            </target>
            <recorded value="2018-07-23T11:00:00+00:00"/>
            <activity>
                <coding>
                    <system value="http://hl7.org/fhir/v3/DataOperation"/>
                    <code value="CREATE"/>
                    <display value="create"/>
                </coding>
            </activity>
            <agent>
                <role>
                    <coding>
                        <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1"/>
                        <code value="R0260"/>
                        <display value="General Medical Practitioner"/>
                    </coding>
                </role>
                <whoReference>
                    <reference value="https://sds.spineservices.nhs.uk/STU3/Practitioner/2ee4tr6a9"/>
                    <display value="Dr.D"/>
                </whoReference>
                <onBehalfOfReference>
                    <reference value="https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7"/>
                    <display value="Some GP Clinic"/>
                </onBehalfOfReference>
            </agent>
        </Provenance>
    </contained>
    <status value="current"/>
    <mode value="changes"/>
    <title value="Reasonable Adjustment List"/>
    <code>
        <coding>
            <system value="http://snomed.info/sct"/>
            <code value="1094391000000102"/>
            <display value="Reasonable adjustments for health and care access"/>
        </coding>
    </code>
    <subject>
        <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
    </subject>
    <date value="2018-07-23T11:00:00+00:00"/>
    <entry>
        <deleted value="false"/>
        <date value="2018-07-23T11:00:00+00:00"/>
        <item>
            <reference value="urn:uuid:557ccfc3-0c78-48bf-aedd-70cc08af2ba1"/>
        </item>
    </entry>
    <entry>
        <deleted value="false"/>
        <date value="2018-07-23T11:00:00+00:00"/>
        <item>
            <reference value="urn:uuid:8ce7de6b-1307-432d-8e96-ae6a613ca3e4"/>
        </item>
    </entry>
</List>

2.16 Create List Condition Request - json example

http request & headers

POST https://clinicals.spineservices.nhs.uk/STU3/List 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:List.write:1

http body

Create List Condition Request JSON Example

{
  "resourceType": "Condition",
  "fhir_comments": [
    " json example AAJSONPlaceholder.json "
  ]
}

2.17 Create List Condition Response - xml example

http response & headers

HTTP/1.1 201 Created
Date: Tue, 23 Jul 2018 11:00:00 GMT
Last-Modified:2018-07-23T11:00:00+00:00
Location: https://clinicals.spineservices.nhs.uk/STU3/List/130f416a-055d-4a5d-a453-2b7c2de3b57b/_history/f2fef5e5-c38a-408c-a9bc-2d49923928f8
ETag: W/"f2fef5e5-c38a-408c-a9bc-2d49923928f8”
Content-Type: application/fhir+xml

http body

Create List Condition Response XML Example

<!-- CreateExample-ListConditionResponse.xml -->
<List xmlns="http://hl7.org/fhir">
    <id value="130f416a-055d-4a5d-a453-2b7c2de3b57b"/>
    <meta>
        <versionId value="f2fef5e5-c38a-408c-a9bc-2d49923928f8"/>
        <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-List-1"/>
    </meta>
    <contained>
        <Condition xmlns="http://hl7.org/fhir">
            <id value="57f04652-6dd0-4135-a560-f9091b1b26fa"/>
            <meta>
                <versionId value="557ccfc3-0c78-48bf-aedd-70cc08af2ba1"/>
                <lastUpdated value="2018-07-23T11:00:00+00:00"/>
                <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-Condition-1" />
            </meta>
            <clinicalStatus value="active"/>
            <category>
                <coding>
                    <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ConditionCategory-1"/>
                    <code value="issue"/>
                    <display value="Issue"/>
                </coding>
            </category>
            <code>
                <coding>
                    <system value="https://fhir.nhs.uk/STU3/CodeSystem/RARecord-ConditionCode-1"/>
                    <code value="5"/>
                    <display value="Learning or understanding or concentrating"/>
                </coding>
            </code>
            <subject>
                <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
            </subject>
        </Condition>
    </contained>
    <contained>
        <Provenance>
            <id value="8ce7de6b-1307-432d-8e96-ae6a613ca3e4"/>
            <meta>
                <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
            </meta>
            <target>
                <reference value="Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"/>
            </target>
            <recorded value="2018-07-23T11:00:00+00:00"/>
            <activity>
                <coding>
                    <system value="http://hl7.org/fhir/v3/DataOperation"/>
                    <code value="CREATE"/>
                    <display value="create"/>
                </coding>
            </activity>
            <agent>
                <role>
                    <coding>
                        <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1"/>
                        <code value="R0260"/>
                        <display value="General Medical Practitioner"/>
                    </coding>
                </role>
                <whoReference>
                    <reference value="https://sds.spineservices.nhs.uk/STU3/Practitioner/2ee4tr6a9"/>
                    <display value="Dr.D"/>
                </whoReference>
                <onBehalfOfReference>
                    <reference value="https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7"/>
                    <display value="Some GP Clinic"/>
                </onBehalfOfReference>
            </agent>
        </Provenance>
    </contained>
    <status value="current"/>
    <mode value="changes"/>
    <title value="Reasonable Adjustment List"/>
    <code>
        <coding>
            <system value="http://snomed.info/sct"/>
            <code value="1094391000000102"/>
            <display value="Reasonable adjustments for health and care access"/>
        </coding>
    </code>
    <subject>
        <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
    </subject>
    <date value="2018-07-23T11:00:00+00:00"/>
    <entry>
        <deleted value="false"/>
        <date value="2018-07-23T11:00:00+00:00"/>
        <item>
            <reference value="urn:uuid:57f04652-6dd0-4135-a560-f9091b1b26fa"/>
        </item>
    </entry>
    <entry>
        <deleted value="false"/>
        <date value="2018-07-23T11:00:00+00:00"/>
        <item>
            <reference value="urn:uuid:8ce7de6b-1307-432d-8e96-ae6a613ca3e4"/>
        </item>
    </entry>
</List>

2.18 Create List Condition Response - json example

http response & headers

HTTP/1.1 201 Created
Date: Tue, 23 Jul 2018 11:00:00 GMT
Last-Modified:2018-07-23T11:00:00+00:00
Location: https://clinicals.spineservices.nhs.uk/STU3/List/130f416a-055d-4a5d-a453-2b7c2de3b57b/_history/f2fef5e5-c38a-408c-a9bc-2d49923928f8
ETag: W/"f2fef5e5-c38a-408c-a9bc-2d49923928f8”
Content-Type: application/fhir+json

http body

Create List Condition Response JSON Example

{
  "resourceType": "Condition",
  "fhir_comments": [
    " json example AAJSONPlaceholder.json "
  ]
}

Tags:

Use Case | Create RA Record

1 Create RA Record

Trigger:

System Scope:

Summary:

Pre

Main

2 Examples

2.1 Create Consent Resource - xml example

resource

Create Consent Resource XML Example

2.2 Create Consent Resource - json example

resource

Create Consent Resource JSON Example

2.3 Create Condition Resource - xml example

resource

Create Condition Resource XML Example

2.4 Create Condition Resource - json example

resource

Create Condition Resource JSON Example

2.5 Create Consent Request - xml example

http request & headers

http body

Create Consent Request XML Example

2.6 Create Consent Request - json example

http request & headers

http body

Create Consent Request JSON Example

2.7 Create Consent Response - xml example

http response & headers

http body

Create Consent Response XML Example

2.8 Create Consent Response - json example

http response & headers

http body

Create Consent Response JSON Example

2.9 Create Provenance Resource - xml example

resource

Create Provenance Resource XML Example

2.10 Create Provenance Resource - json example

resource

Create Provenance Resource JSON Example

2.11 Create List Resource - xml example

resource

Create List Resource XML Example

2.12 Create List Resource - json example

resource

Create List Resource JSON Example

2.13 Create List Condition Resource - xml example

resource

Create List Condition Resource XML Example

2.14 Create List Condition Resource - json example

resource

Create List Condition Resource JSON Example

2.15 Create List Condition Request - xml example

http request & headers

http body

Create List Condition Request XML Example

2.16 Create List Condition Request - json example

http request & headers

http body

Create List Condition Request JSON Example

2.17 Create List Condition Response - xml example

http response & headers

http body

Create List Condition Response XML Example

2.18 Create List Condition Response - json example

http response & headers

http body

Create List Condition Response JSON Example