Child and mother record join

Overview

When a BadgerNet Spine Client System wishes to join a child episode of care (EoC, of type birth) to the pregnant person’s pregnancy record in the BadgerNet Spine, a request is made to the perinatal join endpoint, using the following parameters:

Logical ID of the child’s birth EoC (paramName = “BabyLogicalId“ of type string)
Join (bool). (ParamName = “Join“ of type Boolean)

For the join to be successful, the child’s birth EoC must contain the following data items as a minimum, otherwise an error will be returned:

National ID
Date of birth
Baby number - which does not match with any other “joined” childbaby number.

If the child’s birth EoC is successfully joined to the pregnant person’s pregnancy record, a response with status code 204 -- No content is returned.

If the child’s birth EoC is missing the aforementioned data items, the spine will return a HTTP422 status code. In this circumstance, the Spine Client System should add the required data items to the child’s birth EoC.

If the child’s birth EoC contains a baby number which is already in use in the pregnancy record, the spine will return a tbc status code. In this circumstance, the Spine Client System should amend the baby number of birth EoC that is being joined, or amend the baby number(s) of the already joined EoC(s).

Request

POST [baseUrl]/EpisodeOfCare/{pregnancy-logical-id}/$perinatal-join

Request Flow

Response

Possible response codes

Code	Description
204	Updated
409	Conflict
422	Unprocessable Entity

Example

Request Body

CODE

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "BabyLogicalId",
            "valueString": "siy2vKe-rmqY7d3-ImA8Hblz6NpjgUC0BgfLMvrtjMWrRtWKD3XzI07xmXXmytG0"
        },
        {
            "name": "Join",
            "valueBoolean": false
        }
    ]
}

Response

The response’s body does not contain any information on a successful result.

Header Code	Description
204	Child record has been successfully joined to a pregnancy record

This documentation space has been classified as:
COMMERCIAL IN CONFIDENCE

Confidentiality/document control

This document contains information that is confidential to System C Healthcare Ltd (System C) and is intended for our customers to use in connection with our products and services and it must not be used for any other purpose nor disclosed to any other party, either whole or in part, without the prior written consent of System C except as follows. A customer may permit those of its employees, advisors and agents having a need to know the contents of this platform, to have access to such of the contents as are strictly necessary, but that customer shall ensure that such employees, advisors and agents are bound to it by an obligation, in similar term, to keep it confidential. A customer's acceptance of these obligations shall be indicated by that customer's use of any of the information contained in this document.

System C acknowledges that a customer may be bound by the Freedom of Information Act 2000 (FOIA). In such a case System C considers that the contents of this document are confidential and exempt from disclosure pursuant to section 41 of the FOIA. A customer should consult System C before making any disclosure of information relating to System C under the FOIA. System C's business information, methodologies, solutions, as well as reference to System C clients and their projects are always considered by System C to be exempt from disclosure by virtue of section 41 and 43 of the FOIA, whether indicated or not.

Warning: Paper or PDF copies of this document are not version controlled and will automatically be considered obsolete and superseded at the time of printing or conversion.