Cumuluz Translate Implementation Guide
0.1.0 - ci-build

Cumuluz Translate Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

XIB Profiles

XIB Profiles

Intent

XIB means Experimentele Informatie Bouwblokken. In this service, XIB is a local draft R4 profile family for a future complete Dutch profile set.

The profile family is generated from repository FSH and is used only through explicit registered translation routes. XIB is not a generic converter mode and is not inferred from resource type.

XIB uses generic Dutch building-block names. PZP contributes supported source data points, but PZP-specific labels are not the intended public XIB concept model.

Parent Policy

XIB profiles use EU Base/Core parents wherever those parents exist and fit the supported source data. When no suitable EU parent is available, or when the EU profile requires data not guaranteed by every supported source route, the XIB profile extends the plain R4 resource.

Current XIB Profiles

XIB profile Title Parent choice Main source semantics
xib-Patient XIB Patient EU Base Patient patient data points from BgZ, nl-core, and currently supported PZP routes
xib-Problem XIB Problem EU Base Condition BgZ/nl-core problem data points
xib-Procedure XIB Procedure plain R4 Procedure procedure data points, including advance-care-planning procedure specializations
xib-FunctionalOrMentalStatus XIB Functional Or Mental Status EU Base medical test result BgZ/nl-core functional or mental status data points
xib-AllergyIntolerance XIB AllergyIntolerance EU Base AllergyIntolerance zib/nl-core allergy intolerance data points
xib-Encounter XIB Encounter plain R4 Encounter encounter data points from zib/nl-core and currently supported PZP routes
xib-CareTeam XIB CareTeam plain R4 CareTeam nl-core care team data points
xib-Appointment XIB Appointment plain R4 Appointment eAfspraak appointment data points
xib-MedicationRequest XIB MedicationRequest EU Base MedicationRequest medication agreement data points
xib-MedicationStatement XIB MedicationStatement EU Base MedicationStatement medication use data points
xib-MedicationDispense XIB MedicationDispense plain R4 MedicationDispense administration agreement data points
xib-Provenance XIB Provenance plain R4 Provenance BgZ metadata data points
xib-AdvanceDirective XIB Advance Directive plain R4 Consent care-directive specialization
xib-TreatmentDirective XIB Treatment Directive plain R4 Consent care-directive specialization
xib-ContactPerson XIB Contact Person plain R4 RelatedPerson contact-person data points
xib-Practitioner XIB Practitioner EU Base Practitioner health-professional practitioner data points
xib-PractitionerRole XIB PractitionerRole EU Base PractitionerRole health-professional role data points
xib-InformRelativesRequest XIB Inform Relatives Request plain R4 CommunicationRequest inform-relatives request data points
xib-MedicalDeviceProduct XIB Medical Device Product plain R4 Device medical device product data points
xib-MedicalDevice XIB Medical Device plain R4 DeviceUseStatement medical device use data points
xib-MedicalPolicyGoal XIB Medical Policy Goal plain R4 Goal medical policy goal data points
xib-OrganDonationChoiceRegistration XIB Organ Donation Choice Registration plain R4 Observation care-preference observation specialization
xib-PositionRegardingEuthanasia XIB Position Regarding Euthanasia plain R4 Observation care-preference observation specialization
xib-PreferredPlaceOfDeath XIB Preferred Place Of Death plain R4 Observation care-preference observation specialization
xib-SenseOfPurpose XIB Sense Of Purpose plain R4 Observation care-preference observation specialization
xib-SpecificCareWishes XIB Specific Care Wishes plain R4 Observation care-preference observation specialization
xib-Condition XIB Condition plain R4 Condition generic nl-core Condition profiles that are not specifically nl-core-Problem
xib-Observation XIB Observation plain R4 Observation generic nl-core Observation profiles without a more specific XIB observation profile
xib-Flag XIB Flag EU Base Flag alert and contraindication flags
xib-EpisodeOfCare XIB EpisodeOfCare plain R4 EpisodeOfCare episode-of-care data points
xib-Organization XIB Organization EU Base Organization healthcare-provider and payer organization data points
xib-Location XIB Location EU Base Location healthcare-provider location data points
xib-CarePlan XIB CarePlan plain R4 CarePlan help-from-others and nursing-intervention care-plan data points
xib-Specimen XIB Specimen plain R4 Specimen laboratory specimen data points
xib-NutritionOrder XIB NutritionOrder plain R4 NutritionOrder nutrition-advice data points
xib-Coverage XIB Coverage plain R4 Coverage payer and insurance coverage data points
xib-Medication XIB Medication EU Base Medication pharmaceutical product data points
xib-ServiceRequest XIB ServiceRequest plain R4 ServiceRequest procedure-request data points
xib-Composition XIB Composition EU Base Composition SOAP report data points
xib-Media XIB Media plain R4 Media visual-result media data points
xib-DiagnosticReport XIB DiagnosticReport EU Base DiagnosticReport text-result report data points
xib-Immunization XIB Immunization EU Base Immunization vaccination-event data points
xib-ImmunizationRecommendation XIB ImmunizationRecommendation plain R4 ImmunizationRecommendation vaccination-request data points
xib-DocumentReference XIB DocumentReference plain R4 DocumentReference wound image document-reference data points

The current Consent and Observation specializations are intentionally grouped as generic care directives and care-preference observations in the translation review. They remain separate profiles while their code/category constraints and source wrapper maps are profile-specific. If those constraints converge, they should be collapsed into a shared XIB profile with subtype choices rather than kept as source-specific profiles. The advance-care-planning procedure specialization already uses the shared xib-Procedure profile.

Supplemental Local Extension Definitions

These extension definitions are included so the generated XIB profiles can resolve supported Dutch extension URLs that are mapped by existing nl-core or zib semantics but are not reliably resolvable from the installed package set.

Extension Canonical URL Used by
xib-preferred-pharmacy http://fhir.nl/fhir/StructureDefinition/nl-core-preferred-pharmacy xib-Patient
xib-patient-legal-status http://nictiz.nl/fhir/StructureDefinition/zib-patient-legalstatus xib-Patient
xib-life-stance http://nictiz.nl/fhir/StructureDefinition/zib-LifeStance xib-Patient
xib-medicationrequest-requester-on-behalf-of http://nictiz.nl/fhir/StructureDefinition/xib-MedicationRequest-RequesterOnBehalfOf xib-MedicationRequest
xib-medicationstatement-taken http://nictiz.nl/fhir/StructureDefinition/xib-MedicationStatement-Taken xib-MedicationStatement
xib-medication-period-of-use http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse xib-MedicationDispense
xib-medication-use-duration http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration xib-MedicationRequest, xib-MedicationStatement, xib-MedicationDispense
xib-medication-additional-information http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation xib-MedicationRequest, xib-MedicationDispense
xib-medication-treatment http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment xib-MedicationRequest, xib-MedicationStatement, xib-MedicationDispense
xib-medication-stop-type http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType xib-MedicationRequest, xib-MedicationDispense
xib-medication-use-as-agreed-indicator http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-AsAgreedIndicator xib-MedicationStatement
xib-medication-use-prescriber http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Prescriber xib-MedicationStatement
xib-administration-agreement-reason http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AgreementReason xib-MedicationDispense

XIB profiles do not inherit directly from nl-core or PZP profiles. Supported Dutch and source-specific data points outside the selected parent are represented as explicit XIB slices or local XIB extension definitions.

The current reviewed XIB target maps cover every non-internal logical dataelement that is populated by the registered source maps for the supported source-to-XIB routes. Internal transfer metadata such as sourceResourceType and targetResourceType remains part of the logical handoff and is not emitted as clinical XIB payload.

Mapping Model

All XIB translations keep the same logical handoff as the other target families:

source profile -> logical model -> XIB target profile

XIB source support uses the reverse path:

XIB source profile -> logical model -> target profile

The implementation uses:

  • logical-to-xib StructureMaps for target output
  • xib-to-logical StructureMaps for XIB input/source support
  • logical models as the semantic handoff point
  • ConceptMaps only where code translation is needed

The HTTP layer selects registered routes and returns FHIR resources. It does not contain XIB-specific semantic workarounds.

Source Support

XIB resources are accepted as source profiles only when a matching xib-to-logical StructureMap and registry route exist. This keeps source behavior profile-specific and hierarchy-aware.

The supported route pairs remain visible through the translation-index endpoints and the Translation Matrix.

Generated Artifacts

The generated XIB StructureDefinitions are included in the IG artifacts. The source FSH is copied into the IG build under input/fsh/xib so XIB appears as its own profile family rather than as part of the logical-model folder.

All installed nl-core R4 resource profiles are also visible as source candidates for XIB in the translation review and in /fhir/r4/translation-index. The current nl-core package contains 152 resource StructureDefinitions; each one has an explicit route to a XIB target through either a concept-specific source map or a generic resource-shape logical model.

Use Artifacts for the generated StructureDefinition details and Target Profiles for target-family selection rules.