E-forms

To query to see if a Patient has an e-form can be done using the Observation API.

The following query can be used:

GET Observation?patient.identifier=https://fhir.nhs.uk/Id/nhs-number|[nhsnumber]&patient.birthdate=[birthdate]&code=[system]|[code]

Codes for the relevant care plans are listed below; where available in a given instance of CareCentric and created for the Patient that is the subject of the API calls.

Please contact us before attempting to use these so we can advise on what can be made available to query through this route, and by when.

E-form System Code
End of life care plan http://snomed.info/sct 736373009
ReSPECT (Recommended Summary Plan for Emergency Care and Treatment) http://snomed.info/sct 1382601000000107
Contingency plan http://snomed.info/sct 325691000000100
Mental health crisis plan http://snomed.info/sct 736253002
End of life care coordination summary http://snomed.info/sct 861421000000109
Emergency health care plan http://snomed.info/sct 887701000000100

This code filter uses a single code for a specific e-form. It is possible to construct a search using a predefined ValueSet that defines a collection of codes.

The ValueSets that are available for this function will evolve over time. Speak to Graphnet if you intend to use this capability.

Example response:

{
"resourceType": "Bundle",
"id": "627eec29-6fe7-4a8d-b6e9-70a1b856ade7",
"meta": {
"versionId": "7d7acd66-3d21-4e75-81db-73693487a899",
"lastUpdated": "2025-02-05T09:11:08.183+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://api-live.grhapp.com/R4/Observation?_tag=https%3A%2F%2Ffhir.graphnethealth.com%2FCodeSystem-Tenancies%7C2&patient.identifier=https%3A%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C9782907405&patient.birthdate=1980-01-01&code=http%3A%2F%2Fsnomed.info%2Fsct%7C1382601000000107&_sort=-_lastUpdated&_requestId=1969a417-c009-4c67-a65a-2d532d79a51b&_count=5&_skip=0"
}
],
"entry": [
{
"fullUrl": "https://api-live.grhapp.com/R4/Observation/KCV5JJ6F4LYC6JN3INJYWEFHDQ",
"resourceType": "Observation",
"id": "KCV5JJ6F4LYC6JN3INJYWEFHDQ",
"meta": {
"versionId": "WPTYK5Z4NEGK2NLOJNIWDSN4JU",
"lastUpdated": "2025-01-24T17:08:29+00:00",
"profile": [
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation"
],
"tag": [
{
"system": "https://fhir.graphnethealth.com/CodeSystem-Tenancies",
"code": "998"
}
]
},
{
"system": "http://fhir.graphnethealth.com/identifiers",
"value": "0f8c2912-3419-4d3c-b74f-6e5127b754b0"
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1382601000000107",
"display": "ReSPECT (Recommended Summary Plan for Emergency Care and Treatment) form"
}
]
},
"subject": {
"reference": "https://api-live.grhapp.com/R4/Patient/QSGDVP3EVAUQ5E3MNCQUMHJLG3EZS5BKLBSQDPZG37BJVDKRUIRA"
},
"effectiveDateTime": "2021-03-12T12:11:15.566Z",
"issued": "2021-03-12T12:11:15.566+00:00"
},
"search": {
"mode": "match"
}
}
]
}