Create describes the interaction required to record a new 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 Create RA Record
Trigger:
- GP initiates Reasonable Adjustment Flag discussion at annual health check
System Scope:
- ClientSystem includes Acute/DepartmentalSystem client, SCRa, 1-click etc.
- ServerSystem includes Spine, PDS, SDS, FlagServer etc.
Summary:
Practitioner creates RARecord, recording Consent from Patient and that Impairment is ‘Learning Disability’.
Patient declines to record a specific Adjustment at this time.
Pre
- Patient arrives at check
- Practitioner logged into ClientSystem, traces & verifies demographic information
- Practitioner searches for Patient’s RARecord
- ClientSystem searched and failed to find existing RARecord (see Use Case Initial Read Failure)
- Practitioner discusses RARecord with Patient
Main
- Patient consents to record RA Flag
- Patient agrees to record ‘Learning Disability’ as Impairment
-
Patient declines to record any specific Adjustments at this time
- Practitioner commits RARecord
2 New Resource Examples
Examples of client-side resources as they are created. i.e. befoer they are written to Spine.
2.1 New Consent Resource - xml example
New Consent Resource XML Example
<!-- CreateExample-NewConsentResource.xml -->
<Consent xmlns="http://hl7.org/fhir">
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Consent-1"/>
</meta>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-ProxyRole-1">
<valueCodeableConcept>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/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>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</patient>
<policy>
<authority value="https://www.gov.uk/"/>
<uri value="https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/535024/data-security-review.pdf"/>
</policy>
<purpose>
<system value="https://snomed.info/sct"/>
<code value="370856009"/>
<display value="Limiting access to confidential patient information"/>
</purpose>
</Consent>
2.2 New Consent Resource - json example
New Consent Resource JSON Example
{
"resourceType": "Consent",
"fhir_comments": [
" CreateExample-NewConsentResource.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": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
},
"policy": [
{
"authority": "https://www.gov.uk/",
"uri": "https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/535024/data-security-review.pdf"
}
],
"purpose": [
{
"system": "https://snomed.info/sct",
"code": "370856009",
"display": "Limiting access to confidential patient information"
}
]
}
2.3 New Impairment Resource - xml example
New Impairment Resource XML Example
<!-- CreateExample-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="1855002"/>
<display value="Learning Disability(s)"/>
</coding>
</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": [
" CreateExample-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": "1855002",
"display": "Learning Disability(s)"
}
]
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
2.5 New List Resource - xml example
New List Resource XML Example
<!-- CreateExample-NewListResource.xml -->
<List xmlns="http://hl7.org/fhir">
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-List-1"/>
</meta>
<status value="current"/>
<mode value="changes"/>
<title value="Reasonable Adjustment List"/>
<code>
<coding>
<system value="http://snomed.info/sct"/>
<code value="1094391000000102"/>
<display value="Reasonable adjustments for health and care access"/>
</coding>
</code>
<subject>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
<date value="2018-07-23T11:00:00+00:00"/>
<entry>
<deleted value="false"/>
<date value="2018-07-23T11:00:00+00:00"/>
<item>
<reference value="https://clinicals.spineservices.nhs.uk/STU3/Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"/>
</item>
</entry>
</List>
2.6 New List Resource - json example
New List Resource JSON Example
{
"resourceType": "List",
"fhir_comments": [
" CreateExample-NewListResource.xml "
],
"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": {
"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"
}
}
]
}
3 Interaction Examples
Examples of http requests, responses and payloads
3.1 Create Consent Request - xml example
http request & headers
POST https://clinicals.spineservices.nhs.uk/STU3/Consent HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 123456123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Consent.write:1
http body
Create Consent Request XML Example
<!-- CreateExample-CreateConsentRequest.xml -->
<Consent xmlns="http://hl7.org/fhir">
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Consent-1"/>
</meta>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-ProxyRole-1">
<valueCodeableConcept>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/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>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</patient>
<policy>
<authority value="https://www.gov.uk/"/>
<uri value="https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/535024/data-security-review.pdf"/>
</policy>
<purpose>
<system value="https://snomed.info/sct"/>
<code value="370856009"/>
<display value="Limiting access to confidential patient information"/>
</purpose>
</Consent>
3.2 Create Consent Request - json example
http request & headers
POST https://clinicals.spineservices.nhs.uk/STU3/Consent HTTP/1.1
Authorization:Bearer [jwt_token_string]
FromASID: 123456123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Consent.write:1
http body
Create Consent Request JSON Example
{
"resourceType": "Consent",
"fhir_comments": [
" CreateExample-CreateConsentRequest.xml "
],
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Consent-1"
]
},
"extension": [
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-ProxyRole-1",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/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": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
},
"policy": [
{
"authority": "https://www.gov.uk/",
"uri": "https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/535024/data-security-review.pdf"
}
],
"purpose": [
{
"system": "https://snomed.info/sct",
"code": "370856009",
"display": "Limiting access to confidential patient information"
}
]
}
3.3 Create Consent Response - xml example
http response & headers
HTTP/1.1 201 Created
Date: Tue, 23 Jul 2018 11:00:00 GMT
Last-Modified:2018-07-23T11:00:00+00:00
Location: https://clinicals.spineservices.nhs.uk/STU3/Consent/f1dc0ac6-45ff-4d2b-bf91-793971e3e286/_history/cccacb16-e087-45ee-8ddd-5fbd6223e5a2
ETag: W/"cccacb16-e087-45ee-8ddd-5fbd6223e5a2”
Content-Type: application/fhir+xml
http body
Create Consent Response XML Example
<!-- CreateExample-CreateConsentResponse.xml -->
<Consent xmlns="http://hl7.org/fhir">
<id value="f1dc0ac6-45ff-4d2b-bf91-793971e3e286"/>
<meta>
<versionId value="cccacb16-e087-45ee-8ddd-5fbd6223e5a2"/>
<lastUpdated value="2018-07-23T11:00:00+00:00"/>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Consent-1"/>
</meta>
<contained>
<!-- Provenance constructed and persisted -->
<Provenance>
<id value="e0531fd1-212d-4a97-a7a9-d17cec9a6af2"/>
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
</meta>
<target>
<reference value="Consent/f1dc0ac6-45ff-4d2b-bf91-793971e3e286"/>
</target>
<recorded value="2018-07-23T11:00:00+00:00"/>
<agent>
<role>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1"/>
<code value="R0260"/>
<display value="General Medical Practitioner"/>
</coding>
</role>
<whoReference>
<reference value="https://sds.spineservices.nhs.uk/STU3/Practitioner/2ee4tr6a9"/>
<display value="Dr.D"/>
</whoReference>
<onBehalfOfReference>
<reference value="https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7"/>
<display value="Some GP Clinic"/>
</onBehalfOfReference>
</agent>
</Provenance>
</contained>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-ProxyRole-1">
<valueCodeableConcept>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-ProxyRole-1"/>
<code value="lpa"/>
<display value="Lasting power of attorney personal welfare"/>
</coding>
</valueCodeableConcept>
</extension>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1">
<extension url="created">
<valueReference>
<reference value="#e0531fd1-212d-4a97-a7a9-d17cec9a6af2"/>
</valueReference>
</extension>
</extension>
<status value="active"/>
<category>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1"/>
<code value="reasonable adjustments flag"/>
<display value="Reasonable Adjustments Flag"/>
</coding>
</category>
<patient>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</patient>
<policy>
<authority value="https://www.gov.uk/"/>
<uri value="https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/535024/data-security-review.pdf"/>
</policy>
<purpose>
<system value="https://snomed.info/sct"/>
<code value="370856009"/>
<display value="Limiting access to confidential patient information"/>
</purpose>
</Consent>
3.4 Create Consent Response - json example
http response & headers
HTTP/1.1 201 Created
Date: Tue, 23 Jul 2018 11:00:00 GMT
Last-Modified:2018-07-23T11:00:00+00:00
Location: [resourceURL]
ETag: W/"resourceVID”
Content-Type: application/fhir+json
http body
Create Consent Response JSON Example
{
"resourceType": "Consent",
"id": "f1dc0ac6-45ff-4d2b-bf91-793971e3e286",
"fhir_comments": [
" CreateExample-CreateConsentResponse.xml "
],
"meta": {
"versionId": "cccacb16-e087-45ee-8ddd-5fbd6223e5a2",
"lastUpdated": "2018-07-23T11:00:00+00:00",
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Consent-1"
]
},
"contained": [
{
"resourceType": "Provenance",
"id": "e0531fd1-212d-4a97-a7a9-d17cec9a6af2",
"fhir_comments": [
" Provenance constructed and persisted "
],
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"
]
},
"target": [
{
"reference": "Consent/f1dc0ac6-45ff-4d2b-bf91-793971e3e286"
}
],
"recorded": "2018-07-23T11: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-ProxyRole-1",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-ProxyRole-1",
"code": "lpa",
"display": "Lasting power of attorney personal welfare"
}
]
}
},
{
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1",
"extension": [
{
"url": "created",
"valueReference": {
"reference": "#e0531fd1-212d-4a97-a7a9-d17cec9a6af2"
}
}
]
}
],
"status": "active",
"category": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1",
"code": "reasonable adjustments flag",
"display": "Reasonable Adjustments Flag"
}
]
}
],
"patient": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
},
"policy": [
{
"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"
}
]
}
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: 123456123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Condition.write:1
http body
Create Condition Request XML Example
<!-- CreateExample-CreateConditionRequest.xml -->
<Condition xmlns="http://hl7.org/fhir">
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-Condition-1" />
</meta>
<clinicalStatus value="active"/>
<category>
<coding>
<system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ConditionCategory-1"/>
<code value="issue"/>
<display value="Issue"/>
</coding>
</category>
<code>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-ConditionCode-1"/>
<code value="1855002"/>
<display value="Learning Disability(s)"/>
</coding>
</code>
<subject>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Condition>
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: 123456123456
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": [
" CreateExample-CreateConditionRequest.xml "
],
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-Condition-1"
]
},
"clinicalStatus": "active",
"category": [
{
"coding": [
{
"system": "https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ConditionCategory-1",
"code": "issue",
"display": "Issue"
}
]
}
],
"code": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-ConditionCode-1",
"code": "1855002",
"display": "Learning Disability(s)"
}
]
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
3.7 Create Condition Response - xml example
http response & headers
HTTP/1.1 201 Created
Date: Tue, 23 Jul 2018 11:00:00 GMT
Last-Modified:2018-07-23T11:00:00+00:00
Location: https://clinicals.spineservices.nhs.uk/STU3/Condition/57f04652-6dd0-4135-a560-f9091b1b26fa/_history/557ccfc3-0c78-48bf-aedd-70cc08af2ba1
ETag: W/"557ccfc3-0c78-48bf-aedd-70cc08af2ba1”
Content-Type: application/fhir+xml
http body
Create Condition Response XML Example
<!-- CreateExample-CreateConditionResponse.xml -->
<Condition xmlns="http://hl7.org/fhir">
<id value="57f04652-6dd0-4135-a560-f9091b1b26fa"/>
<meta>
<versionId value="557ccfc3-0c78-48bf-aedd-70cc08af2ba1"/>
<lastUpdated value="2018-07-23T11:00:00+00:00"/>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-Condition-1" />
</meta>
<contained>
<Provenance>
<id value="8ce7de6b-1307-432d-8e96-ae6a613ca3e4"/>
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"/>
</meta>
<target>
<reference value="Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"/>
</target>
<recorded value="2018-07-23T11:00:00+00:00"/>
<agent>
<role>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CareConnect-SDSJobRoleName-1"/>
<code value="R0260"/>
<display value="General Medical Practitioner"/>
</coding>
</role>
<whoReference>
<reference value="https://sds.spineservices.nhs.uk/STU3/Practitioner/2ee4tr6a9"/>
<display value="Dr.D"/>
</whoReference>
<onBehalfOfReference>
<reference value="https://directory.spineservices.nhs.uk/STU3/Organization/a3e5i7"/>
<display value="Some GP Clinic"/>
</onBehalfOfReference>
</agent>
</Provenance>
</contained>
<extension url="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-RARecord-Provenance-1">
<extension url="created">
<valueReference>
<reference value="#8ce7de6b-1307-432d-8e96-ae6a613ca3e4"/>
</valueReference>
</extension>
</extension>
<clinicalStatus value="active"/>
<category>
<coding>
<system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ConditionCategory-1"/>
<code value="issue"/>
<display value="Issue"/>
</coding>
</category>
<code>
<coding>
<system value="https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-ConditionCode-1"/>
<code value="1855002"/>
<display value="Learning Disability(s)"/>
</coding>
</code>
<subject>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
</Condition>
3.8 Create Condition Response - json example
http response & headers
HTTP/1.1 201 Created
Date: Tue, 23 Jul 2018 11:00:00 GMT
Last-Modified:2018-07-23T11:00:00+00:00
Location: [resourceURL]
ETag: W/"resourceVID”
Content-Type: application/fhir+json
http body
Create Condition Response JSON Example
{
"resourceType": "Condition",
"id": "57f04652-6dd0-4135-a560-f9091b1b26fa",
"fhir_comments": [
" CreateExample-CreateConditionResponse.xml "
],
"meta": {
"versionId": "557ccfc3-0c78-48bf-aedd-70cc08af2ba1",
"lastUpdated": "2018-07-23T11:00:00+00:00",
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-Condition-1"
]
},
"contained": [
{
"resourceType": "Provenance",
"id": "8ce7de6b-1307-432d-8e96-ae6a613ca3e4",
"meta": {
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/RARecord-Provenance-1"
]
},
"target": [
{
"reference": "Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"
}
],
"recorded": "2018-07-23T11: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": "#8ce7de6b-1307-432d-8e96-ae6a613ca3e4"
}
}
]
}
],
"clinicalStatus": "active",
"category": [
{
"coding": [
{
"system": "https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-ConditionCategory-1",
"code": "issue",
"display": "Issue"
}
]
}
],
"code": {
"coding": [
{
"system": "https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-ConditionCode-1",
"code": "1855002",
"display": "Learning Disability(s)"
}
]
},
"subject": {
"reference": "demographics.spineservices.nhs.uk/STU3/Patient/999999998"
}
}
3.9 Create List Request - xml example
http request & headers
POST https://clinicals.spineservices.nhs.uk/STU3/List HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 123456123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:List.write:1
http body
Create List Request XML Example
<!-- xml example file
CreateExample-CreateListRequest.xml -->
<List xmlns="http://hl7.org/fhir">
<meta>
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-RARecord-List-1"/>
</meta>
<status value="current"/>
<mode value="changes"/>
<title value="Reasonable Adjustment List"/>
<code>
<coding>
<system value="http://snomed.info/sct"/>
<code value="1094391000000102"/>
<display value="Reasonable adjustments for health and care access"/>
</coding>
</code>
<subject>
<reference value="demographics.spineservices.nhs.uk/STU3/Patient/999999998"/>
</subject>
<date value="2018-07-23T11:00:00+00:00"/>
<entry>
<deleted value="false"/>
<date value="2018-07-23T11:00:00+00:00"/>
<item>
<reference value="https://clinicals.spineservices.nhs.uk/STU3/Condition/57f04652-6dd0-4135-a560-f9091b1b26fa"/>
</item>
</entry>
</List>
3.10 Create List Request - json example
http request & headers
POST https://clinicals.spineservices.nhs.uk/STU3/List HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 123456123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:List.write:1
http body
Create List Request JSON Example
{
"resourceType": "List",
"fhir_comments": [
" xml example fileCreateExample-CreateListRequest.xml "
],
"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": {
"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"
}
}
]
}
3.11 Create List Response - xml example
http response & headers
HTTP/1.1 201 Created
Date: Tue, 23 Jul 2018 11:00:01 GMT
Last-Modified:2018-07-23T11:00:01+00:00
Location: https://clinicals.spineservices.nhs.uk/STU3/List/e00c5a85-d34f-4075-96ac-b787deb484b1/_history/5b703b55-cedc-4c19-b2aa-0666384eab1a
ETag: W/"5b703b55-cedc-4c19-b2aa-0666384eab1a”
Content-Type: application/fhir+xml
http body
Create List Response XML Example
<!-- CreateExample-CreateListResponse.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>
</List>
3.12 Create List Response - json example
http response & headers
HTTP/1.1 201 Created
Date: Tue, 23 Jul 2018 11:00:01 GMT
Last-Modified:2018-07-23T11:00:01+00:00
Location: [resourceURL]
ETag: W/"resourceVID”
Content-Type: application/fhir+json
http body
Create List Response JSON Example
{
"resourceType": "List",
"id": "e00c5a85-d34f-4075-96ac-b787deb484b1",
"fhir_comments": [
" CreateExample-CreateListResponse.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"
}
}
]
}