Description of use case on Spine via the FHIR® Reasonable Adjustments API
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® Reasonable Adjustments API. This project is being developed using an agile methodology so iterative updates to content will be added on a regular basis.
Warning: This site is provided for information only and is intended for those engaged with NHS Digital. It is advised not to develop against these specifications until a formal announcement has been made.
1 No RA Record
Pre
- Practitioner logged into ClientSystem, traces & verifies demographic info - see API Security
Main
- Practitioner searches for Patient’s RARecord
2 Interaction Examples
2.1 Read Consent request - xml example
http request & headers
GET https://clinicals.spineservices.nhs.uk/STU3/Consent?
patient=999999998&
status=active&
category=https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1|reasonable%20adjustments%20flag&
_format=xml HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 123456123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Consent.read:1
http body
None
2.2 Read Consent request - json example
http request & headers
GET https://clinicals.spineservices.nhs.uk/STU3/Consent?
patient=999999998&
status=active&
category=https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1|reasonable%20adjustments%20flag&
_format=json HTTP/1.1
Authorization: Bearer [jwt_token_string]
FromASID: 123456123456
ToASID: 987654456789
Prefer: return=representation
InteractionID: urn:nhs:names:services:raflags:Consent.read:1
http body
None
2.3 Read Consent response - xml example
http response & headers
HTTP/1.1 200 OK
Date: Tue, 24 Jul 2018 10:00:00 GMT
Content-Type: application/fhir+xml
http body
Read Fail Empty Bundle XML Example
<Bundle xmlns="http://hl7.org/fhir">
<id value="885dda30-e403-470f-956a-366c01d7eace"/>
<meta>
<profile value="http://hl7.org/fhir/bundle"/>
</meta>
<type value="searchset"/>
<total value="0"/>
<link>
<relation value="self"/>
<!-- note entity encoding in url -->
<url value="https://clinicals.spineservices.nhs.uk/STU3/Consent?patient=999999998&status=active&category=https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1|reasonable%20adjustments%20flag&_format=xml"/>
</link>
</Bundle>
2.4 Read Consent response - json example
http response & headers
HTTP/1.1 200 OK
Date: Tue, 24 Jul 2018 10:00:00 GMT
Content-Type: application/fhir+json
http body
Read Fail Empty Bundle JSON Example
{
"resourceType": "Bundle",
"id": "885dda30-e403-470f-956a-366c01d7eace",
"meta": {
"profile": [
"http://hl7.org/fhir/bundle"
]
},
"type": "searchset",
"total": 0,
"link": [
{
"fhir_comments": [
" all search sets include the self link - the statement of the query string searched on. "
],
"relation": "self",
"url": "https://clinicals.spineservices.nhs.uk/STU3/Consent?patient=999999998&status=active&category=https://fhir.nhs.uk/STU3/CodeSystem/CodeSystem-RARecord-FlagCategory-1|reasonable%20adjustments%20flag&_format=json",
"_url": {
"fhir_comments": [
" note entity encoding in url "
]
}
}
]
}