Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Interaction | Create

Create operation describes interaction required to record a new Reasonable Adjustment Flag, an Adjustment or an Impairment on Spine via the FHIR® Reasonable Adjustments API

1 Create RARecord Use Case

1.1 Trigger:

GP initiates Reasonable Adjustment Flag discussion at annual health check

1.2 Pre-requisites:

Practioner Dr D. logged on w SmartCard/National Identity giving URPId (as SDS OrgPersonRole Identifier)
Patient Mrs M. PDS Trace > verified NHS#, Name, DoB, demographic data
ClientSystem searched and failed to find existing RARecord

1.3 System Scope:

ClientSystem includes GPSystem client, SCRa, 1-click etc.
ServerSystem includes Spine, PDS, SDS, FlagServer etc.

1.4 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 opens GPSystem, traces & verifies demographic info (internal call to PDS)
  • 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
  • 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
        • ClientSystem creates new CareConnect-RARecord-List-1 to reference / identify Impairment resourcesPatient declines to record any specific RAs
    • Practitioner commits RARecord
      • ClientSystem submits Create Consent request
        • ServerSystem services Create Consent request
          • ServerSystem submits Create Consent response
      • ClientSystem submits Create List transaction request
        • ServerSystem services Create List transaction request
          • ServerSystem submits Create List transaction response

2 Create RARecord Examples

http request

POST https://clinicals.spineservices.nhs.uk/STU3/Consent HTTP/1.1

body

Newly created RARecord-Consent-1 resource:

RARecord-CreateConsentRequestBody-example XML Example

<!-- CreateConsentRequestBody-example.xml -->
<Consent xmlns="http://hl7.org/fhir">
	<id value="618f4319-9c82-4bd9-adef-5155abf0c5ba"/>
	<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/CodeSystem-RARecord-ProxyRole-1"/>
                <code value="lpa"/>
                <display value="Lasting power of attorney personal welfare"/>
            </coding>
        </valueCodeableConcept>
	</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>
		<identifier>
            <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
        </identifier>
	</patient>
	<!-- these are directly lifted from National Data Opt Out. Will need either a general set or specific values for Reasonable Adjustments -->
	<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>

RARecord-CreateConsentRequestBody-example JSON Example

{
  "resourceType": "Consent",
  "id": "618f4319-9c82-4bd9-adef-5155abf0c5ba",
  "fhir_comments": [
    " CreateConsentRequestBody-example.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/CodeSystem-RARecord-ProxyRole-1",
            "code": "lpa",
            "display": "Lasting power of attorney personal welfare"
          }
        ]
      }
    }
  ],
  "status": "active",
  "category": [
    {
      "coding": [
        {
          "system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1",
          "code": "reasonable adjustments flag",
          "display": "Reasonable Adjustments Flag"
        }
      ]
    }
  ],
  "patient": {
    "identifier": {
      "system": "https://fhir.nhs.uk/Id/nhs-number",
      "value": "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"
    }
  ]
}

headers

Client systems SHALL carry the security HTTP headers as defined on the Security page.

Client systems SHALL carry an Access token in the HTTP authorisation header (as an oAuth Bearer Token). See the API security page for more details.

http response

FHIR Reasonable Adjustments API requests are to follow standard Spine Core response and error handling patterns. Details of the handling patterns and error codes are found on their Error handling pages

body

RARecord-CreateConsentResponseBody-example XML Example

<!-- CreateConsentResponseBody-example.xml -->
<!-- RARecord-Consent-1 example using a Legal Proxy -->
<Consent xmlns="http://hl7.org/fhir">
    <!-- temporary id replaced with permanent logical identifier (here, and where referenced) -->
    <id value="f1dc0ac6-45ff-4d2b-bf91-793971e3e286"/>
    <meta>
        <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="2016-03-01T10:05:33+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>
        <identifier>
            <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
        </identifier>
    </patient>
    <!-- these are directly lifted from National Data Opt Out. Will need either a general set or specific values for Reasonable Adjustments -->
    <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>

RARecord-CreateConsentResponseBody-example JSON Example

{
  "resourceType": "Consent",
  "id": "f1dc0ac6-45ff-4d2b-bf91-793971e3e286",
  "_id": {
    "fhir_comments": [
      " temporary id replaced with permanent logical identifier (here, and where referenced) "
    ]
  },
  "fhir_comments": [
    " CreateConsentResponseBody-example.xml ",
    " RARecord-Consent-1 example using a Legal Proxy "
  ],
  "meta": {
    "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": "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": {
    "identifier": {
      "system": "https://fhir.nhs.uk/Id/nhs-number",
      "value": "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"
    }
  ]
}

headers

Client systems SHALL carry the security HTTP headers as defined on the Security page.

2.3 Create List Transaction Request

http request

Transaction handler is at the flagserver base URL

POST https://clinicals.spineservices.nhs.uk/STU3 HTTP/1.1

body

RARecord-CreateListTransactionRequestBody-example XML Example

<!-- CreateListTransactionRequestBody-example.xml -->
<Bundle xmlns="http://hl7.org/fhir">
  <id value="e96acfdc-daf9-4a2e-9e4e-93dc26d935e9"/> 
  <meta> 
    <lastUpdated value="2018-05-25T00:00:00Z"/> 
  </meta> 
  <type value="transaction"/> 
  <!--    now, each entry is an action to take in the transaction    -->
  <entry> 
    <fullUrl value="urn:uuid:ab31b09a-f175-4802-bab9-fe8efd720680"/> 
    <resource>
        <!-- payload resource in here -->
        <!-- there's an ordering to the resources entered see http://hl7.org/fhir/http.html#transaction -->
        <!-- CareConnect-RARecord-List-1 example -->
        <List>
            <id value="ab31b09a-f175-4802-bab9-fe8efd720680"/>
            <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>
                <identifier>
                    <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
                </identifier>
            </subject>
            <date value="2018-05-25T00:00:00Z"/>
            <entry>
                <deleted value="false"/>
                <date value="2018-05-25T00:00:00Z"/>
                <item>
                    <!-- reference to a successfully written Condition available at referred endpoint.  -->
                    <reference value="urn:uuid:334ee6a9-cf05-4908-aebc-6972c49fd719"/>
                </item>
            </entry>
        </List>
    </resource>
  <!--    now, details about the action to take with the resource    -->
    <request> 
    <!--    POST to [base]/Patient - that's a create    -->
      <method value="POST"/> 
    <!--    actually, in a transaction, you don't specify the [base], 
         so [base]/Patient becomes just 'Patient':    -->
      <url value="List"/> 
    </request> 
  </entry>
  <entry> 
    <fullUrl value="urn:uuid:334ee6a9-cf05-4908-aebc-6972c49fd719"/> 
    <resource>
        <!-- payload resource in here -->
        <!-- there's an ordering to the resources entered see http://hl7.org/fhir/http.html#transaction -->
        <Condition>
            <id value="334ee6a9-cf05-4908-aebc-6972c49fd719"/>
            <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/CodeSystem-RARecord-AccessibleInformationAdjustments-1"/>
                    <code value="requiresinformationineasyread"/>
                    <display value="Requires information in Easyread"/>
                </coding>
            </code>
            <subject>
                <identifier>
                    <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
                </identifier>
            </subject>
        </Condition>
    </resource>
  <!--    now, details about the action to take with the resource    -->
    <request> 
    <!--    POST to [base]/Patient - that's a create    -->
      <method value="POST"/> 
    <!--    actually, in a transaction, you don't specify the [base], 
         so [base]/Patient becomes just 'Patient':    -->
      <url value="Condition"/> 
    </request> 
  </entry>
</Bundle>

RARecord-CreateListTransactionRequestBody-example JSON Example

{
  "resourceType": "Bundle",
  "id": "e96acfdc-daf9-4a2e-9e4e-93dc26d935e9",
  "fhir_comments": [
    " CreateListTransactionRequestBody-example.xml "
  ],
  "meta": {
    "lastUpdated": "2018-05-25T00:00:00Z"
  },
  "type": "transaction",
  "entry": [
    {
      "fhir_comments": [
        "    now, each entry is an action to take in the transaction    "
      ],
      "fullUrl": "urn:uuid:ab31b09a-f175-4802-bab9-fe8efd720680",
      "resource": {
        "resourceType": "List",
        "fhir_comments": [
          " payload resource in here ",
          " there's an ordering to the resources entered see http://hl7.org/fhir/http.html#transaction ",
          " CareConnect-RARecord-List-1 example "
        ],
        "meta": {
          "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": {
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "999999998"
          }
        },
        "date": "2018-05-25T00:00:00Z",
        "entry": [
          {
            "deleted": false,
            "date": "2018-05-25T00:00:00Z",
            "item": {
              "reference": "urn:uuid:334ee6a9-cf05-4908-aebc-6972c49fd719",
              "_reference": {
                "fhir_comments": [
                  " reference to a successfully written Condition available at referred endpoint.  "
                ]
              }
            }
          }
        ]
      },
      "request": {
        "fhir_comments": [
          "    now, details about the action to take with the resource    "
        ],
        "method": "POST",
        "_method": {
          "fhir_comments": [
            "    POST to [base]/Patient - that's a create    "
          ]
        },
        "url": "List",
        "_url": {
          "fhir_comments": [
            "    actually, in a transaction, you don't specify the [base],so [base]/Patient becomes just 'Patient':    "
          ]
        }
      }
    },
    {
      "fullUrl": "urn:uuid:334ee6a9-cf05-4908-aebc-6972c49fd719",
      "resource": {
        "resourceType": "Condition",
        "fhir_comments": [
          " payload resource in here ",
          " there's an ordering to the resources entered see http://hl7.org/fhir/http.html#transaction "
        ],
        "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/CodeSystem-RARecord-AccessibleInformationAdjustments-1",
              "code": "requiresinformationineasyread",
              "display": "Requires information in Easyread"
            }
          ]
        },
        "subject": {
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "999999998"
          }
        }
      },
      "request": {
        "fhir_comments": [
          "    now, details about the action to take with the resource    "
        ],
        "method": "POST",
        "_method": {
          "fhir_comments": [
            "    POST to [base]/Patient - that's a create    "
          ]
        },
        "url": "Condition",
        "_url": {
          "fhir_comments": [
            "    actually, in a transaction, you don't specify the [base],so [base]/Patient becomes just 'Patient':    "
          ]
        }
      }
    }
  ]
}

headers

Client systems SHALL carry the security HTTP headers as defined on the Security page.

2.4 Create List Transaction Response

http response

FHIR Reasonable Adjustments API requests are to follow standard Spine Core response and error handling patterns. Details of the handling patterns and error codes are found on their Error handling pages
Edge cases TBD and detailed during development

body

RARecord-CreateListTransactionResponseBody-example XML Example

<!-- CreateListTransactionResponseBody-example.xml -->
<Bundle xmlns="http://hl7.org/fhir">
  <id value="e96acfdc-daf9-4a2e-9e4e-93dc26d935e9"/> 
  <meta> 
    <lastUpdated value="2018-05-25T00:00:00Z"/> 
  </meta> 
  <type value="transaction-response"/> 
  <!--    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>
        <!-- payload resource in here -->
        <!-- there's an ordering to the resources entered see http://hl7.org/fhir/http.html#transaction -->
        <!-- CareConnect-RARecord-List-1 example -->
        <List>
            <id value="e00c5a85-d34f-4075-96ac-b787deb484b1"/>
            <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>
                <identifier>
                    <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
                </identifier>
            </subject>
            <date value="2018-05-25T00:00:00Z"/>
            <entry>
                <deleted value="false"/>
                <date value="2018-05-25T00:00:00Z"/>
                <item>
                    <!-- reference to a successfully written Condition available at referred endpoint.  -->
                    <reference value="https://clinicals.spineservices.nhs.uk/STU3/Condition/cba81f41-e57d-4b91-b59f-b5efc479faf9"/>
                </item>
            </entry>
        </List>
    </resource>
    <!--    details about the response to action to take with the resource    -->
    <response>
        <status value="201 Created"/>
        <location value="List/e00c5a85-d34f-4075-96ac-b787deb484b1"/>
        <!-- Servers SHOULD return an ETag header with the versionId (if versioning is supported) and a Last-Modified header  -->
        <etag value="W/&quot;0f7f7be2&quot;"/>
        <lastModified value="2018-05-25T00:00:01Z"/>
    </response>
  </entry>
  <entry> 
    <fullUrl value="https://clinicals.spineservices.nhs.uk/STU3/Condition/cba81f41-e57d-4b91-b59f-b5efc479faf9"/> 
    <resource>
        <!-- payload resource in here -->
        <!-- there's an ordering to the resources entered see http://hl7.org/fhir/http.html#transaction -->
        <Condition>
            <id value="57f04652-6dd0-4135-a560-f9091b1b26fa"/>
            <meta>
                <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="2016-03-01T10:05:33+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-AccessibleInformationAdjustments-1"/>
                    <code value="requiresinformationineasyread"/>
                    <display value="Requires information in Easyread"/>
                </coding>
            </code>
            <subject>
                <identifier>
                    <reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
                </identifier>
            </subject>
        </Condition>
    </resource>
    <!--    details about the response to action to take with the resource    -->
    <response>
        <status value="201 Created"/>
        <location value="Condition/cba81f41-e57d-4b91-b59f-b5efc479faf9"/>
        <!-- Servers SHOULD return an ETag header with the versionId (if versioning is supported) and a Last-Modified header  -->
        <etag value="W/&quot;919efe05&quot;"/>
        <lastModified value="2018-05-25T00:00:01Z"/>
    </response>
  </entry>
</Bundle>

RARecord-CreateListTransactionResponseBody-example JSON Example

{
  "resourceType": "Bundle",
  "id": "e96acfdc-daf9-4a2e-9e4e-93dc26d935e9",
  "fhir_comments": [
    " CreateListTransactionResponseBody-example.xml "
  ],
  "meta": {
    "lastUpdated": "2018-05-25T00:00:00Z"
  },
  "type": "transaction-response",
  "entry": [
    {
      "fhir_comments": [
        "    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": [
          " payload resource in here ",
          " there's an ordering to the resources entered see http://hl7.org/fhir/http.html#transaction ",
          " CareConnect-RARecord-List-1 example "
        ],
        "meta": {
          "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": {
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "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.  "
                ]
              }
            }
          }
        ]
      },
      "response": {
        "fhir_comments": [
          "    details about the response to action to take with the resource    "
        ],
        "status": "201 Created",
        "location": "List/e00c5a85-d34f-4075-96ac-b787deb484b1",
        "etag": "W/\"0f7f7be2\"",
        "_etag": {
          "fhir_comments": [
            " Servers SHOULD return an ETag header with the versionId (if versioning is supported) and a Last-Modified header  "
          ]
        },
        "lastModified": "2018-05-25T00:00:01Z"
      }
    },
    {
      "fullUrl": "https://clinicals.spineservices.nhs.uk/STU3/Condition/cba81f41-e57d-4b91-b59f-b5efc479faf9",
      "resource": {
        "resourceType": "Condition",
        "id": "cba81f41-e57d-4b91-b59f-b5efc479faf9",
        "fhir_comments": [
          " payload resource in here ",
          " there's an ordering to the resources entered see http://hl7.org/fhir/http.html#transaction "
        ],
        "meta": {
          "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": "57f04652-6dd0-4135-a560-f9091b1b26fa"
              }
            ],
            "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-AccessibleInformationAdjustments-1",
              "code": "requiresinformationineasyread",
              "display": "Requires information in Easyread"
            }
          ]
        },
        "subject": {
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "999999998"
          }
        }
      },
      "response": {
        "fhir_comments": [
          "    details about the response to action to take with the resource    "
        ],
        "status": "201 Created",
        "location": "Condition/cba81f41-e57d-4b91-b59f-b5efc479faf9",
        "etag": "W/\"919efe05\"",
        "_etag": {
          "fhir_comments": [
            " Servers SHOULD return an ETag header with the versionId (if versioning is supported) and a Last-Modified header  "
          ]
        },
        "lastModified": "2018-05-25T00:00:01Z"
      }
    }
  ]
}

headers

Client systems SHALL carry the security HTTP headers as defined on the Security page.


All content is available under the Open Government Licence v3.0, except where otherwise stated