UKNEONATALSUMMARY - FHIR Artifacts
This section details the FHIR artifacts that are used with the Neonatal Data Import functionality. The key FHIR resources are explained, and the dataset and relevant FHIR resources are tabled, with JSON examples.
Key FHIR Resources used
For a BadgerNet Neonatal Care Episode, an NNU-SYSTEM Client type should send any of a list of key FHIR Resources to containt the patient data for that single care episode.
To create a neonatal care Episode, the three key resources that should be included are:
Patient
EpisodeOfCare
QuestionaireResponse
For patient data during the stay in the neonatal unit, the following key FHIR Resources are required:
Note, that for each of these, a specific extension should be used if possible that identifies the time-point grouping within the neonatal care episode, as defined here.
The expectation of an NNU-SYSTEM Spine Client is that ALL Observations, Procedures, and Conditions can be sent to the BadgerNet Spine. All will be recorded in the BadgerNet neonatal care record, with the codes given by the Client. When READING the resulting FHIR Record, all of these Resources will be available as part of the complete multi-episode neonatal care record.
Where given SNOMED codes match those that are of interest to the BadgerNet Record, then this data is extracted using business-logic rules to populate BadgerNet forms as needed - without affecting the accuracy and detail of the original FHIR Resource sent in by the Spine Client.
UK Neonatal Clinical Summary set
109 Spine Dictionary data items in total
TOPIC: (NewbornBaby) - Details of baby at time of birth. 2 items.
Data item | Status | Description / Resource |
|---|---|---|
GA_Birth | LIVE | Gestation at birth |
Birth_weight | LIVE | Birth weight |
TOPIC: (ChildAdmissions) - Child care episode ADT. 4 items.
Data item | Status | Description / Resource |
|---|---|---|
PaediatricEpisodeType | NOT AVAIL. (RFC) | Paediatric episode type |
PaediatricEpisodeStart | NOT AVAIL. (RFC) | Paediatric episode start EpisodeOfCare-BNet-Child-PaediatricEpisode.period.start |
PaediatricEpisodeEnd | NOT AVAIL. (RFC) | Paediatric episode end EpisodeOfCare-BNet-Child-PaediatricEpisode.period.end |
PaediatricEpisodeLocation | NOT AVAIL. (RFC) | Paediatric episode location EpisodeOfCare-BNet-Child-PaediatricEpisode.managingOrganization |
TOPIC: (NNU-Patient-Demographics) - Neonatal demographics details. 11 items.
Data item | Status | Description / Resource |
|---|---|---|
Child.NationalID | LIVE | Child/Neonatal natioanl ID Patient-BNet-Child.identifier.coding.code |
Child.LocalHospitalID | Local hospital ID FHIR Resource for this item TBD | |
Child.Surname | LIVE | Surname Patient-BNet-Child.name.family |
Child.Forename | LIVE | Forename Patient-BNet-Child.name.given |
Child.DOB | LIVE | Date of birth Patient-BNet-Child.birthDate |
Child.Sex | LIVE | Gender at birth Patient-BNet-Child.gender |
Child.POB | Place of birth FHIR Resource for this item TBD | |
Child.BirthHeadCircumference | LIVE | Head circumference at birth |
Child.GestationAtBirth | LIVE | Gestation at birth |
Child.Birthweight | LIVE | Weight at birth |
Child.BirthLength | LIVE | Length at birth Observation-bodyheight.Value |
TOPIC: (NNU-Parent-Demographics) - Neonatal parent's demographics details. 29 items.
Data item | Status | Description / Resource |
|---|---|---|
NNPartner.DOB | IN DEV - COMING SOON | Partner Date of Birth RelatedPerson-BNet-FatherPartner.birthDate |
NNPartner.NamePrefix | IN DEV - COMING SOON | Partner Name Prefix RelatedPerson-BNet-FatherPartner.name.prefix |
NNPartner.Forename | IN DEV - COMING SOON | Partner First Name RelatedPerson-BNet-FatherPartner.name.given |
NNPartner.Surname | IN DEV - COMING SOON | Partner Last Name RelatedPerson-BNet-FatherPartner.name.family |
NNPartner.NameUse | IN DEV - COMING SOON | Partner Name Usage RelatedPerson-BNet-FatherPartner.name.use |
NNPartner.address.street | IN DEV - COMING SOON | Partner Street Address RelatedPerson-BNet-FatherPartner.address.line |
NNPartner.address.city | IN DEV - COMING SOON | Partner City RelatedPerson-BNet-FatherPartner.address.city |
NNPartner.address.postCode | IN DEV - COMING SOON | Partner Postcode RelatedPerson-BNet-FatherPartner.address.postCode |
NNPartner.Language | IN DEV - COMING SOON | Partner Language RelatedPerson-BNet-FatherPartner.communication.language |
NNPartner.TelecomHome | IN DEV - COMING SOON | Partner Home Phone RelatedPerson-BNet-FatherPartner.Telecom.Home |
NNPartner.TelecomWork | IN DEV - COMING SOON | Partner Work Phone RelatedPerson-BNet-FatherPartner.Telecom.Work |
NNPartner.TelecomMobile | IN DEV - COMING SOON | Partner Mobile Phone RelatedPerson-BNet-FatherPartner.Telecom.Mobile |
NNPartner.TelecomEmail | IN DEV - COMING SOON | Partner Email RelatedPerson-BNet-FatherPartner.Telecom.Email |
NNPartner.extension(Partner-ethnicity) | IN DEV - COMING SOON | Partner Ethnicity RelatedPerson-BNet-FatherPartner.extension:patientEthnicity |
NNMother.NID | IN DEV - COMING SOON | Mother National ID Patient-BNet-Mother.identifier.coding.code |
NNMother.HID | IN DEV - COMING SOON | Mother Hospital ID Patient-BNet-Mother.identifier.coding.code |
NNMother.DOB | IN DEV - COMING SOON | Mother Date of Birth Patient-BNet-Mother.birthDate |
NNMother.NamePrefix | IN DEV - COMING SOON | Mother Name Prefix Patient-BNet-Mother.name.prefix |
NNMother.Forename | IN DEV - COMING SOON | Mother First Name Patient-BNet-Mother.name.given |
NNMother.Surname | IN DEV - COMING SOON | Mother Last Name Patient-BNet-Mother.name.family |
NNMother.NameUse | IN DEV - COMING SOON | Mother Name Usage Patient-BNet-Mother.name.use |
NNMother.address.street | IN DEV - COMING SOON | Mother Street Address Patient-BNet-Mother.address.line |
NNMother.address.city | IN DEV - COMING SOON | Mother City Patient-BNet-Mother.address.city |
NNMother.address.postCode | IN DEV - COMING SOON | Mother Postcode Patient-BNet-Mother.address.postCode |
NNMother.Language | IN DEV - COMING SOON | Mother Language Patient-BNet-Mother.communication.language |
NNMother.TelecomHome | IN DEV - COMING SOON | Mother Home Phone Patient-BNet-Mother.Telecom.Home |
NNMother.TelecomWork | IN DEV - COMING SOON | Mother Work Phone Patient-BNet-Mother.Telecom.Work |
NNMother.TelecomMobile | IN DEV - COMING SOON | Mother Mobile Phone Patient-BNet-Mother.Telecom.Mobile |
NNMother.TelecomEmail | IN DEV - COMING SOON | Mother Email Patient-BNet-Mother.Telecom.Email |
TOPIC: (NNU-Birth) - Neonatal details of labour, delivery, and birth. 4 items.
Data item | Status | Description / Resource |
|---|---|---|
ChildCongenitalMalformations | LIVE | Congenital malformations at birth |
GA_Birth | LIVE | Gestation at birth |
Birth_weight | LIVE | Birth weight |
Birth_Length | Length at birth FHIR Resource for this item TBD |
TOPIC: (NNU-Admission) - Details of a single admission to a neonatal unit. 6 items.
Data item | Status | Description / Resource |
|---|---|---|
EpisodicBadgerId | LIVE | Episodic anonymous BadgerID for all BadgerNet single episodes of care EpisodeOfCare-BNet-Child-PaediatricEpisode.identifier[use='secondary'].value |
LocalHospitalId | LIVE | Local hospital ID for single episode of care EpisodeOfCare-BNet-Child-PaediatricEpisode.identifier[use='official'].value |
PaediatricEpisodeType | NOT AVAIL. (RFC) | Paediatric episode type |
PaediatricEpisodeStart | NOT AVAIL. (RFC) | Paediatric episode start EpisodeOfCare-BNet-Child-PaediatricEpisode.period.start |
PaediatricEpisodeEnd | NOT AVAIL. (RFC) | Paediatric episode end EpisodeOfCare-BNet-Child-PaediatricEpisode.period.end |
PaediatricEpisodeLocation | NOT AVAIL. (RFC) | Paediatric episode location EpisodeOfCare-BNet-Child-PaediatricEpisode.managingOrganization |
TOPIC: (NNAP) - National Neonatal Audit Programme (NNAP) data items. 14 items.
Data item | Status | Description / Resource |
|---|---|---|
Child.FinalOutcome | IN DEV - COMING SOON | Overall result of neonatal care at discharge or transfer. |
Child.CoreTemperature | IN DEV - COMING SOON | Core temperature of neonate. |
Child.BreastmilkFeeding | IN DEV - COMING SOON | Administration of expressed breast milk or direct breastfeeding. |
Child.DiscussionWithParents | IN DEV - COMING SOON | Documented communication with parents about care plan. |
Child.RespiratorySupport | IN DEV - COMING SOON | Assistance to maintain ventilation and oxygenation. |
Child.CordClamping | IN DEV - COMING SOON | Applying a clamp to the umbilical cord after birth to stop blood flow. |
Child.RopScreening | IN DEV - COMING SOON | Eye exam for Retinopathy of Prematurity. |
Child.CranialUltrasound | IN DEV - COMING SOON | Ultrasound to assess neonatal brain structures. |
Child.WardRound/ClincalReview | IN DEV - COMING SOON | A scheduled review of the infant’s condition and care plan by the neonatal team. |
Child.RopScreening | IN DEV - COMING SOON | Eye exam for Retinopathy of Prematurity. |
Child.PretermBrainInjury(Ivh) | IN DEV - COMING SOON | Intraventricular haemorrhage in preterm infants. |
Child.DrugsGiven | IN DEV - COMING SOON | General administration of medications. MedicationAdministration-BNet-Child-NNMedication.medicationCodeableConcept |
Child.BloodstreamInfection | Bloodstream infection FHIR Resource for this item TBD | |
Child.NecrotisingEnterocolitis | Necrotising enterocolitis. FHIR Resource for this item TBD |
TOPIC: (NCCMDS) - Neonatal Critical Care Minimum Data Set (NCCMDS) data items. 30 items.
Data item | Status | Description / Resource |
|---|---|---|
Child.TracheostomyCare | IN DEV - COMING SOON | Tracheostomy tube in place. |
Child.ChestDrainPresent | IN DEV - COMING SOON | Thoracic drain in place. |
Child.VentricularTapPresent | IN DEV - COMING SOON | Procedure or device for aspirating cerebrospinal fluid from ventricle in place. |
Child.StomaInSitu | IN DEV - COMING SOON | Opening on abdominal wall for diversion in place. |
Child.AbdominalSiloInSitu | IN DEV - COMING SOON | Device in place for staged closure of abdominal wall defects. |
Child.RespiratorySupport | IN DEV - COMING SOON | Assistance to maintain ventilation and oxygenation. |
Child.ParenteralNutrition | IN DEV - COMING SOON | The administration of nutrients directly into the bloodstream via an intravenous route. |
Child.FeedingMethod | IN DEV - COMING SOON | Approach used for nutrition delivery. |
Child.LinesInSitu | IN DEV - COMING SOON | Presence of vascular access devices. |
Child.EpiduralCatheterInSitu | IN DEV - COMING SOON | Catheter in place in epidural space |
Child.UrinaryCatheterInSitu | IN DEV - COMING SOON | Catheter in place inserted into bladder for urine drainage. |
Child.ImmunoglobulinsToday | IN DEV - COMING SOON | Administration of immunoglobulin therapy during current day. |
Child.ExchangeTransfusion | IN DEV - COMING SOON | Procedure where infant’s blood is replaced with donor blood. |
Child.PeritonealDialysis | IN DEV - COMING SOON | Renal replacement therapy using dialysate in peritoneal cavity. |
Child.RopScreening | IN DEV - COMING SOON | Eye exam for Retinopathy of Prematurity. |
Child.ExchangeTransfusion | IN DEV - COMING SOON | Procedure where infant’s blood is replaced with donor blood. |
Child.IntravenousBloodProducts | IN DEV - COMING SOON | Administration of blood components via IV. |
Child.PeritonealDialysis | IN DEV - COMING SOON | Renal replacement therapy using dialysate in peritoneal cavity. |
Child.Haemofiltration | IN DEV - COMING SOON | Continuous renal replacement therapy filtering blood. |
Child.BarrierNursed | IN DEV - COMING SOON | Isolation nursing using protective measures. |
Child.Phototherapy | IN DEV - COMING SOON | Treatment for neonatal jaundice using special light. |
Child.Cooling | IN DEV - COMING SOON | Therapeutic hypothermia for suspected brain injury. |
Child.RopScreening | IN DEV - COMING SOON | Eye exam for Retinopathy of Prematurity. |
Child.Convulsions | IN DEV - COMING SOON | Seizure activity in neonates. |
Child.NeonatalAbstinenceSyndrome | IN DEV - COMING SOON | Withdrawal symptoms in newborns exposed to drugs in utero. |
Child.RecurrentApnoea | IN DEV - COMING SOON | Repeated episodes of cessation of breathing. |
Child.ContinuousInfusionOfInotrope | IN DEV - COMING SOON | Administration of drugs to support cardiac output. MedicationAdministration-BNet-Child-NNMedication.medicationCodeableConcept |
Child.ContinuousInfusionOfInsulin | IN DEV - COMING SOON | IV insulin administration. MedicationAdministration-BNet-Child-NNMedication.medicationCodeableConcept |
Child.DrugsGiven | IN DEV - COMING SOON | General administration of medications. MedicationAdministration-BNet-Child-NNMedication.medicationCodeableConcept |
Child.IntravenousMedication | IN DEV - COMING SOON | Medication given via IV route. MedicationAdministration-BNet-Child-NNMedication.medicationCodeableConcept |
TOPIC: (BAPMHRG) - British Association of Perinatal Medicine (BAPM) / Healthcare Resource Group (HRG) data items. 32 items.
Data item | Status | Description / Resource |
|---|---|---|
Child.ChestDrainPresent | IN DEV - COMING SOON | Thoracic drain in place. |
Child.ReplogleTubePresent | IN DEV - COMING SOON | Replogle tube in place for continuous suction and decompression. |
Child.GastroschisisSiloPresent | IN DEV - COMING SOON | Temporary silo bag in place. |
Child.ExternalVentricularDrainPresent | IN DEV - COMING SOON | Catheter system draining cerebrospinal fluid externally from ventricles in place. |
Child.StomaInSitu | IN DEV - COMING SOON | Opening on abdominal wall for diversion in place. |
Child.WeightDuringStay | IN DEV - COMING SOON | Recorded measurements of infant’s weight during episode of care. |
Child.RespiratorySupport | IN DEV - COMING SOON | Assistance to maintain ventilation and oxygenation. |
Child.NasopharyngealAirwayInSitu | IN DEV - COMING SOON | Tube in place through nostril into nasopharynx to maintain airway. |
Child.ParenteralNutrition | IN DEV - COMING SOON | The administration of nutrients directly into the bloodstream via an intravenous route. |
Child.FeedingMethod | IN DEV - COMING SOON | Approach used for nutrition delivery. |
Child.LinesInSitu | IN DEV - COMING SOON | Presence of vascular access devices. |
Child.EpiduralCatheterInSitu | IN DEV - COMING SOON | Catheter in place in epidural space |
Child.UrinaryCatheterInSitu | IN DEV - COMING SOON | Catheter in place inserted into bladder for urine drainage. |
Child.SurgeryToday | IN DEV - COMING SOON | Infant underwent surgical procedure on current date. |
Child.ExchangeTransfusion | IN DEV - COMING SOON | Procedure where infant’s blood is replaced with donor blood. |
Child.PeritonealDialysis | IN DEV - COMING SOON | Renal replacement therapy using dialysate in peritoneal cavity. |
Child.RopScreening | IN DEV - COMING SOON | Eye exam for Retinopathy of Prematurity. |
Child.ExchangeTransfusion | IN DEV - COMING SOON | Procedure where infant’s blood is replaced with donor blood. |
Child.PeritonealDialysis | IN DEV - COMING SOON | Renal replacement therapy using dialysate in peritoneal cavity. |
Child.BarrierNursed | IN DEV - COMING SOON | Isolation nursing using protective measures. |
Child.Phototherapy | IN DEV - COMING SOON | Treatment for neonatal jaundice using special light. |
Child.CfamMonitoring | IN DEV - COMING SOON | Cerebral Function Analysing Monitor for brain activity. |
Child.Cooling | IN DEV - COMING SOON | Therapeutic hypothermia for suspected brain injury. |
Child.AnySurgery | IN DEV - COMING SOON | Indicates infant underwent any surgical procedure. |
Child.RopTreatment/Surgery | IN DEV - COMING SOON | Intervention for retinopathy of prematurity. |
Child.RopScreening | IN DEV - COMING SOON | Eye exam for Retinopathy of Prematurity. |
Child.NeonatalAbstinenceSyndrome | IN DEV - COMING SOON | Withdrawal symptoms in newborns exposed to drugs in utero. |
Child.OesophagealAtresia | IN DEV - COMING SOON | Congenital absence or closure of the oesophagus. |
Child.ProstaglandinInfusionOrInotropeOrVasodilatorGiven | IN DEV - COMING SOON | Infusion of prostaglandin or related drugs. MedicationAdministration-BNet-Child-NNMedication.medicationCodeableConcept |
Child.DrugsGiven | IN DEV - COMING SOON | General administration of medications. MedicationAdministration-BNet-Child-NNMedication.medicationCodeableConcept |
Child.IvDrugsGiven | IN DEV - COMING SOON | Drugs administered intravenously. MedicationAdministration-BNet-Child-NNMedication.medicationCodeableConcept |
Child.Prostaglandin | IN DEV - COMING SOON | Prostaglandin administered to child MedicationAdministration-BNet-Child-NNMedication.medicationCodeableConcept |