Interaction | Read | FHIR® Reasonable Adjustments API

Read describes the interaction required to request and retrieve (and display) a Reasonable Adjustment Flag 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 Read RA Record

Trigger:

Mrs M is referred to an inpatient procedure.
Presence of RA Flag triggers pre-operation appointment with Learning Disability Nurse N.
Nurse N retrieves Mrs M’s RA Record to inform discussion of her situation.

System Scope:

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

Summary:

Patient has an RA Flag; Practitioner requests record.

Pre

Patient arrives at pre-operation appointment
Practitioner Nrs N. is logged on with SmartCard/National Identity
- Gives User Role Profile Identifier [URPId}
Patient Mrs M. has been PDS Traced
- Gives verified NHS#, Name, DoB demographic data

Main

Practitioner retrieves Patient’s RARecord.
- ClientSystem queries ServerSystem to retrieve RARecord
  - ClientSystem submits Read Consent request (xml) (json)
    - ServerSystem submits Read Consent response (xml) (json)
  - ClientSystem submits Read Flag request (xml) (json)
    - ServerSystem submits Read Flag response (xml) (json)
  - ClientSystem submits Read List request (xml) (json)
    - ServerSystem submits Read List response (xml) (json)
  - ClientSystem submits Read Conditions request (xml) (json)
    - ServerSystem submits Read Conditions response (xml) (json)

2 Interaction Examples

Examples of http requests, responses and payloads

http request & headers

GET https://clinicals.spineservices.nhs.uk/STU3/Consent?
 patient=999999998&
 status=active&
 category=https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1|reasonable%20adjustments%20flag&
 _format=xml HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Consent.read:1

http body

None

http request & headers

GET https://clinicals.spineservices.nhs.uk/STU3/Consent?
 patient=999999998&
 status=active&
 category=https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1|reasonable%20adjustments%20flag&
 _format=json HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Consent.read:1

http body

None

http response & headers

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

http body

<!-- ReadConsentResponseBody-example.xml -->
<Bundle xmlns="http://hl7.org/fhir">
    <id value="885dda30-e403-470f-956a-366c01d7eace"/>
    <meta>
        <profile value="http://hl7.org/fhir/bundle"/>
    </meta>
    <type value="searchset"/>
    <total value="1"/>
    <!--  all search sets include the self link - the statement of the query string searched on. -->
    <link>
        <relation value="self"/>
        <!-- note entity encoding in url -->
        <url value="https://clinicals.spineservices.nhs.uk/STU3/Consent?patient=999999998&amp;status=active&amp;category=https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1|reasonable%20adjustments%20flag&amp;_format=xml"/>
    </link>
    <!-- search pagination is also represented as a link set here if required -->
    <!--    now, each entry is an action to take in the transaction    -->
    <entry>
        <fullUrl value="https://clinicals.spineservices.nhs.uk/STU3/Consent/f1dc0ac6-45ff-4d2b-bf91-793971e3e286"/>
        <resource>
            <!-- found payload resource or operationOutcome in here -->
            <Consent>
                <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="Consent/f1dc0ac6-45ff-4d2b-bf91-793971e3e286"/>
                        </target>
                        <recorded value="2018-07-23T11:00:00+00:00"/>
                        <agent>
                            <role>
                                <coding>
                                    <system value="https://fhir.nhs.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/CodeSystem-RARecord-ProxyRole-1"/>
                            <code value="lpa"/>
                            <display value="Lasting power of attorney personal welfare"/>
                        </coding>
                    </valueCodeableConcept>
                </extension>
                <extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1">
                    <extension url="created">
                        <valueReference>
                            <reference value="#e0531fd1-212d-4a97-a7a9-d17cec9a6af2"/>
                        </valueReference>
                    </extension>
                </extension>
                <status value="active"/>
                <category>
                    <coding>
                        <system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1"/>
                        <code value="reasonable adjustments flag"/>
                        <display value="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>
        <search>
            <mode value="match"/>
        </search>
    </entry>
</Bundle>

http response & headers

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

http body

{
  "resourceType": "Bundle",
  "id": "2dce9ecf-75c6-4ad5-a770-4f035419c229",
  "fhir_comments": [
    " ReadConsentResponseBody-example.xml "
  ],
  "meta": {
    "profile": [
      "http://hl7.org/fhir/bundle"
    ]
  },
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "fhir_comments": [
        "    all search sets include the self link - the statement of the query string searched on. "
      ],
      "relation": "self",
      "url": "https://clinicals.spineservices.nhs.uk/STU3/Consent?patient=999999998&status=active&category=https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1|reasonable%20adjustments%20flag&_format=json",
      "_url": {
        "fhir_comments": [
          " note entity encoding in url "
        ]
      }
    }
  ],
  "entry": [
    {
      "fhir_comments": [
        " search pagination is also represented as a link set here if required ",
        "    now, each entry is an action to take in the transaction    "
      ],
      "fullUrl": "https://clinicals.spineservices.nhs.uk/STU3/Consent/f1dc0ac6-45ff-4d2b-bf91-793971e3e286",
      "resource": {
        "resourceType": "Consent",
        "id": "f1dc0ac6-45ff-4d2b-bf91-793971e3e286",
        "fhir_comments": [
          " found payload resource or operationOutcome in here "
        ],
        "meta": {
          "versionId": "1fc6e241-89f5-4ba4-b957-f025f21854c3",
          "lastUpdated": "2018-03-01T10:00:00+00:00",
          "profile": [
            "https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Consent-1"
          ]
        },
        "contained": [
          {
            "resourceType": "Provenance",
            "id": "e0531fd1-212d-4a97-a7a9-d17cec9a6af2",
            "meta": {
              "profile": [
                "https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"
              ]
            },
            "target": [
              {
                "reference": "Consent/f1dc0ac6-45ff-4d2b-bf91-793971e3e286"
              }
            ],
            "recorded": "2016-03-01T10:05:33+00:00",
            "agent": [
              {
                "role": [
                  {
                    "coding": [
                      {
                        "system": "https://fhir.nhs.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/CodeSystem-RARecord-ProxyRole-1",
                  "code": "lpa",
                  "display": "Lasting power of attorney personal welfare"
                }
              ]
            }
          },
          {
            "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1",
            "extension": [
              {
                "url": "created",
                "valueReference": {
                  "reference": "#e0531fd1-212d-4a97-a7a9-d17cec9a6af2"
                }
              }
            ]
          }
        ],
        "status": "active",
        "category": [
          {
            "coding": [
              {
                "system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1",
                "code": "reasonable adjustments flag",
                "display": "Reasonable Adjustments Flag"
              }
            ]
          }
        ],
        "patient": {
          "reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
        },
        "policy": [
          {
            "fhir_comments": [
              " these are directly lifted from National Data Opt Out. Will need either a general set or specific values for Reasonable Adjustments "
            ],
            "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"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

2.5 Read Flag request - xml example

http request & headers

GET https://clinicals.spineservices.nhs.uk/STU3/Flag?
 patient=999999998&
 status=active&
 category=https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1|reasonable%20adjustments%20flag&
 _format=xml HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Flag.read:1

http body

None

2.6 Read Flag request - json example

http request & headers

GET https://clinicals.spineservices.nhs.uk/STU3/Flag?
 patient=999999998&
 status=active&
 category=https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1|reasonable%20adjustments%20flag&
 _format=json HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Flag.read:1

http body

None

2.7 Read Flag response - xml example

http response & headers

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

http body

Read Flag response XML Example

<!-- ReadFlagResponseBody-example.xml -->
<Bundle xmlns="http://hl7.org/fhir">
    <id value="30e9a5d5-c037-42ed-9ee4-476add4d6b43"/>
    <meta>
        <profile value="http://hl7.org/fhir/bundle"/>
    </meta>
    <type value="searchset"/>
    <total value="0"/>
    <!--  all search sets include the self link - the statement of the query string searched on. -->
    <link>
        <relation value="self"/>
        <url value="https://clinicals.spineservices.nhs.uk/STU3/Flag?patient=999999998&amp;status=active&amp;category=https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1|reasonable%20adjustments%20flag&amp;_format=xml"/>
    </link>
</Bundle>

2.8 Read Flag response - json example

http response & headers

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

http body

Read Flag response JSON Example

{
  "resourceType": "Bundle",
  "id": "30e9a5d5-c037-42ed-9ee4-476add4d6b43",
  "fhir_comments": [
    " ReadFlagResponseBody-example.xml "
  ],
  "meta": {
    "profile": [
      "http://hl7.org/fhir/bundle"
    ]
  },
  "type": "searchset",
  "total": 0,
  "link": [
    {
      "fhir_comments": [
        "  all search sets include the self link - the statement of the query string searched on. "
      ],
      "relation": "self",
      "url": "https://clinicals.spineservices.nhs.uk/STU3/Flag?patient=999999998&status=active&category=https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1|reasonable%20adjustments%20flag&_format=json"
    }
  ]
}

2.9 Read List request - xml example

http request & headers

GET https://clinicals.spineservices.nhs.uk/STU3/List?
 patient=999999998&
 status=current&
 code=http://snomed.info/sct|1094391000000102&
 _format=xml HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:List.read:1

http body

None

2.10 Read List request - json example

http request & headers

GET https://clinicals.spineservices.nhs.uk/STU3/List?
 patient=999999998&
 status=current&
 code=http://snomed.info/sct|1094391000000102&
 _format=json HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:List.read:1

http body

None

2.11 Read List response - xml example

http response & headers

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

http body

Read List response XML Example

<!-- ReadListResponseBody-example.xml -->
<Bundle xmlns="http://hl7.org/fhir">
    <id value="b45afdbc-cce1-4623-8942-2ec3baf879e7"/>
    <meta>
        <profile value="http://hl7.org/fhir/bundle"/>
    </meta>
    <type value="searchset"/>
    <total value="1"/>
    <!--    all search sets include the self link - the statement of the query string searched on. -->
    <link>
        <relation value="self"/>
        <url value="https://clinicals.spineservices.nhs.uk/STU3/List?patient=999999998&amp;status=current&amp;code=http://snomed.info/sct|1094391000000102&amp;_format=xml"/>
   </link>
    <!-- search pagination is also represented as a link set here if required -->
    <!--    now, each entry is an action to take in the transaction    -->
    <entry>
        <fullUrl value="https://clinicals.spineservices.nhs.uk/STU3/List/e00c5a85-d34f-4075-96ac-b787deb484b1"/>
        <resource>
            <!-- found payload resource or operationOutcome in here -->
            <List>
                <id value="e00c5a85-d34f-4075-96ac-b787deb484b1"/>
                <meta>
                    <versionId value="5b703b55-cedc-4c19-b2aa-0666384eab1a"/>
                    <lastUpdated value="2018-07-23T11:00:01+00:00"/>
                    <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"/>
                <entry>
                    <deleted value="false"/>
                    <date value="2018-07-23T11:00:00+00:00"/>
                    <item>
                        <reference value="https://clinicals.spineservices.nhs.uk/STU3/Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"/>
                    </item>
                </entry>
            </List>
        </resource>
        <!--    optional details about the search, useful here to categorise matches vs includes or to mark a search failure (the search process MAY include an OperationOutcome in the search set) -->
        <search>
          <mode value="match"/>
        </search>
    </entry>
</Bundle>

2.12 Read List response - json example

http response & headers

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

http body

Read List response JSON Example

{
  "resourceType": "Bundle",
  "id": "b45afdbc-cce1-4623-8942-2ec3baf879e7",
  "fhir_comments": [
    " ReadListResponseBody-example.xml "
  ],
  "meta": {
    "profile": [
      "http://hl7.org/fhir/bundle"
    ]
  },
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "fhir_comments": [
        "    all search sets include the self link - the statement of the query string searched on. "
      ],
      "relation": "self",
      "url": "https://clinicals.spineservices.nhs.uk/STU3/List?patient=999999998&status=current&code=http://snomed.info/sct|1094391000000102&_format=json"
    }
  ],
  "entry": [
    {
      "fhir_comments": [
        " search pagination is also represented as a link set here if required ",
        "    now, each entry is an action to take in the transaction    "
      ],
      "fullUrl": "https://clinicals.spineservices.nhs.uk/STU3/List/e00c5a85-d34f-4075-96ac-b787deb484b1",
      "resource": {
        "resourceType": "List",
        "id": "e00c5a85-d34f-4075-96ac-b787deb484b1",
        "fhir_comments": [
          " found payload resource or operationOutcome in here "
        ],
        "meta": {
          "versionId": "0862dfb7-8806-4979-8fd2-8dc887a85ce7",
          "lastUpdated": "2018-03-01T10:00:00+00:00",
          "profile": [
            "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-List-1"
          ]
        },
        "status": "current",
        "mode": "changes",
        "title": "Reasonable Adjustment List",
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "1094391000000102",
              "display": "Reasonable adjustments for health and care access"
            }
          ]
        },
        "subject": {
          "reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
        },
        "date": "2018-05-25T00:00:00Z",
        "entry": [
          {
            "deleted": false,
            "date": "2018-05-25T00:00:00Z",
            "item": {
              "reference": "https://clinicals.spineservices.nhs.uk/STU3/Condition/cba81f41-e57d-4b91-b59f-b5efc479faf9",
              "_reference": {
                "fhir_comments": [
                  " reference to a successfully written Condition available at referred endpoint.  "
                ]
              }
            }
          }
        ]
      },
      "search": {
        "fhir_comments": [
          "    optional details about the search, useful here to categorise matches vs includes or to mark a search failure (the search process MAY include an OperationOutcome in the search set) "
        ],
        "mode": "match"
      }
    }
  ]
}

2.13 Read Conditions request - xml example

http request & headers

GET https://clinicals.spineservices.nhs.uk/STU3/Condition?
 _list=4c8d19af-7755-4954-93df-93c964ddf349&
 clinical-status=active&
 _format=xml HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Condition.read:1

http body

None

2.14 Read Conditions request - json example

http request & headers

GET https://clinicals.spineservices.nhs.uk/STU3/Condition?
 _list=4c8d19af-7755-4954-93df-93c964ddf349&
 clinical-status=active&
 _format=json HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Condition.read:1

http body

None

2.15 Read Conditions response - xml example

http response & headers

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

http body

Read Conditions response XML Example

<!-- ReadConditionResponseBody-example.xml -->
<Bundle xmlns="http://hl7.org/fhir">
    <id value="384824fc-62df-45bf-ac55-aab7cc0e4ffe"/>
     <meta>
        <profile value="http://hl7.org/fhir/bundle"/>
    </meta>
    <type value="searchset"/>
    <total value="1"/>
    <!--    all search sets include the self link - the statement of the query string searched on. -->
    <link>
        <relation value="self"/>
        <url value="https://clinicals.spineservices.nhs.uk/STU3/Condition?_list=4c8d19af-7755-4954-93df-93c964ddf349&amp;clinical-status=active&amp;_format=xml"/>
    </link>
    <entry>
        <fullUrl value="https://clinicals.spineservices.nhs.uk/STU3/Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"/>
        <resource>
            <!-- found payload resource or operationOutcome in here -->
             <Condition>
                <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>
                <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"/>
                        <agent>
                            <role>
                                <coding>
                                    <system value="https://fhir.nhs.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-Provenance-1">
                    <extension url="created">
                        <valueReference>
                            <reference value="#8ce7de6b-1307-432d-8e96-ae6a613ca3e4"/>
                        </valueReference>
                    </extension>
                </extension>
                <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/CodeSystem-RARecord-ConditionCode-1"/>
                        <code value="1855002"/>
                        <display value="Learning Disability(s)"/>
                    </coding>
                </code>
                <subject>
                    <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
                </subject>
            </Condition>
        </resource>
        <search>
            <mode value="match"/>
        </search>
    </entry>
</Bundle>

2.16 Read Conditions response - json example

http response & headers

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

http body

Read Conditions response JSON Example

{
  "resourceType": "Bundle",
  "id": "384824fc-62df-45bf-ac55-aab7cc0e4ffe",
  "fhir_comments": [
    " ReadConditionResponseBody-example.xml "
  ],
  "meta": {
    "profile": [
      "http://hl7.org/fhir/bundle"
    ]
  },
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "fhir_comments": [
        "    all search sets include the self link - the statement of the query string searched on. "
      ],
      "relation": "self",
      "url": "https://clinicals.spineservices.nhs.uk/STU3/Condition?_list=4c8d19af-7755-4954-93df-93c964ddf349&clinical-status=active&_format=json"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://clinicals.spineservices.nhs.uk/STU3/cba81f41-e57d-4b91-b59f-b5efc479faf9",
      "resource": {
        "resourceType": "Condition",
        "id": "cba81f41-e57d-4b91-b59f-b5efc479faf9",
        "fhir_comments": [
          " found payload resource or operationOutcome in here "
        ],
        "meta": {
          "versionId": "e36bfb0d-1cb9-47d0-bd44-15c56b0c11b4",
          "lastUpdated": "2018-03-01T10:00:00+00:00",
          "profile": [
            "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-Condition-1"
          ]
        },
        "contained": [
          {
            "resourceType": "Provenance",
            "id": "8ce7de6b-1307-432d-8e96-ae6a613ca3e4",
            "meta": {
              "profile": [
                "https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"
              ]
            },
            "target": [
              {
                "reference": "Condition/6c1ccd3f-765e-41d8-b5c0-2a0317908502"
              }
            ],
            "recorded": "2016-03-01T10:05:33+00:00",
            "agent": [
              {
                "role": [
                  {
                    "coding": [
                      {
                        "system": "https://fhir.nhs.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-Provenance-1",
            "extension": [
              {
                "url": "created",
                "valueReference": {
                  "reference": "#8ce7de6b-1307-432d-8e96-ae6a613ca3e4"
                }
              }
            ]
          }
        ],
        "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/CodeSystem-RARecord-ConditionCode-1",
              "code": "1855002",
              "display": "Learning Disability(s)"
            }
          ]
        },
        "subject": {
          "reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Tags:

Interaction | Read

1 Read RA Record

Trigger:

System Scope:

Summary:

Pre

Main

2 Interaction Examples

2.1 Read Consent request - xml example

http request & headers

http body

2.2 Read Consent request - json example

http request & headers

http body

2.3 Read Consent response - xml example

http response & headers

http body

Read Consent response XML Example

2.4 Read Consent response - json example

http response & headers

http body

Read Consent response JSON Example

2.5 Read Flag request - xml example

http request & headers

http body

2.6 Read Flag request - json example

http request & headers

http body

2.7 Read Flag response - xml example

http response & headers

http body

Read Flag response XML Example

2.8 Read Flag response - json example

http response & headers

http body

Read Flag response JSON Example

2.9 Read List request - xml example

http request & headers

http body

2.10 Read List request - json example

http request & headers

http body

2.11 Read List response - xml example

http response & headers

http body

Read List response XML Example

2.12 Read List response - json example

http response & headers

http body

Read List response JSON Example

2.13 Read Conditions request - xml example

http request & headers

http body

2.14 Read Conditions request - json example

http request & headers

http body

2.15 Read Conditions response - xml example

http response & headers

http body

Read Conditions response XML Example

2.16 Read Conditions response - json example

http response & headers

http body

Read Conditions response JSON Example