Gebz:V1.2 FHIR IG

Introduction

This page details the HL7 FHIR requirements for exchanging the BirthCare (Geboortezorg) data.

The FHIR Implementation Guide for BirthCare is independent of the functional specifications. We expect the FHIR BirthCare IG to be compliant with datasets 2.3, 3.1 and 3.2. We do expect backwards compatible additions to the FHIR BirthCare IG for the latter datasets. The FHIR BirthCare IG does contain version-specific mappings to the various datasets, for now only 2.3 and 3.2 mappings.

The functional view for BirthCare (Geboortezorg) 3.2 is described in Functioneel. The functional view for BirthCare (Geboortezorg) 2.3 is described in Functioneel. Functional specifications for other datasets will follow.

Technical details of the FHIR resources and structure definitions described in this Implementation Guide (IG) can be found in the Simplifier Geboortezorg STU3 project. This IG provides links to the required resources and structure definitions for each use case.

A high level overview

FHIR Resources and StructureDefinitions

Types of resources and relations between them

Pregnancy and maternal record

A pregnancy (Condition) starts with a pregnant woman (Patient). Her data is registered in a maternal record (EpisodeOfCare). The maternal record contains references to the pregnant woman (subject), the pregnancy (condition), the care manager (careManager:Practitioner) and managing organization (managingOrganization:Organization).

Birth and Delivery

If all goes well a pregnancy ends with a delivery (Procedure). A delivery is related to the mother (subject). It has 3 stages: 1. dilation, 2. birth of one or more children and 3. afterbirth. There are no separate resource for the first and third stages of delivery, but the second stage of delivery is another Procedure, which is related to the child (subject). The Birth Procedure is part of the Delivery Procedure and in case of a multiple pregnancy, multiple Birth Procedures can be part of the same Delivery Procedure.

Obstetric procedures

Obstetric procedures are procedures related to pregnancy, birth and delivery. These procedures can be part of (partOf) a Birth Procedure (in case of child-related procedures, like a c-section) or a Delivery Procedure (in case of maternal procedures, like a blood transfusion). The partOf element can also be left blank when the procedure is linked to the pregnancy (record), but not to birth and delivery.

Relations between pregnancy, birth and delivery

A pregnancy (Condition), birth (Procedure) and delivery (Procedure) are all related to a maternal record (EpisodeOfCare) through their context element, either with a direct reference to the EpisodeOfCare or an indirect reference to an Encounter which in itself is linked to the maternal record (EpisodeOfCare). In addition, the Birth and Delivery Procedures both include a reference to the pregnancy (reasonReference).

Patterns

For Observations and Conditions, which are often very similar, we follow patterns: an implementer will only need to implement the pattern and an associated table with codes, and be able to support all Observations. So for Observations pertaining to a particular pregnancy (not to the woman - she may have multiple pregnancies on record, neither to the delivery) all Observations will link to the Pregnancy Condition. So instead of having to inspect StructureDefinitions separately for each pregnancy observations, following a single pattern will do. The pattern has it's own StructureDefinition, so the FHIR profile is still complete. Likewise Observations for the mother, delivery and child follow patterns.

Pattern tables can be found on individual pattern pages, see links below, and on Gebz:V2.3_FHIR_mapping_addendum for 2.3 mappings and Gebz:V3.2_FHIR_mapping_addendum for 3.2 mappings.

Observation patterns

Observations follow patterns based on their subject (either the child or the mother patient) and their focal subject (either the pregnancy, birth or delivery), see table below. The use of focus extensions is a pre-adopt of FHIR R4, where it is part of Observation: "What the observation is about, when it is not about the subject of record." Focus is required for all Observations which do not pertain to the Patient. In R4, use of focus permits "reverse include" queries (give me all Observations with focus element X). In STU3, this could be a custom search.

Pattern	Subject	Focus
Patient-related Observations	Mother patient	x
Pregnancy-related Observations	Mother patient	Pregnancy
Delivery-related Observations	Mother patient	Delivery
Birth-related Observations	Mother patient	Birth
Child-related Observations	Child patient	x

Condition patterns

Conditions follow patterns based on their category (disorders related to either pregnancy, labor and delivery, postpartum or child disorders). Pregnancy, birth and delivery related disorders use partOf to link to these concepts, see table below.

Pattern	Subject	Category	PartOf
Pregnancy-related disorder	Mother patient	173300003	Pregnancy
Delivery-and-birth-related disorder	Mother patient	362972006	Delivery
Postpartum disorder	Mother patient	362973001	Delivery
Child-related disorder	Child patient	414025005	x

Addendum FHIR mapping

Profile	Pattern	FHIR resource	Description
bc-Fetus		BodySite	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-CareAgreement		CarePlan	A CarePlan profile describing the care arrangement between a pregnant woman and her caregiver(s) as defined by BabyConnect.
bc-IndividualCareplan		CarePlan	A CarePlan profile describing the individual care plan of a pregnant woman as defined by BabyConnect.
bc-MultidisciplinaryTeamMeeting-Plan		CarePlan	A CarePlan profile related to the multidisciplinary team meeting as defined by BabyConnect.
bc-CareTeam		CareTeam	A CareTeam profile describing the involvement of (other) care providers in the care of a patient and her child, such as a pediatrician. - These care providers are included as participants in the CareTeam using the CareTeam.participant.member element. Participants may either be Practitioners or Organizations. - Their role and period of involvement are described at the participant level (that is CareTeam.participant.role and CareTeam.participant.period). - The reason of involvement is described in CareTeam.reasonCode
bc-ClinicalImpression		ClinicalImpression	A ClinicalImpression profile describing the caregiver's professional assessment around the woman's pregnancy as defined by BabyConnect.
bc-TransactionComposition		Composition	A Composition profile describing the Composition resource that should be present in the Transaction Bundle as defined by BabyConnect. The Composition resource should include entries for each resource that is included in the transaction.
bc-DisorderOfChild	Child disorder	Condition	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	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	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	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-LegalSituation-LegalStatus		Condition	A Condition profile describing legal status as defined by BabyConnect. The legal status indicates the basis on which the patient is staying in a healthcare organization. This can be either voluntary or involuntary, however the legal status is always determined by a judge.
bc-LegalSituation-Representation		Condition	A Condition profile describing legal representation as defined by BabyConnect. Representation is important in situations where a person is legally not competent to give permission and/or factually (partly) incapable of doing so. A representative supports and takes decisions in the interest of the representee when they cannot do so themselves (temporarily or permanently).
bc-TreatmentDirective		Consent	A Consent profile as defined by BabyConnect.
bc-DigitalVaginalExamination		DiagnosticReport	A DiagnosticReport profile describing a digital vaginal examination as defined by BabyConnect. The digital vaginal examination DiagnosticReport groups Observations related to the digital vaginal examination. The woman Patient is the subject of the report. - This report refers to the EpisodeOfCare with DiagnosticReport.context.reference
bc-PregnancyUltraSound		DiagnosticReport	A DiagnosticReport profile describing a pregnancy ultrasound as defined by BabyConnect. The ultrasound DiagnosticReport groups Observations related to the pregnancy ultrasound. The woman Patient is the subject of the report. - This report refers to the EpisodeOfCare with DiagnosticReport.context.reference
bc-ChildBirthAssistance		Encounter	An Encounter profile describing (childbirth) assistance to a woman in labor as defined by BabyConnect. - The woman Patient is the subject of the Encounter - The place of birth is described in Encounter.class using a ConceptMap to map values to available FHIR codes - The Encounter.diagnosis element refers to the Pregnancy (Condition) - The Encounter.participant element containts a list of care providers that were present during delivery. Family members could also be included in this list. - Additional details can be defined at participant level, such as participant type and time of arrival. The latter uses an extension at participant level with a coded list of time of arrival. - Childbirth Assistance refers to the EpisodeOfCare with Encounter.EpisodeOfCare.reference
bc-Encounter		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-MultidisciplinaryTeamMeeting		Encounter	An Encounter profile describing a team care conference as defined by BabyConnect. In a team care conference caregivers discuss patient cases in absence of the patient.
bc-ChildRecord		EpisodeOfCare	An EpisodeOfCare profile describing the child care record as defined by BabyConnect.
bc-MaternalRecord		EpisodeOfCare	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-FamilyMemberHistory		FamilyMemberHistory	A FamilyMemberHistory profile as defined by BabyConnect describing the relevant family history of a pregnant woman. - FamilyMemberHistory.patient points to the woman Patient - FamilyMemberHistory.relationship describes the relation (e.g. father or sister) of the family member to the woman Patient - FamilyMemberHistory.condition points to the (significant) condition(s) of the family member. The optional contributedToDeath extension can be used to indicate if a specific condition caused death - FamilyMemberHistory.deceased[x] indicates whether the family member has deceased. This can either be a boolean (true/false) or more specific information can be provided like age. If an age is present, it implies that the family member is deceased and in this case the boolean value should be left out.
bc-IndividualCarePlan-Goal		Goal	A Goal profile describing the goal(s) of an individual care plan of a pregnant woman as defined by BabyConnect.
bc-AbilityToTakeCareOfChild		Observation	An Observation profile describing the woman's ability to take care of her child as defined by BabyConnect. Patient-related Observations are about the (pregnant) woman, which is the subject of the Observation.
bc-AmnioticFluid		Observation	An Observation profile describing the amniotic fluid as defined by BabyConnect. 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-BarthelIndex		Observation	An Observation profile describing self-reliance of the woman after birth as defined by BabyConnect. The subject is the woman Patient.
bc-BirthControl		Observation	An Observation profile describing birth control as defined by BabyConnect.
bc-BirthObservation	Birth-related Observation	Observation	An Observation profile describing birth-related Observations as defined by BabyConnect. Birth-related Observations, such as parturition type, pertain to a birth, which is the focus of the Observation (extension). They are also about the mother, which still is the subject of the Observation. - Birth-related Observations use focus extension to point to a birth - Birth-related Observations refer to the EpisodeOfCare with Observation.context.reference
bc-BreastFindings		Observation	An Observation profile describing findings related to the breasts as defined by BabyConnect. The subject is the woman Patient.
bc-ChildObservation	Child-related Observation	Observation	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	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-DonorObservation	Donor-related Observation	Observation	An Observation profile describing donor-related Observations, as defined by BabyConnect. These are observations about the donor, such as their age. - Donor-related Observations use the focus extension to point to the RelatedPerson (donor) they are about - Donor-related Observations refer to the EpisodeOfCare with Observation.context.reference
bc-FamilySituationAssessment		Observation	An Observation profile as defined by BabyConnect describing the assessment of the family situation of a pregnant woman. Indications for additional care may be based on this assessment.
bc-FeedingPatternInfant		Observation	An Observation profile describing the infant's feeding pattern as defined by BabyConnect.
bc-FetalHeartRate		Observation	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-FetalMonitoring		Observation	An Observation profile derived from the fetus Observation profile describing fetal monitoring as defined by BabyConnect. Fetal monitoring 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-FetusObservation		Observation	An Observation profile describing fetus-related Observations in a pregnancy, such as movement and heart action, as defined by BabyConnect. 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-InfantExcretion		Observation	An Observation profile describing a newborn's fecal and urine excretion as defined by BabyConnect.
bc-MaternalObservation	Patient-related Observation	Observation	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-ParentEducationLevel		Observation	An Observation profile describing a child parent's education level as defined by BabyConnect.
bc-PerinatalDeath		Observation	An Observation profile describing perinatal and (early) neonatal death as defined by BabyConnect. The subject may be either an unborn, stillborn or living born child. In case of an unborn or stillborn child, a patient or fetus record may not be present. In this case the subject is the woman Patient. Use the focus extension to refer to the fetus BodySite. In all other cases the subject is the child Patient and the focus extension can be left blank.
bc-PerinealAssessment		Observation	An Observation profile describing the perineal assessment as defined by BabyConnect.
bc-PlacentaLocalization		Observation	An Observation profile describing the localization of the placenta as defined by BabyConnect. 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-Pregnancy-PregnancyDuration		Observation	An Observation profile describing pregnancy duration as defined by BabyConnect. Pregnancy duration does not (only) pertain to the Patient but also to a particular pregnancy. - Use the focus extension to point to the Condition it is about. Without this, pregnancy durations would only be Observations about a Patient - Use Observation.context.reference to point to the EpisodeOfCare - Use the supportingInfo extension to point to other problems and procedures that are relevant in the context of the pregnancy duration
bc-Pregnancy-TermDate		Observation	An Observation profile describing term date as defined by BabyConnect. The term date is related to a pregnancy, which is the focus of the Observation (extension). It is also about the mother, which still is the subject of the Observation.
bc-PregnancyObservation	Pregnancy-related Observation	Observation	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-PregnancyUltraSoundGeneralFindings		Observation	An Observation profile describing general ultrasound findings for the fetus as defined by BabyConnect. 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-ProcedureObservation	Procedure-related Observation	Observation	An Observation profile describing procedure-related Observations as defined by BabyConnect. Procedure-related Observations are Observations about a procedure, which is the focus of the Observation (extension). They are also about the mother, which still is the subject of the Observation. For example, embryo transfer date and oocyte retrieval date are observations related to an IVF/ICSI procedure. - Procedure-related Observations use focus extension to point to a birth - Procedure-related Observations refer to the EpisodeOfCare with Observation.context.reference
bc-UmbilicalCord		Observation	An Observation profile describing the umbilical cord a as defined by BabyConnect. 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-UterusActivity		Observation	An Observation profile derived from the maternal Observation profile describing uterus activity as defined by BabyConnect. Uterus activity is a patient-related Observation. Patient-related Observations are about the (pregnant) woman, which is the subject of the Observation.
bc-Child		Patient	A Patient profile for the child Patient as defined by BabyConnect. Child is a separate Patient.
bc-Woman		Patient	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.
bc-PractitionerRole		PractitionerRole	A PractitionerRole profile describing the role of a practitioner as defined by BabyConnect.
bc-Birth		Procedure	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-DeliveryProcedure		Procedure	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-ObstetricProcedure		Procedure	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-ReferralRequest		ReferralRequest	A ReferralRequest profile describing referral details as defined by BabyConnect. Referral details (such as type of referral, reason code, referrer and target of the referral) are described in ReferralRequest. The pregnant woman is the subject, the context is the pregnancy file (EpisodeOfCare).
bc-Donor		RelatedPerson	A RelatedPerson profile describing donor characteristics as defined by BabyConnect.
bc-MotherOf		RelatedPerson	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

Terminology, NamingSystems, Mappings

Terminology

Relevant value sets can be found here. All resources can be downloaded in a .zip in XML or JSON format. In the .zip, the value sets are stored in the directory 'value sets'.

BabyConnect Afsprakenstelsel

The BabyConnect Afsprakenstelsel describes the BabyConnect architecture.

Transactions

The transactions defined by BabyConnect can be found here

Actors

Transaction group	Transaction	Actor	Role
Publish transaction (PUSH)	Publish transaction	Healthcare professional (using a XIS)	Sends transaction to registry
Retrieve transaction (PULL)	Retrieve transaction	Healthcare professional (using a XIS and/or viewer software)	Retrieves transaction from registry

Module A and E can either directly interact with the FHIR server (which they are encouraged to do) or use the convertor and translator software of module B and D.

Invocations

Publishing XIS: request message

Message Semantics

The publishing XIS or convertor executes a HTTP POST request of a Bundle with Bundle.type = transaction to the target's base endpoint. The first Bundle.entry contains a Composition resource, and each subsequent entry contains a resource that is referenced from the Composition resource.

POST [base]{&_format=[mime-type]}

As a result, all FHIR resources included in the Bundle will be stored individually in the FHIR server.

To persist a Document Bundle at the FHIR server (e.g. to preserve the clinical context), the publishing XIS or convertor should execute a HTTP GET request to the Composition endpoint of the FHIR server, handling the createDocumentOperation with persist=true. The response is a FHIR Document Bundle, which is generated from the Composition resource and stored to the FHIR server's Bundle endpoint.

GET [base]/Composition/[id]/$document?persist=true{&_format=[mime-type]}

Retrieving XIS: request message

When persisted at the FHIR server, FHIR Document Bundles can be retrieved by a HTTP GET request to the FHIR server's Bundle endpoint. Note that FHIR Document Bundles are immutable and its entries refer to a time-related version of a resource which is not necessarily its latest version.

GET [base]/Bundle/[id]{&_format=[mime-type]}

Individual resources can be retrieved by HTTP GET requests to specific resource endpoints, see the Search section and list of StructureDefinitions below.

Examples

Example FHIR resources can be found here: Simplifier.net/geboortezorg-stu3/~resources?category=Example

Search

Example search URLs can be found in the list of StructureDefinitions in each use case section. Some searches require the implementation of custom search parameters. These parameters can be found here: https://simplifier.net/geboortezorg-stu3/~resources?category=SearchParameter

Use cases

Introduction

Birthcare supports the following (types of) use cases.

• Patient use cases, in a personal health record (PHR) context

1. Pregnancy data

• Health provider use cases, in a primary care context

1. Midwife data
2. Maternity data
3. Neonatology data
4. Youth care data
5. Ultrasound data
6. Lab results

• Secondary use of data

1. Minimum data set (Perined): obstetrics
2. Screening (RIVM): counseling
3. Screening (RIVM): Non-invasive prenatal screening (NIPT) request
4. Screening (RIVM): Non-invasive prenatal screening (NIPT) result
5. Screening (RIVM): Ultrasound scan (SEO) request 1st term
6. Screening (RIVM): Ultrasound scan (SEO) result 1st term
7. Screening (RIVM): Ultrasound scan (SEO) result 2nd term

#lst:Gebz:V1.2_FHIR_IG_use_cases_3.2