Update operation describes interaction required to update a Reasonable Adjustment Flag, an Adjustment or an Impairment 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 Add Adjustment; Add Impairment
Trigger:
Pre-operative appointment with Learning Disability Nurse N.
System Scope:
ClientSystem includes GPSystem client, SCRa, 1-click etc.
ServerSystem includes Spine, PDS, SDS, FlagServer etc.
Summary:
During appointment Nurse discusses RA Record, Patient requests recording of ‘Easy Read’ Adjustment, addition of ‘Mental Health Disability w supporting text’ Impairment.
Pre
- Practitioner logged into ClientSystem, traces & verifies demographic info
- Practitioner opens Patient’s RARecord
- System retrieves and displays RARecord for Patient’s NHS
- Practitioner discusses RARecord and RA with Patient
- Patient agrees to add Adjustment ‘Easy Read’
- Patient agrees to add Impairment ‘Mental Health Disability w supporting text’
Main
- Patient agrees to add Adjustment ‘Easy Read’
- Patient agrees to add Impairment ‘Mental Health Disability’ with supporting text
- Practitioner commits RARecord
2 New Resource Examples
Examples of client-side resources as they are created. i.e. before they are written to Spine.
2.1 New Adjustment Resource - xml example
New Adjustment Resource XML Example
<!-- xml example file
AddExample-NewAdjustmentResource.xml-->
<Flag xmlns="http://hl7.org/fhir">
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"/>
</meta>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1">
<valueCodeableConcept>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1"/>
<code value="comms"/>
<display value="Communication"/>
</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>
<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>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Flag>
2.2 New Adjustment Resource - json example
New Adjustment Resource JSON Example
{
"resourceType": "Flag",
"fhir_comments": [
" xml example fileAddExample-NewAdjustmentResource.xml"
],
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"
]
},
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1",
"code": "comms",
"display": "Communication"
}
]
}
}
],
"status": "active",
"category": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1",
"code": "reasonable adjustments flag",
"display": "Reasonable Adjustments Flag"
}
]
},
"code": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AccessibleInformationAdjustments-1",
"code": "requiresinformationineasyread",
"display": "Requires information in Easyread"
}
]
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
2.3 New Impairment Resource - xml example
New Impairment Resource XML Example
<!-- xml example file
AddExample-NewImpairmentResource.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/CodeSystem-RARecord-ConditionCode-1"/>
<code value="720821000000105"/>
<display value="Mental health condition(s)"/>
</coding>
<text value="Patient diagnosed with Stranger anxiety (disorder). Consider home-visit"/>
</code>
<subject>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Condition>
2.4 New Impairment Resource - json example
New Impairment Resource JSON Example
{
"resourceType": "Condition",
"fhir_comments": [
" xml example fileAddExample-NewImpairmentResource.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/CodeSystem-RARecord-ConditionCode-1",
"code": "720821000000105",
"display": "Mental health condition(s)"
}
],
"text": "Patient diagnosed with Stranger anxiety (disorder). Consider home-visit"
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
2.5 Updated List Resource - xml example
Updated List Resource XML Example
<!-- xml example file
AddExample-UpdatedListResource.xml -->
<List xmlns="http://hl7.org/fhir">
<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>
<entry>
<deleted value="false"/>
<date value="2018-07-24T11:00:00+00:00"/>
<item>
<reference value="https://clinicals.spineservices.nhs.uk/STU3/Condition/13aec731-02c5-42a2-b863-de889479e777"/>
</item>
</entry>
</List>
2.6 Updated List Resource - json example
Updated List Resource JSON Example
{
"resourceType": "List",
"id": "e00c5a85-d34f-4075-96ac-b787deb484b1",
"fhir_comments": [
" xml example fileAddExample-UpdatedListResource.xml "
],
"meta": {
"versionId": "5b703b55-cedc-4c19-b2aa-0666384eab1a",
"lastUpdated": "2018-07-23T11:00:01+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-07-23T11:00:00+00:00",
"entry": [
{
"deleted": false,
"date": "2018-07-23T11:00:00+00:00",
"item": {
"reference": "https://clinicals.spineservices.nhs.uk/STU3/Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"
}
},
{
"deleted": false,
"date": "2018-07-24T11:00:00+00:00",
"item": {
"reference": "https://clinicals.spineservices.nhs.uk/STU3/Condition/13aec731-02c5-42a2-b863-de889479e777"
}
}
]
}
3 Interaction Examples
Examples of http requests, responses and payloads
3.1 Create Flag Request - xml example
http request & headers
POST https://clinicals.spineservices.nhs.uk/STU3/Flag HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Flag.write:1
http body
Create Flag Request XML Example
<!-- xml example file
AddExample-CreateFlagRequest.xml -->
<Flag xmlns="http://hl7.org/fhir">
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"/>
</meta>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1">
<valueCodeableConcept>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1"/>
<code value="comms"/>
<display value="Communication"/>
</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>
<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>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Flag>
3.2 Create Flag Request - json example
http request & headers
POST https://clinicals.spineservices.nhs.uk/STU3/Flag HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Flag.write:1
http body
Create Flag Request JSON Example
{
"resourceType": "Flag",
"fhir_comments": [
" xml example fileAddExample-CreateFlagRequest.xml "
],
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"
]
},
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1",
"code": "comms",
"display": "Communication"
}
]
}
}
],
"status": "active",
"category": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1",
"code": "reasonable adjustments flag",
"display": "Reasonable Adjustments Flag"
}
]
},
"code": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AccessibleInformationAdjustments-1",
"code": "requiresinformationineasyread",
"display": "Requires information in Easyread"
}
]
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
3.3 Create Flag Response - xml example
http request & headers
HTTP/1.1 201 Created
Date: Wed, 24 Jul 2018 10:01:00 GMT
Last-Modified:2018-07-24T10:01:00+00:00
Location: https://clinicals.spineservices.nhs.uk/STU3/Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186/_history/aa755bd6-2be9-4971-972a-6724879c5cb1
ETag: W/"aa755bd6-2be9-4971-972a-6724879c5cb1”
Content-Type: application/fhir+xml
http body
Create Flag Response XML Example
<!-- xml example file
AddExample-CreateFlagResponse.xml -->
<Flag xmlns="http://hl7.org/fhir">
<id value="2acb0536-0a8f-48c9-8a2f-6ee82860f186"/>
<meta>
<versionId value="aa755bd6-2be9-4971-972a-6724879c5cb1"/>
<lastUpdated value="2018-07-24T10:01:00+00:00"/>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"/>
</meta>
<contained>
<Provenance>
<id value="43124f67-b09d-453d-b889-a5e2e8780b9e"/>
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
</meta>
<target>
<reference value="Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186"/>
</target>
<recorded value="2018-07-24T10:05:33+00:00"/>
<agent>
<role>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1"/>
<code value="R1974"/>
<display value="Community Learning Disabilities Nurse"/>
</coding>
</role>
<whoReference>
<reference value="https://sds.spineservices.nhs.uk/STU3/Practitioner/4tr6ee6a9"/>
<display value="Nurse N"/>
</whoReference>
<onBehalfOfReference>
<reference value="https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7"/>
<display value="Some Hospital Learning Disability Support Department"/>
</onBehalfOfReference>
</agent>
</Provenance>
</contained>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1">
<extension url="created">
<valueReference>
<reference value="#43124f67-b09d-453d-b889-a5e2e8780b9e"/>
</valueReference>
</extension>
</extension>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1">
<valueCodeableConcept>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1"/>
<code value="comms"/>
<display value="Communication"/>
</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>
<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>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Flag>
3.4 Create Flag Response - json example
http request & headers
HTTP/1.1 201 Created
Date: Wed, 24 Jul 2018 10:01:00 GMT
Last-Modified:2018-07-24T10:01:00+00:00
Location: https://clinicals.spineservices.nhs.uk/STU3/Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186/_history/aa755bd6-2be9-4971-972a-6724879c5cb1
ETag: W/"aa755bd6-2be9-4971-972a-6724879c5cb1”
Content-Type: application/fhir+json
http body
Create Flag Response JSON Example
{
"resourceType": "Flag",
"id": "2acb0536-0a8f-48c9-8a2f-6ee82860f186",
"fhir_comments": [
" xml example fileAddExample-CreateFlagResponse.xml "
],
"meta": {
"versionId": "aa755bd6-2be9-4971-972a-6724879c5cb1",
"lastUpdated": "2018-07-24T10:01:00+00:00",
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"
]
},
"contained": [
{
"resourceType": "Provenance",
"id": "43124f67-b09d-453d-b889-a5e2e8780b9e",
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"
]
},
"target": [
{
"reference": "Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186"
}
],
"recorded": "2018-07-24T10:05:33+00:00",
"agent": [
{
"role": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1",
"code": "R1974",
"display": "Community Learning Disabilities Nurse"
}
]
}
],
"whoReference": {
"reference": "https://sds.spineservices.nhs.uk/STU3/Practitioner/4tr6ee6a9",
"display": "Nurse N"
},
"onBehalfOfReference": {
"reference": "https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7",
"display": "Some Hospital Learning Disability Support Department"
}
}
]
}
],
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1",
"extension": [
{
"url": "created",
"valueReference": {
"reference": "#43124f67-b09d-453d-b889-a5e2e8780b9e"
}
}
]
},
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1",
"code": "comms",
"display": "Communication"
}
]
}
}
],
"status": "active",
"category": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1",
"code": "reasonable adjustments flag",
"display": "Reasonable Adjustments Flag"
}
]
},
"code": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AccessibleInformationAdjustments-1",
"code": "requiresinformationineasyread",
"display": "Requires information in Easyread"
}
]
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
3.5 Create Condition Request - xml example
http request & headers
POST https://clinicals.spineservices.nhs.uk/STU3/Condition HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Condition.write:1
http body
Create Condition Request XML Example
<!-- xml example file
AddExample-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/CodeSystem-RARecord-ConditionCode-1"/>
<code value="720821000000105"/>
<display value="Mental health condition(s)"/>
</coding>
<text value="Patient diagnosed with Stranger anxiety (disorder). Consider home-visit"/>
</code>
<subject>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Condition>
3.6 Create Condition Request - json example
http request & headers
POST https://clinicals.spineservices.nhs.uk/STU3/Condition HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Condition.write:1
http body
Create Condition Request JSON Example
{
"resourceType": "Condition",
"fhir_comments": [
" xml example fileAddExample-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/CodeSystem-RARecord-ConditionCode-1",
"code": "720821000000105",
"display": "Mental health condition(s)"
}
],
"text": "Patient diagnosed with Stranger anxiety (disorder). Consider home-visit"
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
3.7 Create Condition Response - xml example
http request & headers
HTTP/1.1 201 Created
Date: Wed, 24 Jul 2018 10:01:00 GMT
Last-Modified: 2018-07-24T10:01:00+00:00
Location: https://clinicals.spineservices.nhs.uk/STU3/Condition/6be8bee9-e727-4564-a904-49507576f8be/_history/a9b91e41-30ad-43a4-a2da-79b9be622169
ETag: W/"a9b91e41-30ad-43a4-a2da-79b9be622169”
Content-Type: application/fhir+xml
http body
Create Condition Response XML Example
<!-- xml example file
AddExample-CreateConditionResponse.xml -->
<Condition xmlns="http://hl7.org/fhir">
<id value="6be8bee9-e727-4564-a904-49507576f8be"/>
<meta>
<versionId value="a9b91e41-30ad-43a4-a2da-79b9be622169"/>
<lastUpdated value="2018-07-24T10:01:00+00:00"/>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-Condition-1" />
</meta>
<contained>
<Provenance>
<id value="fe71140b-3a30-45a3-b492-695b5f5e3717"/>
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
</meta>
<target>
<reference value="Condition/6be8bee9-e727-4564-a904-49507576f8be"/>
</target>
<recorded value="2018-07-24T10:05:33+00:00"/>
<agent>
<role>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1"/>
<code value="R1974"/>
<display value="Community Learning Disabilities Nurse"/>
</coding>
</role>
<whoReference>
<reference value="https://sds.spineservices.nhs.uk/STU3/Practitioner/4tr6ee6a9"/>
<display value="Nurse N"/>
</whoReference>
<onBehalfOfReference>
<reference value="https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7"/>
<display value="Some Hospital Learning Disability Support Department"/>
</onBehalfOfReference>
</agent>
</Provenance>
</contained>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1">
<extension url="created">
<valueReference>
<reference value="#fe71140b-3a30-45a3-b492-695b5f5e3717"/>
</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="720821000000105"/>
<display value="Mental health condition(s)"/>
</coding>
<text value="Patient diagnosed with Stranger anxiety (disorder). Consider home-visit"/>
</code>
<subject>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Condition>
3.8 Create Condition Response - json example
http request & headers
HTTP/1.1 201 Created
Date: Wed, 24 Jul 2018 10:01:00 GMT
Last-Modified: 2018-07-24T10:01:00+00:00
Location: https://clinicals.spineservices.nhs.uk/STU3/Condition/6be8bee9-e727-4564-a904-49507576f8be/_history/a9b91e41-30ad-43a4-a2da-79b9be622169
ETag: W/"a9b91e41-30ad-43a4-a2da-79b9be622169”
Content-Type: application/fhir+json
http body
Create Condition Response JSON Example
{
"resourceType": "Condition",
"id": "6be8bee9-e727-4564-a904-49507576f8be",
"fhir_comments": [
" xml example fileAddExample-CreateConditionResponse.xml "
],
"meta": {
"versionId": "a9b91e41-30ad-43a4-a2da-79b9be622169",
"lastUpdated": "2018-07-24T10:01:00+00:00",
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-Condition-1"
]
},
"contained": [
{
"resourceType": "Provenance",
"id": "fe71140b-3a30-45a3-b492-695b5f5e3717",
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"
]
},
"target": [
{
"reference": "Condition/6be8bee9-e727-4564-a904-49507576f8be"
}
],
"recorded": "2018-07-24T10:05:33+00:00",
"agent": [
{
"role": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1",
"code": "R1974",
"display": "Community Learning Disabilities Nurse"
}
]
}
],
"whoReference": {
"reference": "https://sds.spineservices.nhs.uk/STU3/Practitioner/4tr6ee6a9",
"display": "Nurse N"
},
"onBehalfOfReference": {
"reference": "https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7",
"display": "Some Hospital Learning Disability Support Department"
}
}
]
}
],
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1",
"extension": [
{
"url": "created",
"valueReference": {
"reference": "#fe71140b-3a30-45a3-b492-695b5f5e3717"
}
}
]
}
],
"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": "720821000000105",
"display": "Mental health condition(s)"
}
],
"text": "Patient diagnosed with Stranger anxiety (disorder). Consider home-visit"
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
3.9 Update List Request - xml example
http request & headers
PUT https://clinicals.spineservices.nhs.uk/STU3/List/e00c5a85-d34f-4075-96ac-b787deb484b1 HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:List.write:1
If-Match: W/"5b703b55-cedc-4c19-b2aa-0666384eab1a"
http body
Update List Request XML Example
<!-- xml example file
AddExample-UpdateListRequest.xml -->
<List xmlns="http://hl7.org/fhir">
<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>
<entry>
<deleted value="false"/>
<date value="2018-07-24T11:00:00+00:00"/>
<item>
<reference value="https://clinicals.spineservices.nhs.uk/STU3/Condition/13aec731-02c5-42a2-b863-de889479e777"/>
</item>
</entry>
</List>
3.10 Update List Request - json example
http request & headers
PUT https://clinicals.spineservices.nhs.uk/STU3/List/e00c5a85-d34f-4075-96ac-b787deb484b1 HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 654321123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:List.write:1
If-Match: W/"5b703b55-cedc-4c19-b2aa-0666384eab1a"
http body
Update List Request JSON Example
{
"resourceType": "List",
"id": "e00c5a85-d34f-4075-96ac-b787deb484b1",
"fhir_comments": [
" xml example fileAddExample-UpdateListRequest.xml "
],
"meta": {
"versionId": "5b703b55-cedc-4c19-b2aa-0666384eab1a",
"lastUpdated": "2018-07-23T11:00:01+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-07-23T11:00:00+00:00",
"entry": [
{
"deleted": false,
"date": "2018-07-23T11:00:00+00:00",
"item": {
"reference": "https://clinicals.spineservices.nhs.uk/STU3/Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"
}
},
{
"deleted": false,
"date": "2018-07-24T11:00:00+00:00",
"item": {
"reference": "https://clinicals.spineservices.nhs.uk/STU3/Condition/13aec731-02c5-42a2-b863-de889479e777"
}
}
]
}
3.11 Update List Response - xml example
http request & headers
HTTP/1.1 200 OK
Date: Tue, 24 Jul 2018 10:02:00 GMT
Last-Modified:2018-07-24T10:02:00+00:00
ETag: W/"a8cbe427-7195-482e-81ff-b5809db6d08c”
Content-Type: application/fhir+xml
http body
Update List Response XML Example
<!-- xml example file
AddExample-UpdateListResponse.xml -->
<List xmlns="http://hl7.org/fhir">
<id value="e00c5a85-d34f-4075-96ac-b787deb484b1"/>
<meta>
<versionId value="a8cbe427-7195-482e-81ff-b5809db6d08c"/>
<lastUpdated value="2018-07-24T11: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>
<entry>
<deleted value="false"/>
<date value="2018-07-24T11:00:00+00:00"/>
<item>
<reference value="https://clinicals.spineservices.nhs.uk/STU3/Condition/13aec731-02c5-42a2-b863-de889479e777"/>
</item>
</entry>
</List>
3.12 Update List Response - json example
http request & headers
HTTP/1.1 200 OK
Date: Tue, 24 Jul 2018 10:02:00 GMT
Last-Modified:2018-07-24T10:02:00+00:00
ETag: W/"a8cbe427-7195-482e-81ff-b5809db6d08c”
Content-Type: application/fhir+json
http body
Update List Response JSON Example
{
"resourceType": "List",
"id": "e00c5a85-d34f-4075-96ac-b787deb484b1",
"fhir_comments": [
" xml example fileAddExample-UpdateListResponse.xml "
],
"meta": {
"versionId": "a8cbe427-7195-482e-81ff-b5809db6d08c",
"lastUpdated": "2018-07-24T11:00:01+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-07-23T11:00:00+00:00",
"entry": [
{
"deleted": false,
"date": "2018-07-23T11:00:00+00:00",
"item": {
"reference": "https://clinicals.spineservices.nhs.uk/STU3/Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"
}
},
{
"deleted": false,
"date": "2018-07-24T11:00:00+00:00",
"item": {
"reference": "https://clinicals.spineservices.nhs.uk/STU3/Condition/13aec731-02c5-42a2-b863-de889479e777"
}
}
]
}
4 Update Adjustment
Trigger:
Post-operative appointment with GP. Patient requests change of ‘Easy Read’ Adjustment to ‘Large Print’
System Scope:
ClientSystem includes GPSystem client, SCRa, 1-click etc.
ServerSystem includes Spine, PDS, SDS, FlagServer etc.
Summary:
During appointment GP discusses RA Record, Patient requests change of Reasonable Adjustment ‘Easy Read’ to ‘Large Print’.
Practitioner updates (soft deletes) existing ‘Easy Read’ Adjustment, records Removal reason ‘Entered in error’
Practitioner creates new ‘Large Print’ Adjustment.
Pre
- Practitioner logged into ClientSystem, traces & verifies demographic info
- Practitioner opens Patient’s RARecord
- System retrieves and displays RARecord for Patient’s NHS
- Practitioner discusses RARecord and RA with Patient, Patient doesn’t like Easy Read
- Practitioner discusses options w Patient, Patient agrees change RA ‘Easy Read’ to ‘Large Print’
Main
- Practitioner removes (soft deletes) existing ‘Easy Read’ Adjustment, records Removal reason ‘Entered in error’;
- Practitioner commits RARecord
- Practitioner records new ‘Large Print’ Adjustment
- Practitioner commits RARecord
5 New and Updated Resource Examples
Examples of client-side resources.
5.1 Updated Flag Resource - xml example
Updated Flag Resource XML Example
<!-- xml example file
UpdateExample-UpdatedFlagResource.xml -->
<Flag xmlns="http://hl7.org/fhir">
<id value="2acb0536-0a8f-48c9-8a2f-6ee82860f186"/>
<meta>
<versionId value="aa755bd6-2be9-4971-972a-6724879c5cb1"/>
<lastUpdated value="2018-07-24T10:01:00+00:00"/>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"/>
</meta>
<contained>
<Provenance>
<id value="43124f67-b09d-453d-b889-a5e2e8780b9e"/>
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
</meta>
<target>
<reference value="Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186"/>
</target>
<recorded value="2018-07-24T10:05:33+00:00"/>
<agent>
<role>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1"/>
<code value="R1974"/>
<display value="Community Learning Disabilities Nurse"/>
</coding>
</role>
<whoReference>
<reference value="https://sds.spineservices.nhs.uk/STU3/Practitioner/4tr6ee6a9"/>
<display value="Nurse N"/>
</whoReference>
<onBehalfOfReference>
<reference value="https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7"/>
<display value="Some Hospital Learning Disability Support Department"/>
</onBehalfOfReference>
</agent>
</Provenance>
</contained>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1">
<extension url="created">
<valueReference>
<reference value="#43124f67-b09d-453d-b889-a5e2e8780b9e"/>
</valueReference>
</extension>
</extension>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1">
<valueCodeableConcept>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1"/>
<code value="comms"/>
<display value="Communication"/>
</coding>
</valueCodeableConcept>
</extension>
<status value="inactive"/>
<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>
<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>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Flag>
5.2 Updated Flag Resource - json example
Updated Flag Resource JSON Example
{
"resourceType": "Flag",
"id": "2acb0536-0a8f-48c9-8a2f-6ee82860f186",
"fhir_comments": [
" xml example fileUpdateExample-UpdatedFlagResource.xml "
],
"meta": {
"versionId": "aa755bd6-2be9-4971-972a-6724879c5cb1",
"lastUpdated": "2018-07-24T10:01:00+00:00",
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"
]
},
"contained": [
{
"resourceType": "Provenance",
"id": "43124f67-b09d-453d-b889-a5e2e8780b9e",
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"
]
},
"target": [
{
"reference": "Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186"
}
],
"recorded": "2018-07-24T10:05:33+00:00",
"agent": [
{
"role": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1",
"code": "R1974",
"display": "Community Learning Disabilities Nurse"
}
]
}
],
"whoReference": {
"reference": "https://sds.spineservices.nhs.uk/STU3/Practitioner/4tr6ee6a9",
"display": "Nurse N"
},
"onBehalfOfReference": {
"reference": "https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7",
"display": "Some Hospital Learning Disability Support Department"
}
}
]
}
],
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1",
"extension": [
{
"url": "created",
"valueReference": {
"reference": "#43124f67-b09d-453d-b889-a5e2e8780b9e"
}
}
]
},
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1",
"code": "comms",
"display": "Communication"
}
]
}
}
],
"status": "inactive",
"category": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1",
"code": "reasonable adjustments flag",
"display": "Reasonable Adjustments Flag"
}
]
},
"code": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AccessibleInformationAdjustments-1",
"code": "requiresinformationineasyread",
"display": "Requires information in Easyread"
}
]
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
5.3 New Flag Resource - xml example
New Flag Resource XML Example
<!-- xml example file
UpdateExample-NewFlagResource.xml -->
<Flag xmlns="http://hl7.org/fhir">
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"/>
</meta>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1">
<valueCodeableConcept>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1"/>
<code value="other"/>
<display value="Other reasonable adjustment context and/ or considerations"/>
</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>
<code>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AccessibleInformationAdjustments-1"/>
<code value="requireswritteninformationinatleast28pointsansseriffont"/>
<display value="Requires written information in at least 28 point sans serif font"/>
</coding>
</code>
<subject>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Flag>
5.4 New Flag Resource - json example
New Flag Resource JSON Example
{
"resourceType": "Flag",
"fhir_comments": [
" xml example fileUpdateExample-NewFlagResource.xml "
],
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"
]
},
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1",
"code": "other",
"display": "Other reasonable adjustment context and/ or considerations"
}
]
}
}
],
"status": "active",
"category": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1",
"code": "reasonable adjustments flag",
"display": "Reasonable Adjustments Flag"
}
]
},
"code": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AccessibleInformationAdjustments-1",
"code": "requireswritteninformationinatleast28pointsansseriffont",
"display": "Requires written information in at least 28 point sans serif font"
}
]
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
6 Interaction Examples
Examples of http requests, responses and payloads
6.1 Update Flag Request - xml example
http request & headers
PUT https://clinicals.spineservices.nhs.uk/STU3/Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186 HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 123456123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Flag.write:1
If-Match: W/"aa755bd6-2be9-4971-972a-6724879c5cb1"
http body
UpdateFlagRequest.xml XML Example
<!-- xml example file
UpdateExample-UpdateFlagRequest.xml -->
<Flag xmlns="http://hl7.org/fhir">
<id value="2acb0536-0a8f-48c9-8a2f-6ee82860f186"/>
<meta>
<versionId value="aa755bd6-2be9-4971-972a-6724879c5cb1"/>
<lastUpdated value="2018-07-24T10:01:00+00:00"/>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"/>
</meta>
<contained>
<Provenance>
<id value="43124f67-b09d-453d-b889-a5e2e8780b9e"/>
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
</meta>
<target>
<reference value="Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186"/>
</target>
<recorded value="2018-07-24T10:05:33+00:00"/>
<agent>
<role>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1"/>
<code value="R1974"/>
<display value="Community Learning Disabilities Nurse"/>
</coding>
</role>
<whoReference>
<reference value="https://sds.spineservices.nhs.uk/STU3/Practitioner/4tr6ee6a9"/>
<display value="Nurse N"/>
</whoReference>
<onBehalfOfReference>
<reference value="https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7"/>
<display value="Some Hospital Learning Disability Support Department"/>
</onBehalfOfReference>
</agent>
</Provenance>
</contained>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1">
<extension url="created">
<valueReference>
<reference value="#43124f67-b09d-453d-b889-a5e2e8780b9e"/>
</valueReference>
</extension>
</extension>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1">
<valueCodeableConcept>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1"/>
<code value="comms"/>
<display value="Communication"/>
</coding>
</valueCodeableConcept>
</extension>
<status value="inactive"/>
<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>
<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>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Flag>
6.2 Update Flag Request - json example
http request & headers
PUT https://clinicals.spineservices.nhs.uk/STU3/Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186 HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 123456123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Flag.write:1
If-Match: W/"aa755bd6-2be9-4971-972a-6724879c5cb1"
http body
Update Flag Request JSON Example
{
"resourceType": "Flag",
"id": "2acb0536-0a8f-48c9-8a2f-6ee82860f186",
"fhir_comments": [
" xml example fileUpdateExample-UpdateFlagRequest.xml "
],
"meta": {
"versionId": "aa755bd6-2be9-4971-972a-6724879c5cb1",
"lastUpdated": "2018-07-24T10:01:00+00:00",
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"
]
},
"contained": [
{
"resourceType": "Provenance",
"id": "43124f67-b09d-453d-b889-a5e2e8780b9e",
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"
]
},
"target": [
{
"reference": "Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186"
}
],
"recorded": "2018-07-24T10:05:33+00:00",
"agent": [
{
"role": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1",
"code": "R1974",
"display": "Community Learning Disabilities Nurse"
}
]
}
],
"whoReference": {
"reference": "https://sds.spineservices.nhs.uk/STU3/Practitioner/4tr6ee6a9",
"display": "Nurse N"
},
"onBehalfOfReference": {
"reference": "https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7",
"display": "Some Hospital Learning Disability Support Department"
}
}
]
}
],
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1",
"extension": [
{
"url": "created",
"valueReference": {
"reference": "#43124f67-b09d-453d-b889-a5e2e8780b9e"
}
}
]
},
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1",
"code": "comms",
"display": "Communication"
}
]
}
}
],
"status": "inactive",
"category": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1",
"code": "reasonable adjustments flag",
"display": "Reasonable Adjustments Flag"
}
]
},
"code": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AccessibleInformationAdjustments-1",
"code": "requiresinformationineasyread",
"display": "Requires information in Easyread"
}
]
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
6.3 Update Flag Response - xml example
http request & headers
HTTP/1.1 200 OK
Date: Thur, 25 Jul 2018 11:00:00 GMT
Last-Modified: 2018-07-25T11:00:00+00:00
ETag: W/"b0c4bd5f-6133-4ac4-af48-82570ad15007”
Content-Type: application/fhir+xml
http body
Update Flag Response XML Example
<!-- xml example file
UpdateExample-UpdateFlagResponse.xml -->
<Flag xmlns="http://hl7.org/fhir">
<id value="2acb0536-0a8f-48c9-8a2f-6ee82860f186"/>
<meta>
<versionId value="b0c4bd5f-6133-4ac4-af48-82570ad15007"/>
<lastUpdated value="2018-07-25T11:00:00+00:00"/>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"/>
</meta>
<contained>
<Provenance>
<id value="43124f67-b09d-453d-b889-a5e2e8780b9e"/>
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
</meta>
<target>
<reference value="Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186"/>
</target>
<recorded value="2018-07-24T10:05:33+00:00"/>
<agent>
<role>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1"/>
<code value="R1974"/>
<display value="Community Learning Disabilities Nurse"/>
</coding>
</role>
<whoReference>
<reference value="https://sds.spineservices.nhs.uk/STU3/Practitioner/4tr6ee6a9"/>
<display value="Nurse N"/>
</whoReference>
<onBehalfOfReference>
<reference value="https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7"/>
<display value="Some Hospital Learning Disability Support Department"/>
</onBehalfOfReference>
</agent>
</Provenance>
</contained>
<contained>
<Provenance>
<id value="07c0c8fa-4654-42f7-8d6c-e4b4e714cffd"/>
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
</meta>
<target>
<reference value="Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186"/>
</target>
<recorded value="2018-07-25T11: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="#43124f67-b09d-453d-b889-a5e2e8780b9e"/>
</valueReference>
</extension>
<extension url="updated">
<valueReference>
<reference value="#07c0c8fa-4654-42f7-8d6c-e4b4e714cffd"/>
</valueReference>
</extension>
</extension>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1">
<valueCodeableConcept>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1"/>
<code value="comms"/>
<display value="Communication"/>
</coding>
</valueCodeableConcept>
</extension>
<status value="inactive"/>
<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>
<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>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Flag>
6.4 Update Flag Response - json example
http request & headers
HTTP/1.1 200 OK
Date: Thur, 25 Jul 2018 11:00:00 GMT
Last-Modified: 2018-07-25T11:00:00+00:00
ETag: W/"b0c4bd5f-6133-4ac4-af48-82570ad15007”
Content-Type: application/fhir+json
http body
Update Flag Response JSON Example
{
"resourceType": "Flag",
"id": "2acb0536-0a8f-48c9-8a2f-6ee82860f186",
"fhir_comments": [
" xml example fileUpdateExample-UpdateFlagResponse.xml "
],
"meta": {
"versionId": "b0c4bd5f-6133-4ac4-af48-82570ad15007",
"lastUpdated": "2018-07-25T11:00:00+00:00",
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"
]
},
"contained": [
{
"resourceType": "Provenance",
"id": "43124f67-b09d-453d-b889-a5e2e8780b9e",
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"
]
},
"target": [
{
"reference": "Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186"
}
],
"recorded": "2018-07-24T10:05:33+00:00",
"agent": [
{
"role": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1",
"code": "R1974",
"display": "Community Learning Disabilities Nurse"
}
]
}
],
"whoReference": {
"reference": "https://sds.spineservices.nhs.uk/STU3/Practitioner/4tr6ee6a9",
"display": "Nurse N"
},
"onBehalfOfReference": {
"reference": "https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7",
"display": "Some Hospital Learning Disability Support Department"
}
}
]
},
{
"resourceType": "Provenance",
"id": "07c0c8fa-4654-42f7-8d6c-e4b4e714cffd",
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"
]
},
"target": [
{
"reference": "Flag/2acb0536-0a8f-48c9-8a2f-6ee82860f186"
}
],
"recorded": "2018-07-25T11:00:00+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": "#43124f67-b09d-453d-b889-a5e2e8780b9e"
}
},
{
"url": "updated",
"valueReference": {
"reference": "#07c0c8fa-4654-42f7-8d6c-e4b4e714cffd"
}
}
]
},
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1",
"code": "comms",
"display": "Communication"
}
]
}
}
],
"status": "inactive",
"category": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1",
"code": "reasonable adjustments flag",
"display": "Reasonable Adjustments Flag"
}
]
},
"code": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AccessibleInformationAdjustments-1",
"code": "requiresinformationineasyread",
"display": "Requires information in Easyread"
}
]
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
6.5 Create Flag Request - xml example
http request & headers
POST https://clinicals.spineservices.nhs.uk/STU3/Flag HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 123456123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Flag.write:1
http body
Create Flag Request XML Example
<!-- xml example file
UpdateExample-CreateFlagRequest.xml -->
<Flag xmlns="http://hl7.org/fhir">
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"/>
</meta>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1">
<valueCodeableConcept>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1"/>
<code value="other"/>
<display value="Other reasonable adjustment context and/ or considerations"/>
</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>
<code>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AccessibleInformationAdjustments-1"/>
<code value="requireswritteninformationinatleast28pointsansseriffont"/>
<display value="Requires written information in at least 28 point sans serif font"/>
</coding>
</code>
<subject>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Flag>
6.6 Create Flag Request - json example
http request & headers
POST https://clinicals.spineservices.nhs.uk/STU3/Flag HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 123456123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Flag.write:1
http body
Create Flag Request JSON Example
{
"resourceType": "Flag",
"fhir_comments": [
" xml example fileUpdateExample-CreateFlagRequest.xml "
],
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"
]
},
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1",
"code": "other",
"display": "Other reasonable adjustment context and/ or considerations"
}
]
}
}
],
"status": "active",
"category": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1",
"code": "reasonable adjustments flag",
"display": "Reasonable Adjustments Flag"
}
]
},
"code": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AccessibleInformationAdjustments-1",
"code": "requireswritteninformationinatleast28pointsansseriffont",
"display": "Requires written information in at least 28 point sans serif font"
}
]
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
6.7 Create Flag Response - xml example
http request & headers
HTTP/1.1 201 Created
Date: Thu, 25 Jul 2018 11:03:00 GMT
Last-Modified:2018-07-25T11:03:00+00:00
Location: https://clinicals.spineservices.nhs.uk/STU3/Flag/d82888a3-1584-4e7f-99f1-3e578a1c9d37/_history/5b293b55-5ca5-4670-91e2-adb905001b96
ETag: W/"5b293b55-5ca5-4670-91e2-adb905001b96”
Content-Type: application/fhir+xml
http body
Create Flag Response XML Example
<!-- xml example file
UpdateExample-CreateFlagResponse.xml -->
<Flag xmlns="http://hl7.org/fhir">
<id value="d82888a3-1584-4e7f-99f1-3e578a1c9d37"/>
<meta>
<versionId value="5b293b55-5ca5-4670-91e2-adb905001b96"/>
<lastUpdated value="2018-07-25T11:03:00+00:00"/>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"/>
</meta>
<contained>
<Provenance>
<id value="9e6fb1d3-4f10-4087-8782-bff20bf2a07f"/>
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
</meta>
<target>
<reference value="Flag/d82888a3-1584-4e7f-99f1-3e578a1c9d37"/>
</target>
<recorded value="2018-07-25T11:03: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="#9e6fb1d3-4f10-4087-8782-bff20bf2a07f"/>
</valueReference>
</extension>
</extension>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1">
<valueCodeableConcept>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1"/>
<code value="other"/>
<display value="Other reasonable adjustment context and/ or considerations"/>
</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>
<code>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AccessibleInformationAdjustments-1"/>
<code value="requireswritteninformationinatleast28pointsansseriffont"/>
<display value="Requires written information in at least 28 point sans serif font"/>
</coding>
</code>
<subject>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Flag>
6.8 Create Flag Response - json example
http request & headers
HTTP/1.1 201 Created
Date: Thu, 25 Jul 2018 11:03:00 GMT
Last-Modified:2018-07-25T11:03:00+00:00
Location: https://clinicals.spineservices.nhs.uk/STU3/Flag/d82888a3-1584-4e7f-99f1-3e578a1c9d37/_history/5b293b55-5ca5-4670-91e2-adb905001b96
ETag: W/"5b293b55-5ca5-4670-91e2-adb905001b96”
Content-Type: application/fhir+json
http body
Create Flag Response JSON Example
{
"resourceType": "Flag",
"id": "d82888a3-1584-4e7f-99f1-3e578a1c9d37",
"fhir_comments": [
" xml example fileUpdateExample-CreateFlagResponse.xml "
],
"meta": {
"versionId": "5b293b55-5ca5-4670-91e2-adb905001b96",
"lastUpdated": "2018-07-25T11:03:00+00:00",
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Flag-1"
]
},
"contained": [
{
"resourceType": "Provenance",
"id": "9e6fb1d3-4f10-4087-8782-bff20bf2a07f",
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"
]
},
"target": [
{
"reference": "Flag/d82888a3-1584-4e7f-99f1-3e578a1c9d37"
}
],
"recorded": "2018-07-25T11:03:00+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": "#9e6fb1d3-4f10-4087-8782-bff20bf2a07f"
}
}
]
},
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-AdjustmentCategory-1",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AdjustmentCategories-1",
"code": "other",
"display": "Other reasonable adjustment context and/ or considerations"
}
]
}
}
],
"status": "active",
"category": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1",
"code": "reasonable adjustments flag",
"display": "Reasonable Adjustments Flag"
}
]
},
"code": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-AccessibleInformationAdjustments-1",
"code": "requireswritteninformationinatleast28pointsansseriffont",
"display": "Requires written information in at least 28 point sans serif font"
}
]
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}