UKNEONATALSUMMARY - Reading all care records for the child

Overview

To read a complete multi-episode child record from the Spine, a Spine Client System makes a request to the $everything endpoint, using the Logical ID of ANY of the 1..n single Child Episode logical IDs. The Patient Everything endpoint is a standard operation defined as part of the FHIR specification.

The Spine returns a FHIR Bundle resource containing all FHIR resources, which comprise the Spine all the child’s care episode's data, along with any supporting resources such as Practitioner and Organization. There will be one single [patient] resource, which will be the merged result of all the individual episode’s [patient] resources.

The resulting payload will contain the FHIR model for the assigned Spine Record Filter items only.

Request

GET [baseUrl]/Patient/{childepisode-logical-id}/$everything

Parameters

Name	Type	Description
`childepisode-logical-id`	String (path)	The logical ID of any of the single Child Care Episodes.

Request Flow

Response

Possible response codes

Code	Description
200	Care record found
404	Not Found
422	Unprocessable Entity

Example

Response

Header

Code	Description
200	Care record has been successfully retrieved

Body

JSON

{
    "resourceType": "Bundle",
    "id": "78a4a9e5-d320-456e-bc2f-9f9da609e51f",
    "meta": {
        "lastUpdated": "2022-11-30T17:40:28.1770802+00:00"
    },
    "type": "searchset",
    "entry": [
        {
            "resource": {
                "resourceType": "Patient",
                "id": "56628828-45ac-4a12-868a-96a220b37e07",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2022-11-30T17:36:06.307+00:00"
                },
                "identifier": [
                    {
                        "use": "official",
                        "system": "https://fhir.nhs.uk/Id/nhs-number",
                        "value": "NationalID123"
                    }
                ],
                "name": [
                    {
                        "use": "official",
                        "family": "Solis",
                        "given": [
                            "Gabrielle"
                        ]
                    }
                ],
                "birthDate": "2023-03-21T12:23:45",
                "address": [
                    {
                        "use": "home"
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "resource": {
                "resourceType": "EpisodeOfCare",
                "id": "56628828-45ac-4a12-868a-96a220b37e07",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2022-11-30T17:36:06.363+00:00"
                },
                "status": "active",
                "patient": {
                    "reference": "Patient/56628828-45ac-4a12-868a-96a220b37e07"
                },
                "period": {
                    "start": "2022-11-30T17:31:07+00:00"
                }
            },
            "search": {
                "mode": "match"
            }
        },
    ]
}