Reading care record data for whole pregnancy

Overview

To read a complete pregnancy record from the Spine, a Spine Client System makes a request to the $everything endpoint, passing the Logical ID of the pregnancy. The $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 pregnancy, along with any supporting resources such as Practitioner and Organization. The resulting payload will contain the FHIR model for the assigned Spine Record Filter items only.

Request

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

Parameters

Name	Type	Description
`pregnancy-logical-id`	String (path)	The logical ID of the single Pregnancy record

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": "1986-11-01",
                "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"
            }
        },
        {
            "resource": {
                "resourceType": "Observation",
                "id": "59c7f20a02eb3c45307fc40c8938b17170b3191b6e85d47c764ef63372b38673",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2022-11-30T17:36:06.384+00:00",
                    "profile": [
                        "https://clevermed.com/fhir/StructureDefinition/BNetPregObs_EDDbyDate"
                    ]
                },
                "extension": [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare",
                        "valueReference": {
                            "reference": "EpisodeOfCare/56628828-45ac-4a12-868a-96a220b37e07"
                        }
                    }
                ],
                "status": "final",
                "code": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "289206005",
                            "display": "EDD by Date"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/56628828-45ac-4a12-868a-96a220b37e07"
                },
                "valueDateTime": "2023-07-03"
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "resource": {
                "resourceType": "Observation",
                "id": "0e1aeb21fbcca02fb0e1619259c5d3cadc839066ae3ec744a8b1d0d175c5b618",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2022-11-30T17:36:06.429+00:00",
                    "profile": [
                        "https://clevermed.com/fhir/StructureDefinition/BNetPregObs_EDDAgreed"
                    ]
                },
                "extension": [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare",
                        "valueReference": {
                            "reference": "EpisodeOfCare/56628828-45ac-4a12-868a-96a220b37e07"
                        }
                    }
                ],
                "status": "final",
                "code": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "161714006",
                            "display": "Agreed EDD"
                        }
                    ]
                },
                "subject": {
                    "reference": "Patient/56628828-45ac-4a12-868a-96a220b37e07"
                },
                "valueDateTime": "2023-07-03"
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}