Patient-BNet-Child

FHIR Resource information

FHIR Resource	🌍Patient-BNet-Child. Based on 🌍 Patient
Description	Single child demographics of a child
Release status	LIVE
Cardinality	Single Instance
Writing to Spine permitted	YES - for Spine Client Type (MAT, NNU) When sending data into the Spine, we accept either a UKPatient, or NZPatient FHIR resource: UK: HL7 FHIR® UK Core R4 NZ: FHIR NZ Base project Depending on what has been submitted, the Spine maps different items to BadgerNet. When reading from the Spine, either the UKPatient or NZPatient resource will be used depending on the country of the Spine Platform.
Spine filters	None

Key FHIR Resource elements used

id - Logical ID for the child patient

Summary	Logical ID for the child patient
Mandatory	No
Expected type	🌍string
Write allowed	No
Data Dictionary item	None

identifier.coding.code - Patient's current NHI/NHS number format

Summary	Patient's current NHI/NHS number format
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary items	Child.NationalID - Child/Neonatal natioanl ID - DataSet: (NNAP) National Neonatal Audit Programme (NNAP) - Topic: (NNU-Patient-Demographics) Neonatal demographics details Baby_NID - Baby National ID - DataSet: (NZHISOMAT2) New Zealand HISO Maternity data set (Phase 2) - Topic: (NewbornBaby) Details of baby at time of birth

identifier.coding.code - Patient's current local hospital ID

Summary	Patient's current local hospital ID
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary items	Child.NationalID - Child/Neonatal natioanl ID - DataSet: (NNAP) National Neonatal Audit Programme (NNAP) - Topic: (NNU-Patient-Demographics) Neonatal demographics details Baby_NID - Baby National ID - DataSet: (NZHISOMAT2) New Zealand HISO Maternity data set (Phase 2) - Topic: (NewbornBaby) Details of baby at time of birth

name.given - Baby/Child given name

Summary	Baby/Child given name
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Child.Forename - Forename - DataSet: (NNAP) National Neonatal Audit Programme (NNAP) - Topic: (NNU-Patient-Demographics) Neonatal demographics details

name.family - Baby/Child surname

Summary	Baby/Child surname
Mandatory	No
Expected type	🌍string
Write allowed	Yes
Data Dictionary item	Child.Surname - Surname - DataSet: (NNAP) National Neonatal Audit Programme (NNAP) - Topic: (NNU-Patient-Demographics) Neonatal demographics details

* birthDate - Baby/Child Date of birth. Note: Birth time recorded in extension

Summary	Baby/Child Date of birth. Note: Birth time recorded in extension
Mandatory	Yes
Expected type	🌍date
Write allowed	Yes
Data Dictionary items	Child.DOB - Date of birth - DataSet: (NNAP) National Neonatal Audit Programme (NNAP) - Topic: (NNU-Patient-Demographics) Neonatal demographics details Birth_datetime - Birth - date and time - DataSet: (NZHISOMAT2) New Zealand HISO Maternity data set (Phase 2) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (NewbornBaby) Details of baby at time of birth

* multipleBirthInteger - Indicates the birth order

Summary	Indicates the birth order
Mandatory	Yes
Expected type	🌍integer
Write allowed	Yes
Data Dictionary item	Child.MultipleBirthOrder - Child's birth number in order - DataSet: (NNAP) National Neonatal Audit Programme (NNAP)

* Extension.birthTime - Time of birth for child. The extension URL is: https://hl7.org/fhir/StructureDefinition/patient-birthTime

Summary	Time of birth for child. The extension URL is: https://hl7.org/fhir/StructureDefinition/patient-birthTime
Mandatory	Yes
Expected type	🌍dateTime
Write allowed	Yes
Data Dictionary items	Child.TOB - Time of birth - DataSet: (NNAP) National Neonatal Audit Programme (NNAP) Birth_datetime - Birth - date and time - DataSet: (NZHISOMAT2) New Zealand HISO Maternity data set (Phase 2) - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (NewbornBaby) Details of baby at time of birth

gender - Used to store child sex

Summary	Used to store child sex
Mandatory	No
Expected type	🌍code
Write allowed	Yes
Data Dictionary items	Child.Sex - Gender at birth - DataSet: (NNAP) National Neonatal Audit Programme (NNAP) - Topic: (NNU-Patient-Demographics) Neonatal demographics details Baby_Sex - Baby sex - DataSet: (NZHISOMAT2) New Zealand HISO Maternity data set (Phase 2) - Topic: (NewbornBaby) Details of baby at time of birth
Value set used	🌍ValueSet-BNet-Child-Gender

* Extension.registrationStatus - Registration status of baby. The extension URL is: https://fhir.clevermed.com/StuctureDefinition/RelatedPerson-registrationStatus

Summary	Registration status of baby. The extension URL is: https://fhir.clevermed.com/StuctureDefinition/RelatedPerson-registrationStatus
Mandatory	Yes
Expected type	🌍codeableConcept
Write allowed	No
Data Dictionary item	None
Value set used	🌍ValueSet-BNet-Child-RegistrationStatus

* Extension:birthPlace[x] - Location of the place of birth of the baby. This extension is only available to neonatal Spine clients. The extension URL is: https://fhir.clevermed.com/StuctureDefinition/patient-birthPlace

Summary	Location of the place of birth of the baby. This extension is only available to neonatal Spine clients. The extension URL is: https://fhir.clevermed.com/StuctureDefinition/patient-birthPlace
Mandatory	Yes
Value type	🌍Reference(Location)
Write allowed	No
Data Dictionary item	None

Extension.birthPlace[x].identifier.value - Value code for the place of birth

Summary	Value code for the place of birth
Mandatory	No
Expected type	🌍string
Write allowed	No
Data Dictionary item	None

Extension.birthPlace[x].display - Text for the place of birth

Summary	Text for the place of birth
Mandatory	No
Expected type	🌍string
Write allowed	No
Data Dictionary item	None

Example JSON when WRITING to the Spine

JSON

{
  "resourceType": "Patient",
  "id": "wu6pjoidYD6k00w2RBaYOEXmrVZIUh5I2ghrGVa-UiATBOUg6QGcTys9TejfsMdc",
  "meta": {
    "profile": [
      "http://hl7.org.nz/fhir/StructureDefinition/NzPatient"
    ]
  },
  "identifier": [
    {
      "use": "official",
      "system": "https://standards.digital.health.nz/ns/nhi-id",
      "value": "NationalID123"
    }
  ],
  "active": true,
  "name": [
    {
      "use": "official",
      "family": "Solis",
      "given": [
        "Juanita",
        "Middlename"
      ]
    },
    {
      "use": "usual",
      "given": [
        "Baby"
      ]
    }
  ],
  "gender": "female",
  "birthDate": "2025-05-19",
  "multipleBirthInteger": 1
}

Example JSON when READING from the Spine

JSON

{
  "resourceType": "Patient",
  "id": "70666E6D5755465747534C486936616E65547A366F477454712D6834425667776C482E6D7646545A54356B754B3563385158794337576541436E6D54752E6D44",
  "meta": {
    "profile": [
      "http://hl7.org.nz/fhir/StructureDefinition/NzPatient"
    ]
  },
  "identifier": [
    {
      "use": "official",
      "system": "https://standards.digital.health.nz/ns/nhi-id",
      "value": "NationalID123"
    }
  ],
  "active": true,
  "name": [
    {
      "use": "official",
      "family": "Scavo",
      "given": [
        "Penny",
        "Middlename"
      ]
    },
    {
      "use": "usual",
      "given": [
        "Baby"
      ]
    }
  ],
  "gender": "female",
  "birthDate": "2025-05-19",
  "multipleBirthInteger": 1
}

CONFIDENTIAL/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. 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 cases, 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. 

Product Information: any descriptions of future functionality reflect current product direction, are for informational purposes only, and do not constitute a commitment to provide specific functionality. Timing and availability remain at System C’s discretion and are subject to change and applicable regulatory approvals.

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.

Confidentiality/document control statement version number 2.0, QMSUID-0059