FHIR Implementation Guide: Pregnancy Card Kraam DRAFT

Uit informatiestandaarden
Versie door Lilian Minne (overleg | bijdragen) op 16 jan 2024 om 15:49 (Use case: retrieve pregnancy card)
Ga naar: navigatie, zoeken



1 Introduction

This page describes the process of collecting maternity care data in a patient's personal health record (PHR). The process is initiated by the patient (pregnant woman).

This Implementation Guide (IG) is a technical representation of the functional design and follows the principles of the general use case overarching principles.

Technical details of the FHIR resources and structure definitions described in this IG can be found in the birthcare information standard and the Simplifier Geboortezorg STU3 package.

The technical specifications described in this IG are based on the PWD (Perinataal Woordenboek & Dataset) 3.2.

2 Actors involved

The table shows the relevant actors, systems and FHIR CapabilityStatements. The CapabilityStatements demonstrate the minimum conformance requirements for the described use cases.

Actors Systems FHIR CapabilityStatements
Name Description Name Description Name Description
Patient The user of a personal healthcare environment PHR Personal health record CapabilityStatement:Receive FHIR client requirements
Healthcare provider The user of a XIS XIS Healthcare information system CapabilityStatement:Send FHIR server requirements

3 Boundaries and relationships

Go to Afsprakenstelsel

This FHIR implementation guide assumes that the PHR system is able to make a connection with the XIS and create resources. It does not provide information on finding the right XIS nor does it provide information about security. These infrastructure and interface specifications are described in the 'MedMij Afsprakenstelsel'.

The Maternity Care Data Set is an addition to the Pregnancy Card (Dutch: gegevensdienst Integrale Zwangerschapskaart), which has overlap with other standards such as the BgZ (Basisgegevensset Zorg), Medication Process, Vital Signs and Lab Results. The Pregnancy Card and Maternity Care Data Set use the same HCIM based FHIR profiles for exchanging information as used in other standards extended with additional birthcare specific profiles. Most of these birthcare specific profiles are derived from the base HCIM FHIR profiles. For example, the bc-Woman is in fact a nl-core-patient with additional specifications for relating the pregnant woman to the (unborn) child.

4 Use case: retrieve maternity care data set

This use case covers the process of retrieving the Maternity Care Data Set in the Personal Health Record (PHR) of the (pregnant) woman.

4.1 PHR: request message

The PHR system requests the Maternity Care Data Set using individual search interactions. The Maternity Care Data Set consists of multiple FHIR resources with certain constraints. To obtain the patient's Maternity Care Data Set, the client can use multiple individual search operations based on specified search queries. The interactions are performed by an HTTP GET as shown:

GET [base]/[type]{?[parameters]}

4.1.1 List of requests

To retrieve all known data of the Maternity Care Data Set, a client has to execute the following requests.


4.1.2 PWD to FHIR mapping table

The table below shows in the first three columns the PWD 3.2 data elements, in the fifth and sixth column their mapping to the FHIR profiles.

The mapping table below is based on the corresponding ART-DECOR transaction [...]


4.2 XIS: response message

The returned data to the PHR should conform to the profiles listed in FHIR profiles.

5 FHIR profiles

5.1 Generic HCIM profiles

Profile name FHIR Resource HCIM EN Canonical URL
nl core Patient Patient Patient http://nictiz.nl/fhir/StructureDefinition/nl-core-patient
nl core Organization Organization HealthcareProvider http://nictiz.nl/fhir/StructureDefinition/nl-core-organization
nl core Practitioner Practitioner HealthProfessional http://nictiz.nl/fhir/StructureDefinition/nl-core-practitioner
nl core PractitionerRole PractitionerRole http://nictiz.nl/fhir/StructureDefinition/nl-core-practitionerrole
zib AlcoholUse Observation AlcoholUse http://nictiz.nl/fhir/StructureDefinition/zib-AlcoholUse
zib ApgarScore Observation ApgarScore http://nictiz.nl/fhir/StructureDefinition/zib-ApgarScore
zib BloodPressure Observation BloodPressure http://nictiz.nl/fhir/StructureDefinition/zib-BloodPressure
zib BodyHeight Observation BodyHeight http://nictiz.nl/fhir/StructureDefinition/zib-BodyHeight
zib BodyWeight Observation BodyWeight http://nictiz.nl/fhir/StructureDefinition/zib-BodyWeight
zib DrugUse Observation DrugUse http://nictiz.nl/fhir/StructureDefinition/zib-DrugUse
zib HeadCircumference Observation HeadCircumference http://nictiz.nl/fhir/StructureDefinition/zib-HeadCircumference
zib LaboratoryTestResult-Observation Observation LaboratotoryTestResult http://nictiz.nl/fhir/StructureDefinition/zib-LaboratoryTestResult-Observation
zib MedicalDeviceProduct Observation MedicalDevice http://nictiz.nl/fhir/StructureDefinition/zib-MedicalDeviceProduct
zib Pregnancy Condition Pregnancy http://nictiz.nl/fhir/StructureDefinition/zib-Pregnancy
zib Pregnancy-DateLastMenstruation Observation http://nictiz.nl/fhir/StructureDefinition/zib-Pregnancy-DateLastMenstruation
zib Pregnancy-Gravidity Observation http://nictiz.nl/fhir/StructureDefinition/zib-Pregnancy-Gravidity
zib Pregnancy-Parity Observation http://nictiz.nl/fhir/StructureDefinition/zib-Pregnancy-Parity
zib Pregnancy-PregnancyDuration Observation http://nictiz.nl/fhir/StructureDefinition/zib-Pregnancy-PregnancyDuration
zib Pregnancy-TermDate Observation http://nictiz.nl/fhir/StructureDefinition/zib-Pregnancy-TermDate
zib Problem Condition Problem http://nictiz.nl/fhir/StructureDefinition/zib-Problem
zib Procedure Procedure Procedure http://nictiz.nl/fhir/StructureDefinition/zib-Procedure
zib ProcedureRequest ProcedureRequest PlannedCareActivityForTransfer http://nictiz.nl/fhir/StructureDefinition/zib-ProcedureRequest
zib TobaccoUse Observation TobaccoUse http://nictiz.nl/fhir/StructureDefinition/zib-TobaccoUse

5.2 Birthcare specific profiles

Profile name Pattern FHIR Resource HCIM EN Canonical URL Description
bc-Birth Procedure Procedure http://nictiz.nl/fhir/StructureDefinition/bc-Birth A Procedure profile describing the birth of a child as defined by BabyConnect.

This groups findings and procedures related to a particular child in a delivery - important in multiple births. A pregnancy can lead to one delivery Procedure and one or multiple birth Procedures. In multiple birth, multiple birth instances point to the same delivery Procedure. A birth also provides the relation between a child and its mother: The mother Patient is the subject of the delivery Procedure and the child Patient is the subject of the birth Procedure.

A Birth has:

  • A partOf extension, pointing to the Delivery
  • The subject is the Child
  • The context is the Maternal Record EpisodeOfCare
  • The pregnancy is captured in the reasonReference
bc-Child Patient Patient http://nictiz.nl/fhir/StructureDefinition/bc-Child A Patient profile for the child Patient as defined by BabyConnect.

Child is a separate Patient.

bc-ChildObservation Child-related Observation Observation http://nictiz.nl/fhir/StructureDefinition/bc-ChildObservation An Observation profile describing child-related Observations (not captured in other existing profiles), as defined by BabyConnect. Child-related Observations, such as Apgar score and birthweight, pertain to the child Patient, which is the subject of the Observation. If the child is unborn and no patient record exists for the child, bc-FetusObservation should be used instead.
  • Child observations refer to the EpisodeOfCare with Observation.context.reference
bc-DeliveryObservation Pregnancy-related disorder Observation http://nictiz.nl/fhir/StructureDefinition/bc-DeliveryObservation An Observation profile describing delivery-related Observations, as defined by BabyConnect.

Observations such as onset of labor or blood loss pertain to a delivery Procedure.

  • Delivery-related Observations use focus extension to point to the delivery Procedure they're about.
  • Delivery-related Observations refer to the EpisodeOfCare with Observation.context.reference
bc-DeliveryProcedure Procedure Procedure http://nictiz.nl/fhir/StructureDefinition/bc-DeliveryProcedure A Procedure profile describing the delivery (including uncomplicated natural births for consistency), as defined by BabyConnect. A pregnancy can lead to one delivery Procedure, even in multiple birth. The mother Patient is the subject of the delivery Procedure.
  • Delivery refers to the EpisodeOfCare with Procedure.context.reference
  • Delivery refers to the Pregnancy with Procedure.reasonReference.reference

A delivery Procedure is related to one or more birth Procedures. The child Patient is the subject of the birth Procedure. In case of multiple birth, multiple birth Procedures will point to the same delivery Procedure.

bc-DisorderOfChild Child disorder Condition Problem http://nictiz.nl/fhir/StructureDefinition/bc-DisorderOfChild A Condition profile describing child disorders as defined by BabyConnect.

Child disorders, such as chromosomal and congenital abnormalities or other problems are disorders of the child. The subject is either the child Patient (in case the child is born or a fetal patient record is in place) or the woman Patient (in case the child is unborn and there is no fetal patient record in place). In the second case, use the bodySite reference extension to refer to the fetus.

  • Child disorders can refer to the EpisodeOfCare with Condition.context.reference
  • A ConceptMap is available to map verification status to accepted FHIR codes
bc-DisorderOfLaborAndDelivery Condition Problem http://nictiz.nl/fhir/StructureDefinition/bc-DisorderOfLaborAndDelivery A Condition profile describing disorders and complications related to labor and delivery as defined by BabyConnect. These disorders are part of the delivery, which is defined in the part of extension.
  • Delivery-related Disorders use partOf extension to point to Condition they're about.
  • Delivery-related Conditions refer to the EpisodeOfCare with Observation.context.reference
bc-DisorderOfPregnancy Pregnancy-related disorder Condition Problem http://nictiz.nl/fhir/StructureDefinition/bc-DisorderOfPregnancy A Condition profile describing disorders related to a pregnancy as defined by BabyConnect. For example, Conditions such as cholestasis and hypertension do not (only) pertain to the Patient but to a particular pregnancy.
  • Pregnancy-related Observations use partOf extension to point to Condition they're about.
  • In some cases the partOf Condition may not be available. The BGZ for instance does not relate Conditions to particular pregnancies.
  • Pregnancy-related Conditions refer to the EpisodeOfCare with Observation.context.reference
bc-DisorderPostPartum Condition Problem http://nictiz.nl/fhir/StructureDefinition/bc-DisorderPostPartum A Condition profile describing post partum disorders or complications as defined by BabyConnect. Post partum disorders, such as post partum depression, occur after delivery and are related to the Delivery Procedure.
  • A partOf extension is used to point to the Delivery.
  • The context is the Maternal Record or an Encounter.
bc-Encounter Encounter Encounter http://nictiz.nl/fhir/StructureDefinition/bc-Encounter An Encounter profile describing birthcare related encounters as defined by BabyConnect. The woman Patient is the subject of the Encounter.
  • Encounter.type specifies the type of encounter, e.g. prenatal visit, postnatal follow up or counseling.
  • Encounter.episodeOfCare points to the maternal record that is the context of the Encounter
  • Encounter.diagnosis points to the pregnancy (and optional other Conditions)
  • Encounter.serviceProvider points to the responsible Organization for the Encounter
bc-FetalHeartRate Observation http://nictiz.nl/fhir/StructureDefinition/bc-FetalHeartRate An Observation profile describing fetal heart rate as defined by BabyConnect. The base definition is a fetus-related Observation. Fetus-related Observations are Observations about a fetus, which is the focus of the Observation (extension). Fetus identification is necessary in these Observations, especially in multiple pregnancy. There are two ways of using this profile depending on the presence of a patient / fetus record for the unborn child:
  1. A patient / fetus record is present. The subject of the Observation is the (unborn) child Patient. The focus extension can be left blank.
  2. A patient / fetus record is not present. The subject of the Observation is the woman Patient. The focus extension refers to the fetus BodySite.
bc Fetus BodySite http://nictiz.nl/fhir/StructureDefinition/bc-Fetus A BodySite profile as defined by BabyConnect.

This BodySite profile refers to the unborn fetus in case no fetal record (yet) exists. In case a fetal record is created the unborn fetus will be registered as a (child) Patient.

bc-MaternalObservation Patient-related Observation Observation http://nictiz.nl/fhir/StructureDefinition/bc-MaternalObservation An Observation profile describing patient-related Observations, which are not captured in other existing profiles, as defined by BabyConnect.

Patient-related Observations are findings related to the (pregnant) woman, before, during or after pregnancy childbirth. The pregnant woman is the subject, the context is the pregnancy file (EpisodeOfCare). Examples are risk status or maternal ultrasound observations.

bc-MaternalRecord EpisodeOfCare http://nictiz.nl/fhir/StructureDefinition/bc-MaternalRecord An EpisodeOfCare profile describing a maternal record (or pregnancy file) as defined by BabyConnect.

Each pregnancy is a Condition. It is also represented as an EpisodeOfCare (maternal record) for each involved Organization. The maternal record defines care responsibility for a specific period of time and groups all data related to this period of care. It includes references to an Organization and responsible Practitioner.

The maternal record defines care responsibility for a specific period of time and groups all data related to this period of care:

  1. The (overarching) maternal record groups all data related to one pregnancy (.type = 364320009)
  2. A sub record groups all data related to a specific perinatal period within the pregnancy (.type contains a code for the perinatal period and .partOf contains a reference to the overarching maternal record)

Relations between the pregnancy (Condition) and the overarching maternal record (EpisodeOfCare):

  • Condition points to the EpisodeOfCare through a EpisodeOfCare.context.reference element. (Note: different providers may each have their own Condition resource.)
  • EpisodeOfCare points to the Condition through a EpisodeOfCare.diagnosis.condition element.
  • Condition points to the Patient with Condition.subject.reference
  • Condition.status must be 'active' for ongoing pregnancies and 'inactive' for past ones.
bc-MotherOf RelatedPerson http://nictiz.nl/fhir/StructureDefinition/bc-MotherOf A RelatedPerson profile describing the relation between mother and child as defined by BabyConnect.

The RelatedPerson is the mother, which is a related person of the child Patient.

  • The RelatedPerson.patient refers to the child Patient
  • The RelatedPerson.link refers to the mother Patient, RelatedPerson.link.type is set to seealso
bc-ObstetricProcedure Procedure Procedure http://nictiz.nl/fhir/StructureDefinition/bc-ObstetricProcedure A Procedure profile describing obstetric procedures, as defined by BabyConnect. Obstetric procedures are procedures related to pregnancy, birth and delivery, such as vacuum delivery.
  • For obstetric procedures related to the pregnancy, use Procedure.reasonReference
  • For obstetric procedures related to birth and delivery, use the (optional) partOf extension to point to the Delivery (maternal data) or the Birth (child-specific data)
  • The context is the Maternal Record or an Encounter
bc-PregnancyObservation Pregnancy-related Observation Observation http://nictiz.nl/fhir/StructureDefinition/bc-PregnancyObservation An Observation profile describing pregnancy-related Observations, as defined by BabyConnect.

Observations such as gravidity and parity do not (only) pertain to the Patient but also to a particular pregnancy.

  • Pregnancy-related Observations use the focus extension to point to the Condition they are about. Without this, all gravidities would only be Observations about a Patient.
  • Pregnancy-related Observations refer to the EpisodeOfCare with Observation.context.reference
bc-Woman Patient Patient http://nictiz.nl/fhir/StructureDefinition/bc-Woman A Patient profile describing the woman who is or was pregnant as defined by BabyConnect.

The pregnant woman, a FHIR patient, is the core of each pregnancy.

6 Release notes

Release notes can be found on the functional design page.

7 Support

For questions and change requests regarding this IG, please create a ticket in BITS.