FHIR Implementation Guide Geboortezorg v2.3

Uit informatiestandaarden
Versie door Maarten Ligtvoet (overleg | bijdragen) op 20 jul 2020 om 00:59 (Tekst vervangen - "{{#customtitle:" door "{{DISPLAYTITLE:")
Naar navigatie springen Naar zoeken springen

Issue icon.png

Dit materiaal is in ontwikkeling en nog niet geschikt voor gebruik!

AfsprakenstelselFunctioneelTechnischAfspraken-Functioneel-Technisch

Introduction

This page details the HL7 FHIR requirements for exchanging the Geboortezorg v2.3 data described in Functioneel.

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-model-overview.png

FHIR Resources and StructureDefinitions

Types of resources and relations between them

For Observations, 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. See links below.

Name FHIR resource Description
Woman (Vrouw) Patient The core of each pregnancy is the pregnant woman, a FHIR Patient.
Partner RelatedPerson The partner of the pregnant woman (not necessarily the biological father).
Generic resources Practitioner, PractitionerRole, Organization Those are not used differently than in other Dutch projects.
Referral details ReferralRequest 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).
Involvement pediatrician CareTeam A CareTeam describes the involvement of different care providers, 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
Pregnancy, Pregnancy file (Zwangerschap, zwangerschapsdossier) Condition, EpisodeOfCare Each pregnancy is a Condition. It is also represented as an EpisodeOfCare for each involved Organization. The pregnancy includes references to an Organization and responsible Practitioner. (Practitioners responsible for the actual data may be included there, i.e. in Procedures, Observations.)
  • 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.
Patient-related Observations Observation Observations such as blood type pertain to the Patient.
  • Observations can refer to an EpisodeOfCare with Observation.context.reference
Pregnancy-related Observations Observation Observations such as gravidity and parity do not (only) pertain to the Patient but to a particular pregnancy.
  • Pregnancy-related Observations use focus extension to point to Condition they're about. Without this, all gravidities would only be Observations about a Patient.
  • Pregnancy-related Observations refer to the EpisodeOfCare with Observation.context.reference
Pregnancy-related disorder Condition 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
Childbirth Assistance Encounter Childbirth Assistance is modeled as an Encounter. The woman Patient is 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 and even the woman Patient 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
Delivery (Bevalling) Procedure Delivery is modeled with Procedure (even for uncomplicated natural births for consistency). A pregnancy can lead to one DeliveryProcedure even in multiple birth. The Patient is the subject.
  • Delivery refers to the EpisodeOfCare with Procedure.context.reference
  • Delivery refers to the Pregnancy with Procedure.reasonReference.reference
Delivery-related Observations Observation 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
Placenta BodySite The placenta is a body structure of the woman Patient and is modeled as a BodySite.
  • The BodySite.patient element refers to the woman Patient.
Birth Procedure A birth pertains to a delivery Procedure as well as a child, especially in multiple birth where 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, which is part of the delivery Procedure. A pregnancy can lead to one delivery Procedure and multiple birth Procedures.
  • Birth refers to the delivery Procedure with Procedure.partOf
  • Birth refers to the EpisodeOfCare with Procedure.context.reference
  • Delivery refers to the Pregnancy with Procedure.reasonReference.reference
Birth-related Observations Observation Observations such as parturition type pertain to a birth. They are also about the mother, which still is the subject.
  • Birth-related Observations use focus extension to point to a birth.
  • Birth-related Observations refer to the EpisodeOfCare with Observation.context.reference
Child Patient Child is a separate Patient.
  • Procedure-related Observations use focus extension to point to the child Patient they're about.
Child-related Observations Observation Observations such as Apgar score and birthweight pertain to the child Patient, which is the subject of these Observations.
  • Child observations refer to the EpisodeOfCare with Observation.context.reference
Child disorders Condition Child disorders such as chromosomal and congenital abnormalities or other problems are conditions. The child is the subject.
  • Child disorders can refer to the EpisodeOfCare with Condition.context.reference
  • A ConceptMap is available to map verification status to accepted FHIR codes
Digital vaginal examination DiagnosticReport The digital vaginal examination DiagnosticReport groups Observations related to the digital vaginal examination. The woman Patient is the subject of the report.
  • Digital vaginal examination refers to the EpisodeOfCare with DiagnosticReport.context.reference

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.

The use of context is encouraged for all resources which have a context element. It is a reference to an EpisodeOfCare or an Encounter. Context should point to an Encounter when appropriate (scheduled maternity checks etc.) and to the EpisodeOfCare in all other cases. Possibly it will be absent in Observations where the source is not birth care, so readers should not rely on it's presence.

Observations should include a performer if known.

Pattern tables can be found on individual pattern pages and on Gebz:V2.3_FHIR_mapping_addendum.

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'.

Use case: Register Prio1 data

Introduction

The Register Prio1 transaction is used by the sending XIS to send the relevant data to the registry.

Actors

Transaction group Transaction Actor Role
Register Prio1(PUSH) Register Prio1 Healthcare professional (using a XIS) Sends Prio1 data to registry
Retrieve Prio1(PULL) Querying XIS Healthcare professional (using a XIS) Retrieves Prio1 data from registry

Invocations

Sending XIS: request message

Trigger Events

Message Semantics

The source executes two HTTP requests:

1. HTTP POST request

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]}

Each Bundle.entry shall contain an entry.request with request.method = PUT. Each Bundle.entry shall contain either:

  1. A client assigned UUID in the entry.resource and the entry.request.url
  2. A conditional reference in the entry.fullUrl and the entry.request.url

The first applies to resources (e.g. Observations) of which multiple instances are allowed to live on the server.

The second applies to resources (e.g. Patients) for which no duplicates are allowed, e.g. by identifier. Please note that resource instances with conditional references are only created when no resource instance on the server meets the condition, updated when one such an instance exists and the transaction is fully rejected when multiple resource instances meet the condition. Also note that the internal references in the transaction pointing to these kind of resource instances are conditional ones.

Below are examples of transaction Bundles for the prio1 transaction:

2. HTTP GET request

A HTTP GET request to the target's Composition endpoint, handling the createDocumentOperation with persist=true. The target's response is a FHIR Document Bundle, which is generated from the Composition resource and stored to the target's Bundle endpoint. 

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

Retrieving XIS: request message

FHIR Document Bundles can be retrieved by a HTTP GET request to the target'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: [1]

Search

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

List of StructureDefinitions

Please note that many birth care specific profiles are derived from nl-core profiles (e.g. bc-PregnancyObservation is derived from nl-core-observation) to support (re)use of profiles in multiple use cases. The meta.profile element of FHIR instances conforming these profiles should at least include the generic nl-core profile and preferably the specific birth care profile.

Prio 1 huidig

PWD 2.3 to FHIR
Type # Concept Card Profile Mapping Example Search URL
Container.png 1 Zorgverlener/Zorginstelling 1 .. 1 nl-core-organization Organization | Practitioner example
Container.png 10020    Zorginstelling 1 .. 1 nl-core-organization Organization example
  • GET [base]/Organization/[zorginstellingid]
  • GET [base]/Organization?identifier=[lvrid]
II.png 10021       Zorginstelling OID 0 .. 1 nl-core-organization Organization.identifier example
II.png 10022       Zorginstelling AGB-ID 0 .. 1 nl-core-organization Organization.identifier example
II.png 10023       Zorginstelling LVR-ID 0 .. 1 nl-core-organization Organization.identifier example
II.png 10024       Zorginstelling URA 0 .. 1 nl-core-organization Organization.identifier example
ANY.png 10026       Naam zorginstelling 0 .. 1 nl-core-organization Organization.name example
Container.png 10027       Adres zorginstelling 0 .. 1 nl-core-organization Organization.address example
ST.png 10032          Straatnaam 0 .. 1 nl-core-organization Organization.address.line.Extension.streetName example
ST.png 10033          Huisnummer 0 .. 1 nl-core-organization Organization.address.line.Extension.HouseNumber example
ST.png 10034          Huisletter/huisnummertoevoeging 0 .. 1 nl-core-organization Organization.address.line.Extension.BuildingNumberSuffix example
ST.png 10041          Postcode 0 .. 1 nl-core-organization Organization.address.postalCode example
ST.png 10036          Plaatsnaam 0 .. 1 nl-core-organization Organization.address.city example
ST.png 10037          Gemeentenaam 0 .. 1
ST.png 10038          Land 0 .. 1 nl-core-organization Organization.address.country example
CD.png 10039          Adrestype 0 .. 1
CD.png 10029       Type zorginstelling 0 .. 1
CD.png 82019       Type zorginstelling (bij verwijzing) 0 .. 1
Container.png 2 Vrouw 1 .. 1 bc-Woman Patient example
  • GET [base]/Patient/[vrouwid]
  • GET [base]/Patient?identifier=[bsn]
II.png 10030    Burgerservicenummer 1 .. 1 bc-Woman Patient.identifier example
Container.png 10035    Naamgegevens 0 .. 1 bc-Woman Patient.name example
ST.png 10042       Voornamen 0 .. 1 bc-Woman Patient.name.given example
ST.png 82359       Initialen 0 .. 1 bc-Woman Patient.name.given example
ST.png 82360       Roepnaam 0 .. 1 bc-Woman Patient.name.given example
Container.png 82361       Achternaam 1 .. 1 bc-Woman Patient.name.family example
CD.png 82362          Soort naam 0 .. 1 bc-Woman Patient.name.family example
ST.png 82363          Voorvoegsel 0 .. 1 bc-Woman Patient.name.family example
ST.png 10043          Achternaam 1 .. 1 bc-Woman Patient.name.family example
CD.png 10810    Bloedgroep vrouw 0 .. 1 zib-LaboratoryTestResult-Observation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=883-9{&subject=[vrouwid]&context=[dossierid]}
CD.png 10811    Rhesus D Factor vrouw 0 .. 1 zib-LaboratoryTestResult-Observation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=1305-2{&subject=[vrouwid]&context=[dossierid]}
CD.png 10816    Rhesus c Factor 0 .. 1 zib-LaboratoryTestResult-Observation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=1159-3{&subject=[vrouwid]&context=[dossierid]}
Container.png 3 Zwangerschap 1 .. 1 zib-pregnancy Condition example
  • GET [base]/Condition/[zwangerschapid]
  • GET [base]/Condition?clinicalstatus=active
  • GET [base]/Condition?clinicalstatus=inactive&_sort=_-id&_count=1
  • GET [base]/Condition?subject=[patientid]&_revinclude=Observation:focus
INT.png 20010    Graviditeit 1 .. 1 zib-pregnancy-Gravidity Observation.valueQuantity example
  • GET [base]/Observation?code=11996-6{&subject=[vrouwid]&context=[dossierid]&focus=[zwangerschapid]}
INT.png 20153    Pariteit 1 .. 1 zib-pregnancy-Parity Observation.valueQuantity example
Container.png 20029    A terme datum (groep) 1 .. 1 zib-pregnancy-TermDate Observation example
TS.png 20030       A terme datum 1 .. 1 zib-pregnancy-TermDate Observation.valueDateTime example
  • GET [base]/Observation?code=11778-8{&subject=[vrouwid]&context=[dossierid]&focus=[zwangerschapid]}
Container.png 14 Medisch onderzoek 0 .. * bc-PregnancyUltraSound DiagnosticReport example
TS.png 50020    Datum onderzoek 1 .. 1 bc-PregnancyUltraSound DiagnosticReport.effectiveDateTime example
Container.png 142    Maternale onderzoeksgegevens 1 .. 1 zib-LaboratoryTestResult-DiagnosticReport DiagnosticReport example
Container.png 80959       Urine-, bloed- en aanvullende onderzoeken 1 .. 1 zib-LaboratoryTestResult-DiagnosticReport DiagnosticReport example
PQ.png 10814          Hb 1 .. 1 zib-LaboratoryTestResult-Observation Observation.valueQuantity example
  • GET [base]/Observation?code=718-7{&subject=[vrouwid]&context=[dossierid]}

Prio 1 vorig

PWD 2.3 to FHIR
Type # Concept Card Profile Mapping Example Search URL
Container.png 1 Zorgverlener/Zorginstelling 1 .. 1 nl-core-organization Organization | Practitioner example
Container.png 10020    Zorginstelling 1 .. 1 nl-core-organization Organization example
  • GET [base]/Organization/[zorginstellingid]
  • GET [base]/Organization?identifier=[lvrid]
II.png 10021       Zorginstelling OID 0 .. 1 nl-core-organization Organization.identifier example
II.png 10022       Zorginstelling AGB-ID 0 .. 1 nl-core-organization Organization.identifier example
II.png 10023       Zorginstelling LVR-ID 0 .. 1 nl-core-organization Organization.identifier example
II.png 10024       Zorginstelling URA 0 .. 1 nl-core-organization Organization.identifier example
ANY.png 10026       Naam zorginstelling 0 .. 1 nl-core-organization Organization.name example
Container.png 10027       Adres zorginstelling 0 .. 1 nl-core-organization Organization.address example
ST.png 10032          Straatnaam 0 .. 1 nl-core-organization Organization.address.line.Extension.streetName example
ST.png 10033          Huisnummer 0 .. 1 nl-core-organization Organization.address.line.Extension.HouseNumber example
ST.png 10034          Huisletter/huisnummertoevoeging 0 .. 1 nl-core-organization Organization.address.line.Extension.BuildingNumberSuffix example
ST.png 10041          Postcode 0 .. 1 nl-core-organization Organization.address.postalCode example
ST.png 10036          Plaatsnaam 0 .. 1 nl-core-organization Organization.address.city example
ST.png 10037          Gemeentenaam 0 .. 1
ST.png 10038          Land 0 .. 1 nl-core-organization Organization.address.country example
CD.png 10039          Adrestype 0 .. 1
CD.png 10029       Type zorginstelling 0 .. 1
CD.png 82019       Type zorginstelling (bij verwijzing) 0 .. 1
Container.png 2 Vrouw 1 .. 1 bc-Woman Patient example
  • GET [base]/Patient/[vrouwid]
  • GET [base]/Patient?identifier=[bsn]
II.png 10030    Burgerservicenummer 1 .. 1 bc-Woman Patient.identifier example
Container.png 10035    Naamgegevens 0 .. 1 bc-Woman Patient.name example
ST.png 10042       Voornamen 0 .. 1 bc-Woman Patient.name.given example
ST.png 82359       Initialen 0 .. 1 bc-Woman Patient.name.given example
ST.png 82360       Roepnaam 0 .. 1 bc-Woman Patient.name.given example
Container.png 82361       Achternaam 1 .. 1 bc-Woman Patient.name.family example
CD.png 82362          Soort naam 0 .. 1 bc-Woman Patient.name.family example
ST.png 82363          Voorvoegsel 0 .. 1 bc-Woman Patient.name.family example
ST.png 10043          Achternaam 1 .. 1 bc-Woman Patient.name.family example
Container.png 3 Zwangerschap 0 .. 1 zib-pregnancy Condition example
  • GET [base]/Condition/[zwangerschapid]
  • GET [base]/Condition?clinicalstatus=active
  • GET [base]/Condition?clinicalstatus=inactive&_sort=_-id&_count=1
  • GET [base]/Condition?subject=[patientid]&_revinclude=Observation:focus
INT.png 20010    Graviditeit 0 .. 1 zib-pregnancy-Gravidity Observation.valueQuantity example
  • GET [base]/Observation?code=11996-6{&subject=[vrouwid]&context=[dossierid]&focus=[zwangerschapid]}
INT.png 20150    Pariteit (vóór deze zwangerschap) 0 .. 1 zib-pregnancy-Parity Observation.valueQuantity example
  • GET [base]/Observation?code=11977-6{&subject=[vrouwid]&context=[dossierid]&focus=[zwangerschapid]}
CD.png 80625    Wijze einde zwangerschap 0 .. 1 bc-PregnancyObservation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=EindeZw{&subject=[vrouwid]&context=[dossierid]&focus=[zwangerschapid]}
TS.png 20540    Datum einde zwangerschap 0 .. 1 bc-PregnancyObservation Observation.valueDateTime example
  • GET [base]/Observation?code=code=118951000146109{&subject=[vrouwid]&context=[dossierid]&focus=[zwangerschapid]}
Container.png 6 Bevalling 0 .. 1 bc-DeliveryProcedure Procedure example
  • GET [base]/Procedure?code=236973005{&subject=[vrouwid]&context=[dossierid]&reasonReference=[zwangerschapid]}
TS.png 20590    Tijdstip begin actieve ontsluiting 0 .. 1 bc-DeliveryObservation Observation.valueDateTime example
  • GET [base]/Observation?code=249120008{&subject=[vrouwid]&context=[dossierid]&focus=[bevallingid]}
PQ.png 82869    Duur actieve ontsluitingsfase (Ontsluitingsduur) 0 .. 1
PQ.png 82870    Duur uitdrijving vanaf actief meepersen 0 .. 1
PQ.png 20640    Hoeveelheid bloedverlies 0 .. 1 bc-DeliveryObservation Observation.valueQuantity example
  • GET [base]/Observation?code=64332008{&subject=[vrouwid]&context=[dossierid]&focus=[bevallingid]}
CD.png 80673    Conditie perineum postpartum 0 .. 1 bc-DeliveryObservation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=364297003{&subject=[vrouwid]&context=[dossierid]&focus=[bevallingid]}
Container.png 7 Uitkomst (per kind) 0 .. *
Container.png 40002    Baring 1 .. 1 bc-Birth Procedure example
  • GET [base]/Procedure?code=3950001{&subject=[vrouwid]&context=[dossierid]&focus=[geboorteid]&focus=[kindid]}
Container.png 40006       Demografische gegevens 0 .. 1 bc-Child Patient
  • GET [base]/Patient/[kindid]
TS.png 40050          Geboortedatum 0 .. 1 bc-Child Patient.birthdate & patient.birthtime (extension) example
  • GET [base]/Patient/[kindid]
Container.png 71       Kindspecifieke maternale gegevens 0 .. 1
TS.png 30030          Tijdstip actief meepersen 0 .. 1 bc-BirthObservation Observation.valueDateTime example
  • GET [base]/Observation?code=249163006{&subject=[vrouwid]&context=[dossierid]&focus=[geboorteid]}
Container.png 72       Kindspecifieke uitkomstgegevens 0 .. 1
CD.png 80626          Type partus 0 .. 1 bc-BirthObservation Observation.valueCode example
  • GET [base]/Observation?code=364336006{&subject=[vrouwid]&context=[dossierid]&focus=[geboorteid]}
PQ.png 20062          Zwangerschapsduur 0 .. 1
Container.png 40189          Vaginale kunstverlossing (groep) 0 .. 1 bc-ObstetricProcedure Procedure example
CD.png 40190             Vaginale kunstverlossing 0 .. 1 bc-ObstetricProcedure Procedure.code example
  • GET [base]/Procedure?code=3311000146109{&subject=[vrouwid]&context=[dossierid]&partof=[bevallingid,uitdrijvingsfaseid]}
Container.png 80766          Lichamelijk onderzoek kind 0 .. 1 DiagnosticReport
INT.png 40071             Apgarscore na 5 min. 0 .. 1 zib-ApgarScore Observation.valueQuantity example
  • GET [base]/Observation?code=9274-2{&subject=[kindid]&context=[dossierid]}
PQ.png 40060             Geboortegewicht 0 .. 1 bc-ChildObservation Observation.valueQuantity example
  • GET [base]/Observation?code=8339-4{&subject=[kindid]&context=[dossierid]}


Use case: Register Parturition Record

Introduction

The Register Parturition Record transaction is used by the sending XIS to send the relevant data to the registry.

Actors

Transaction group Transaction Actor Role
Register Parturition Record(PUSH) Register Parturition Record Healthcare professional (using a XIS) Sends Parturition Record data to registry
Retrieve Parturition Record(PULL) Querying XIS Healthcare professional (using a XIS) Retrieves Parturition Record data from registry

Invocations

Sending XIS: request message

Trigger Events

Message Semantics

The source executes two HTTP requests:

1. HTTP POST request

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]}

Each Bundle.entry shall contain an entry.request with request.method = PUT. Each Bundle.entry shall contain either:

  1. A client assigned UUID in the entry.resource and the entry.request.url
  2. A conditional reference in the entry.fullUrl and the entry.request.url

The first applies to resources (e.g. Observations) of which multiple instances are allowed to live on the server.

The second applies to resources (e.g. Patients) for which no duplicates are allowed, e.g. by identifier. Please note that resource instances with conditional references are only created when no resource instance on the server meets the condition, updated when one such an instance exists and the transaction is fully rejected when multiple resource instances meet the condition. Also note that the internal references in the transaction pointing to these kind of resource instances are conditional ones.

Below are examples of transaction Bundles for the prio1 transaction:

2. HTTP GET request

A HTTP GET request to the target's Composition endpoint, handling the createDocumentOperation with persist=true. The target's response is a FHIR Document Bundle, which is generated from the Composition resource and stored to the target's Bundle endpoint. 

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

Retrieving XIS: request message

FHIR Document Bundles can be retrieved by a HTTP GET request to the target'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: [2]

Search

Example search URLs can be found in the list of StructureDefinitions below.

List of StructureDefinitions

Please note that many birth care specific profiles are derived from nl-core profiles (e.g. bc-PregnancyObservation is derived from nl-core-observation) to support (re)use of profiles in multiple use cases. The meta.profile element of FHIR instances conforming these profiles should at least include the generic nl-core profile and preferably the specific birth care profile.


PWD 2.3 to FHIR
Type # Concept Card Profile Mapping Example Search URL
Container.png 4 Zorgverlening 1 .. 1 bc-MaternalRecord EpisodeOfCare example
Container.png 82012    Verwijsdetails 1 .. 1 bc-ReferralRequest ReferralRequest example
  • GET [base]/ReferralRequest?subject=[vrouwid]
  • GET [base]/ReferralRequest?context=[dossierid]
TS.png 82013       Datum verwijzing 1 .. 1 bc-ReferralRequest ReferralRequest.authoredOn example
Container.png 82577       Verwijzing naar 1 .. 1 bc-ReferralRequest ReferralRequest.recipient.reference example
Container.png 82578          Zorginstelling 0 .. 1 nl-core-organization Organization example
II.png 82579             ZorgaanbiederIdentificatieNummer 0 .. 1 nl-core-organization Organization.identifier example
CD.png 82580             Specialisme 0 .. 1 bc-ReferralRequest ReferralRequest.requester.agent.extension:practitionerRole | PractitionerRole.specialty example
CD.png 20367       Perinatale periode 1 .. 1 bc-ReferralRequest ReferralRequest.type example
Container.png 9 Consent 1 .. 1
II.png 18010    Autorisatieprofiel 0 .. 1
CD.png 18020    Auteur autorisatieprofiel 1 .. 1
ANY.png 18030    Patiënt als auteur 0 .. 1
CD.png 18040    Vertegenwoordiger als auteur 0 .. 1
ANY.png 18050    Vertegenwoordiger 0 .. 1
Container.png 18060    (HL7: koppeling PermissionToTransfer) 1 .. 1
CD.png 18070       Toestemming betreft 1 .. 1
Container.png 18100       Ontvanger 1 .. 1
II.png 18110          (HL7: ontvangende partij) 1 .. 1
ST.png 18120          Ontvangende organisatie 1 .. 1
Container.png 18150       (HL7: PermissionToTransferSubject) 0 .. 1
CD.png 18160          RecordType 0 .. 1
Container.png 1 Zorgverlener/Zorginstelling 1 .. 1 nl-core-organization Organization | Practitioner example
Container.png 10001    Zorgverlener 1 .. 1 nl-core-practitioner Practitioner example
  • GET [base]/Practitioner/[zorgverlenerid]
  • GET [base]/Practitioner?identifier=[lvrid]
II.png 10002       Zorgverlener UZI-nummer 0 .. 1 nl-core-practitioner Practitioner.identifier example
II.png 10003       Zorgverlener AGB-ID 1 .. 1 nl-core-practitioner Practitioner.identifier example
II.png 10004       Zorgverlener LVR1-ID 1 .. 1 nl-core-practitioner Practitioner.identifier example
II.png 10005       Zorgverlener (LVR2, eigen ID) 0 .. 1
ANY.png 10006       Naam zorgverlener 1 .. 1 nl-core-practitioner Practitioner.name example
CD.png 10010       Zorgverlenertype 0 .. 1 nl-core-practitionerrole PractitionerRole.specialty example
ST.png 10012       Telefoon waar zorgverlener is te bereiken 1 .. 1 nl-core-practitioner Practitioner.telecom example
Container.png 10020    Zorginstelling 1 .. 1 nl-core-organization Organization example
  • GET [base]/Organization/[zorginstellingid]
  • GET [base]/Organization?identifier=[lvrid]
II.png 10021       Zorginstelling OID 0 .. 1 nl-core-organization Organization.identifier example
II.png 10022       Zorginstelling AGB-ID 1 .. 1 nl-core-organization Organization.identifier example
II.png 10023       Zorginstelling LVR-ID 1 .. 1 nl-core-organization Organization.identifier example
II.png 10024       Zorginstelling URA 0 .. 1 nl-core-organization Organization.identifier example
ANY.png 10026       Naam zorginstelling 1 .. 1 nl-core-organization Organization.name example
Container.png 10027       Adres zorginstelling 1 .. 1 nl-core-organization Organization.address example
ST.png 10032          Straatnaam 1 .. 1 nl-core-organization Organization.address.line.Extension.streetName example
ST.png 10033          Huisnummer 1 .. 1 nl-core-organization Organization.address.line.Extension.HouseNumber example
ST.png 10034          Huisletter/huisnummertoevoeging 0 .. 1 nl-core-organization Organization.address.line.Extension.BuildingNumberSuffix example
ST.png 10041          Postcode 1 .. 1 nl-core-organization Organization.address.postalCode example
ST.png 10036          Plaatsnaam 1 .. 1 nl-core-organization Organization.address.city example
ST.png 10037          Gemeentenaam 1 .. 1
CD.png 10029       Type zorginstelling 1 .. 1
CD.png 82019       Type zorginstelling (bij verwijzing) 0 .. 1
Container.png 2 Vrouw 1 .. 1 bc-Woman Patient example
  • GET [base]/Patient/[vrouwid]
  • GET [base]/Patient?identifier=[bsn]
II.png 10030    Burgerservicenummer 1 .. 1 bc-Woman Patient.identifier example
II.png 10031    Lokale persoonsidentificatie 1 .. 1 bc-Woman Patient.identifier example
Container.png 10035    Naamgegevens 0 .. 1 bc-Woman Patient.name example
ST.png 10042       Voornamen 0 .. 1 bc-Woman Patient.name.given example
ST.png 82359       Initialen 0 .. 1 bc-Woman Patient.name.given example
ST.png 82360       Roepnaam 0 .. 1 bc-Woman Patient.name.given example
Container.png 82361       Achternaam 0 .. 1 bc-Woman Patient.name.family example
CD.png 82362          Soort naam 0 .. 1 bc-Woman Patient.name.family example
ST.png 82363          Voorvoegsel 0 .. 1 bc-Woman Patient.name.family example
ST.png 10043          Achternaam 1 .. 1 bc-Woman Patient.name.family example
TS.png 10040    Geboortedatum 1 .. 1 bc-Woman Patient.birthdate example
Container.png 10300    Adres 1 .. 1 bc-Woman Patient.address example
ST.png 10301       Straatnaam 1 .. 1 bc-Woman Patient.address.line.Extension.streetName example
ST.png 10302       Huisnummer 1 .. 1 bc-Woman Patient.address.line.Extension.HouseNumber example
ST.png 10303       Huisletter/huisnummertoevoeging 0 .. 1 bc-Woman Patient.address.line.Extension.BuildingNumberSuffix example
ST.png 10304       Postcode 1 .. 1 bc-Woman Patient.address.postalCode example
ST.png 10305       Plaatsnaam 1 .. 1 bc-Woman Patient.address.city example
ST.png 10306       Gemeentenaam 1 .. 1 bc-Woman Patient.address.district example
ST.png 10307       Land 1 .. 1 bc-Woman Patient.address.country example
CD.png 10308       Adrestype 1 .. 1 bc-Woman Patient.address.type example
CD.png 10400    Etniciteit 0 .. 1 bc-Woman Patient.extension example
CD.png 10401    Taalvaardigheid vrouw Nederlandse taal 0 .. 1 bc-Woman Patient.communication.extension example
CD.png 82371    CommunicatieTaal 0 .. 1
CD.png 82155    Opleidingsniveau 0 .. 1
ST.png 82154    Beroep 0 .. 1
CD.png 10810    Bloedgroep vrouw 0 .. 1 zib-LaboratoryTestResult-Observation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=883-9{&subject=[vrouwid]&context=[dossierid]}
CD.png 10811    Rhesus D Factor vrouw 0 .. 1 zib-LaboratoryTestResult-Observation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=1305-2{&subject=[vrouwid]&context=[dossierid]}
Container.png 80633    Partner 0 .. 1
Container.png 80638       Persoonsnaam 0 .. 1
ST.png 80639          Voornamen 0 .. 1
ST.png 80640          Voorvoegsel 0 .. 1
ST.png 80641          Achternamen 0 .. 1
Container.png 3 Zwangerschap 1 .. 1 zib-pregnancy Condition example
  • GET [base]/Condition/[zwangerschapid]
  • GET [base]/Condition?clinicalstatus=active
  • GET [base]/Condition?clinicalstatus=inactive&_sort=_-id&_count=1
  • GET [base]/Condition?subject=[patientid]&_revinclude=Observation:focus
TS.png 82160    Definitieve à terme datum 1 .. 1 bc-PregnancyObservation Observation.valueDateTime example
  • GET [base]/Observation?code=11778-8{&subject=[vrouwid]&context=[dossierid]&focus=[zwangerschapid]}
Container.png 80671    Voornemens 0 .. 1
CD.png 20261       Voorgenomen plaats baring tijdens zwangerschap (type locatie) 0 .. 1 bc-PregnancyObservation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=PRN4209{&subject=[vrouwid]&context=[dossierid]}
CD.png 82009       Voorgenomen voeding 0 .. 1
Container.png 6 Bevalling 1 .. 1 bc-DeliveryProcedure Procedure example
  • GET [base]/Procedure?code=236973005{&subject=[vrouwid]&context=[dossierid]&reasonReference=[zwangerschapid]}
CD.png 20530    Risicostatus vóór baring 0 .. 1 bc-DeliveryObservation Observation.valueCodeableConcept example
TS.png 20590    Tijdstip begin actieve ontsluiting 0 .. 1 bc-DeliveryObservation Observation.valueDateTime example
  • GET [base]/Observation?code=249120008{&subject=[vrouwid]&context=[dossierid]&focus=[bevallingid]}
PQ.png 82869    Duur actieve ontsluitingsfase (Ontsluitingsduur) 1 .. 1
PQ.png 82870    Duur uitdrijving vanaf actief meepersen 1 .. 1
Container.png 80612    Placenta 1 .. 1 bc-Placenta BodySite
  • GET [base]/BodySite?subject=[vrouwid]
CD.png 20631       Placenta Compleet 1 .. 1 bc-DeliveryObservation Observation.CodeableConcept example
  • GET [base]/Observation?code=364343000{&subject=[vrouwid]&context=[dossierid]&focus=placenta}
TS.png 80791       Datum/tijd geboorte placenta 0 .. 1
CD.png 80792    Compleetheid vliezen 1 .. 1
PQ.png 20640    Hoeveelheid bloedverlies 1 .. 1 bc-DeliveryObservation Observation.valueQuantity example
  • GET [base]/Observation?code=64332008{&subject=[vrouwid]&context=[dossierid]&focus=[bevallingid]}
CD.png 80673    Conditie perineum postpartum 1 .. 1 bc-DeliveryObservation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=364297003{&subject=[vrouwid]&context=[dossierid]&focus=[bevallingid]}
BL.png 82125    Hechten? 0 .. 1
CD.png 80797    Wijze van hechten 0 .. 1
Container.png 80799    Immunisatie 0 .. 1
BL.png 80831       Rhesus D immunisatie? 0 .. 1
TS.png 80801       Datum immunisatie 0 .. 1
Container.png 80839    Partusassistentie 0 .. 1
CD.png 20650       Partusstadium assistentie gearriveerd 0 .. 1
CD.png 82132       Rol partusassistent 0 .. 1
Container.png 7 Uitkomst (per kind) 1 .. 1
Container.png 40002    Baring 1 .. 1 bc-Birth Procedure example
  • GET [base]/Procedure?code=3950001{&subject=[vrouwid]&context=[dossierid]&focus=[geboorteid]&focus=[kindid]}
CD.png 40003       Werkelijke plaats baring (type locatie) 0 .. 1 bc-ChildBirthAssistance Encounter.class:werkelijkePlaatsBaring example
Container.png 40006       Demografische gegevens 1 .. 1 bc-Child Patient
  • GET [base]/Patient/[kindid]
Container.png 40007          Identificaties kind 0 .. 1 bc-Child Patient.identifier example
II.png 40010             BSN kind 0 .. 1 bc-Child Patient.identifier:BSN example
II.png 40011             Lokale identificatie kind 0 .. 1 bc-Child Patient.identifier example
Container.png 82051          Naamgegevens kind 1 .. 1 bc-Child Patient.name example
ST.png 82353             Voornamen 1 .. 1 bc-Child Patient.name.given example
ST.png 82354             Initialen 0 .. 1
ST.png 82052             Roepnaam 0 .. 1
Container.png 82053             Achternaam 1 .. 1 bc-Child Patient.name.family example
ST.png 82054                Voorvoegsel 0 .. 1 bc-Child Patient.name.family.humannamePrefix example
ST.png 82055                Achternaam 1 .. 1 bc-Child Patient.name.family.humannameOwnName example
TS.png 40050          Geboortedatum 1 .. 1 bc-Child Patient.birthdate & patient.birthtime (extension) example
  • GET [base]/Patient/[kindid]
Container.png 71       Kindspecifieke maternale gegevens 0 .. 1
TS.png 80619          Tijdstip breken vliezen 1 .. 1 bc-BirthObservation Observation.valueDateTime example
  • GET [base]/Observation?code=289251005{&subject=[vrouwid]&context=[dossierid]&focus=[geboorteid]}
TS.png 30030          Tijdstip actief meepersen 0 .. 1 bc-BirthObservation Observation.valueDateTime example
  • GET [base]/Observation?code=249163006{&subject=[vrouwid]&context=[dossierid]&focus=[geboorteid]}
Container.png 72       Kindspecifieke uitkomstgegevens 0 .. 1
CD.png 80626          Type partus 0 .. 1 bc-BirthObservation Observation.valueCode example
  • GET [base]/Observation?code=364336006{&subject=[vrouwid]&context=[dossierid]&focus=[geboorteid]}
PQ.png 20062          Zwangerschapsduur 1 .. 1
CD.png 40140          Ligging bij geboorte 1 .. 1 bc-BirthObservation Observation.codeableConcept example
  • GET [base]/Observation?code=LigGbrt{&subject=[kindid]&context=[dossierid]}
Container.png 40149          Aanpakker kind (groep) 0 .. 1 bc-ChildBirthAssistance Encounter.participant example
ANY.png 82058             Naam zorgverlener 0 .. 1
CD.png 40150             Rol aanpakker kind 0 .. 1 bc-ChildBirthAssistance Encounter.participant.type|individual.extension:practitionerRole example
Container.png 40169          Supervisor (groep) 0 .. 1 bc-ChildBirthAssistance Encounter.participant example
ANY.png 82059             Naam zorgverlener 0 .. 1
CD.png 40170             Rol supervisor 0 .. 1 bc-ChildBirthAssistance Encounter.participant.type|individual.extension:practitionerRole example
Container.png 80766          Lichamelijk onderzoek kind 0 .. 1 DiagnosticReport
INT.png 40070             Apgarscore na 1 min. 0 .. 1
INT.png 40071             Apgarscore na 5 min. 1 .. 1 zib-ApgarScore Observation.valueQuantity example
  • GET [base]/Observation?code=9274-2{&subject=[kindid]&context=[dossierid]}
INT.png 80757             Apgarscore na 10 min. 0 .. 1
PQ.png 40060             Geboortegewicht 1 .. 1 bc-ChildObservation Observation.valueQuantity example
  • GET [base]/Observation?code=8339-4{&subject=[kindid]&context=[dossierid]}
PQ.png 80760             Schedelomtrek 0 .. 1
CD.png 82385             Indaling testes 1 .. 1
BL.png 40080          Congenitale afwijkingen? 1 .. 1 bc-DisorderOfChild Condition example
Container.png 40081          Congenitale afwijkingen (groep) 0 .. 1 bc-DisorderOfChild Condition example
Container.png 40082             Specificatie congenitale afwijking (groep) 0 .. 1 bc-DisorderOfChild Condition.code example
CD.png 40090                Specificatie congenitale afwijking 0 .. 1 bc-DisorderOfChild Condition.code example
BL.png 40110             Chromosomale afwijkingen? 0 .. 1 bc-DisorderOfChild Condition example
Container.png 40111             Specificatie chromosomale afwijking (groep) 0 .. 1 bc-DisorderOfChild Condition.code example
CD.png 40120                Specificatie chromosomale afwijking 0 .. 1 bc-DisorderOfChild Condition.code example
BL.png 82334          Problematiek kind? 1 .. 1 bc-DisorderOfChild Condition example
CD.png 80789          Problematiek kind 0 .. 1 bc-DisorderOfChild Condition.code example
CD.png 80793          Navelstreng vaten 1 .. 1
BL.png 80761          Vitamine K? 1 .. 1
BL.png 82119          Kinderarts betrokken? 1 .. 1 bc-CareTeam CareTeam.participant.member.extension:practitionerRole
Container.png 82120          Betrokkenheid kinderarts 0 .. 1 bc-CareTeam CareTeam.participant.member.extension:practitionerRole
CD.png 82123             Reden betrokkenheid 0 .. 1 bc-CareTeam CareTeam.reasonCode example
ST.png 80980          Opmerkingen baring 0 .. 1
Container.png 14 Medisch onderzoek 0 .. 1 bc-PregnancyUltraSound DiagnosticReport example
Container.png 142    Maternale onderzoeksgegevens 0 .. 1 zib-LaboratoryTestResult-DiagnosticReport DiagnosticReport example
Container.png 80959       Urine-, bloed- en aanvullende onderzoeken 0 .. 1 zib-LaboratoryTestResult-DiagnosticReport DiagnosticReport example
PQ.png 10814          Hb 0 .. 1 zib-LaboratoryTestResult-Observation Observation.valueQuantity example
  • GET [base]/Observation?code=718-7{&subject=[vrouwid]&context=[dossierid]}
Container.png 1421       Vaginaal toucher 0 .. 1 bc-DigitalVaginalExamination DiagnosticReport example
  • GET [base]/DiagnosticReport?code=51597003{&subject=[vrouwid]&context=[dossierid]}
CD.png 20612          Portio 0 .. 1 bc-MaternalObservation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=[249021005]{&subject=[kindid]&context=[dossierid]}
CD.png 82372          Positie portio 0 .. 1
CD.png 20613          Ontsluiting 0 .. 1 bc-MaternalObservation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=[289761004]{&subject=[kindid]&context=[dossierid]}
CD.png 20614          Vliezen 0 .. 1 bc-MaternalObservation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=[112074005]{&subject=[kindid]&context=[dossierid]}
CD.png 20615          Indaling Hodge 0 .. 1 bc-MaternalObservation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=[364611006]{&subject=[kindid]&context=[dossierid]}
CD.png 80616          Aard van het voorliggend deel 0 .. 1 bc-MaternalObservation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=[364612004]{&subject=[kindid]&context=[dossierid]}
CD.png 80618          Stand 0 .. 1 bc-MaternalObservation Observation.valueCodeableConcept example
  • GET [base]/Observation?code=[163520002]{&subject=[kindid]&context=[dossierid]}
Container.png 16 Postnatale fase 1 .. 1
Container.png 82297    Diagnose/interventie postnataal 1 .. 1 bc-DisorderPostPartum Condition example
CD.png 82209       Pathologie vrouw 0 .. 1 bc-DisorderPostPartum Condition.code example
CD.png 82373       Interventie 0 .. 1
Overgenomen van "https://informatiestandaarden.test-nictiz.nl/index.php?title=Gebz:V1.0_FHIR_IG&oldid=28861"