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

Translation Matrix

Translation Matrix

How To Read This Matrix

Each row is one supported source profile route.

The service does not infer arbitrary source-to-target conversions based only on resource type. A translation is supported only when the exact source profile and target profile pair exists in the registry.

That keeps version overlap predictable during migration. If a current source family and a next source family both exist in practice, they still need separate explicit routes in the matrix.

Current Supported Routes

Concept STU3 source profile R4 target profile
Patient http://nictiz.nl/fhir/StructureDefinition/BgZ-Patient http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient
Patient http://nictiz.nl/fhir/StructureDefinition/BgZ-Patient http://hl7.eu/fhir/base/StructureDefinition/patient-eu-core
Patient http://nictiz.nl/fhir/StructureDefinition/BgZ-Patient http://hl7.eu/fhir/eps/StructureDefinition/patient-eu-eps
Problem http://nictiz.nl/fhir/StructureDefinition/BgZ-Problem http://nictiz.nl/fhir/StructureDefinition/nl-core-Problem
Problem http://nictiz.nl/fhir/StructureDefinition/BgZ-Problem http://hl7.eu/fhir/base/StructureDefinition/condition-eu-core
Problem http://nictiz.nl/fhir/StructureDefinition/BgZ-Problem http://hl7.eu/fhir/eps/StructureDefinition/condition-obl-eu-eps
Procedure http://nictiz.nl/fhir/StructureDefinition/BgZ-Procedure http://nictiz.nl/fhir/StructureDefinition/nl-core-Procedure-event
Procedure http://nictiz.nl/fhir/StructureDefinition/BgZ-Procedure http://hl7.eu/fhir/base/StructureDefinition/procedure-eu-core
Procedure http://nictiz.nl/fhir/StructureDefinition/BgZ-Procedure http://hl7.eu/fhir/eps/StructureDefinition/procedure-eu-eps
FunctionalOrMentalStatus http://nictiz.nl/fhir/StructureDefinition/BgZ-FunctionalOrMentalStatus http://nictiz.nl/fhir/StructureDefinition/nl-core-FunctionalOrMentalStatus
FunctionalOrMentalStatus http://nictiz.nl/fhir/StructureDefinition/BgZ-FunctionalOrMentalStatus http://hl7.eu/fhir/base/StructureDefinition/medicalTestResult-eu-core
Metadata http://nictiz.nl/fhir/StructureDefinition/BgZ-Metadata http://hl7.org/fhir/StructureDefinition/Provenance
AllergyIntolerance http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance http://nictiz.nl/fhir/StructureDefinition/nl-core-AllergyIntolerance
AllergyIntolerance http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance http://hl7.eu/fhir/base/StructureDefinition/allergyIntolerance-eu-core
AllergyIntolerance http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance http://hl7.eu/fhir/eps/StructureDefinition/allergyintolerance-obl-eu-eps
Encounter http://nictiz.nl/fhir/StructureDefinition/zib-Encounter http://nictiz.nl/fhir/StructureDefinition/nl-core-Encounter
CareTeam http://fhir.nl/fhir/StructureDefinition/nl-core-careteam http://nictiz.nl/fhir/StructureDefinition/nl-core-CareTeam
Appointment http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment http://hl7.org/fhir/StructureDefinition/Appointment
MedicationRequest http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAgreement http://hl7.eu/fhir/base/StructureDefinition/medicationRequest-eu-core
MedicationRequest http://nictiz.nl/fhir/StructureDefinition/zib-MedicationAgreement http://hl7.eu/fhir/eps/StructureDefinition/medicationrequest-obl-eu-eps
MedicationStatement http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse http://hl7.eu/fhir/base/StructureDefinition/medicationStatement-eu-core
MedicationStatement http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse http://hl7.eu/fhir/eps/StructureDefinition/MedicationStatement-eu-eps
MedicationDispense http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement http://hl7.org/fhir/StructureDefinition/MedicationDispense
PZP Patient https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-Patient
PZP Patient https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient
PZP Patient https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient http://hl7.eu/fhir/base/StructureDefinition/patient-eu-core
PZP Patient https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient http://hl7.eu/fhir/eps/StructureDefinition/patient-eu-eps
PZP Encounter https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Encounter https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-Encounter
PZP Encounter https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Encounter http://nictiz.nl/fhir/StructureDefinition/nl-core-Encounter
PZP Procedure https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Procedure https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-Procedure
PZP Procedure https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Procedure http://nictiz.nl/fhir/StructureDefinition/nl-core-Procedure-event
PZP AdvanceDirective https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-AdvanceDirective https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-AdvanceDirective
PZP AdvanceDirective https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-AdvanceDirective http://nictiz.nl/fhir/StructureDefinition/nl-core-AdvanceDirective
PZP AdvanceDirective https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-AdvanceDirective http://hl7.eu/fhir/eps/StructureDefinition/consent-eu-eps
PZP ContactPerson https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-ContactPerson https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-ContactPerson
PZP ContactPerson https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-ContactPerson http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactPerson
PZP HealthProfessional Practitioner https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-HealthProfessional-Practitioner https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-HealthProfessional-Practitioner
PZP HealthProfessional Practitioner https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-HealthProfessional-Practitioner http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner
PZP HealthProfessional Practitioner https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-HealthProfessional-Practitioner http://hl7.eu/fhir/eps/StructureDefinition/practitioner-obl-eu-eps
PZP HealthProfessional PractitionerRole https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-HealthProfessional-PractitionerRole https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-HealthProfessional-PractitionerRole
PZP HealthProfessional PractitionerRole https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-HealthProfessional-PractitionerRole http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole
PZP HealthProfessional PractitionerRole https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-HealthProfessional-PractitionerRole http://hl7.eu/fhir/eps/StructureDefinition/practitionerrole-obl-eu-eps
PZP InformRelativesRequest https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-InformRelativesRequest https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-InformRelativesRequest
PZP InformRelativesRequest https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-InformRelativesRequest http://hl7.org/fhir/StructureDefinition/CommunicationRequest
PZP MedicalDevice Product https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-MedicalDevice.Product-ICD https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-MedicalDevice.Product-ICD
PZP MedicalDevice Product https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-MedicalDevice.Product-ICD http://nictiz.nl/fhir/StructureDefinition/nl-core-MedicalDevice.Product
PZP MedicalDevice Product https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-MedicalDevice.Product-ICD http://hl7.eu/fhir/eps/StructureDefinition/device-eu-eps
PZP MedicalDevice https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-MedicalDevice https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-MedicalDevice
PZP MedicalDevice https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-MedicalDevice http://nictiz.nl/fhir/StructureDefinition/nl-core-MedicalDevice
PZP MedicalDevice https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-MedicalDevice http://hl7.eu/fhir/eps/StructureDefinition/deviceUseStatement-eu-eps
PZP MedicalPolicyGoal https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-MedicalPolicyGoal https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-MedicalPolicyGoal
PZP MedicalPolicyGoal https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-MedicalPolicyGoal http://hl7.org/fhir/StructureDefinition/Goal
PZP OrganDonationChoiceRegistration https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-OrganDonationChoiceRegistration https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-OrganDonationChoiceRegistration
PZP OrganDonationChoiceRegistration https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-OrganDonationChoiceRegistration http://hl7.org/fhir/StructureDefinition/Observation
PZP PositionRegardingEuthanasia https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-PositionRegardingEuthanasia https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-PositionRegardingEuthanasia
PZP PositionRegardingEuthanasia https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-PositionRegardingEuthanasia http://hl7.org/fhir/StructureDefinition/Observation
PZP PreferredPlaceOfDeath https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-PreferredPlaceOfDeath https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-PreferredPlaceOfDeath
PZP PreferredPlaceOfDeath https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-PreferredPlaceOfDeath http://hl7.org/fhir/StructureDefinition/Observation
PZP SenseOfPurpose https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-SenseOfPurpose https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-SenseOfPurpose
PZP SenseOfPurpose https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-SenseOfPurpose http://hl7.org/fhir/StructureDefinition/Observation
PZP SpecificCareWishes https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-SpecificCareWishes https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-SpecificCareWishes
PZP SpecificCareWishes https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-SpecificCareWishes http://hl7.org/fhir/StructureDefinition/Observation
PZP TreatmentDirective https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-TreatmentDirective https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-TreatmentDirective
PZP TreatmentDirective https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-TreatmentDirective http://nictiz.nl/fhir/StructureDefinition/nl-core-TreatmentDirective2
PZP TreatmentDirective https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-TreatmentDirective http://hl7.eu/fhir/eps/StructureDefinition/consent-eu-eps

Stable Core And Extended Coverage

The original core scope for the service is:

  • Patient
  • Problem
  • Procedure

The service now supports additional concepts, but the core three remain the most important routes to keep stable and easy to understand.

The PZP rows are explicit ACP profile pairs from the installed PZP 2017 package to the matching PZP 2020 profiles. They are StructureMap-backed routes through shared logical models, not inferred resource-type conversions.

PZP ACP sources also have explicit non-PZP parent targets where the shared logical model validates against the installed generic profile. These routes are registered per source profile and target profile; the service still does not infer arbitrary resource-type conversions. Some PZP ACP sources also have explicit EPS targets: patient, advance directives, treatment directives, health professionals, device products, and device-use statements.

The registry intentionally does not expose ACP-Procedure to EU Base or EPS Procedure targets because those targets require performed timing that is not required by the installed PZP ACP Procedure source profile. Generic BgZ resources also do not target PZP ACP profiles, because PZP targets carry advance-care-planning-specific constraints that are not part of the generic BgZ source contract.

QuestionnaireResponses are not listed as profile-pair routes because they use a different contract: one completed form response is extracted into a Bundle of target resources. See QuestionnaireResponse.

EPS document Bundle output is also a Bundle-level contract rather than a simple profile-pair row. A STU3 source Bundle can target http://hl7.eu/fhir/eps/StructureDefinition/bundle-eu-eps; supported entries are translated through the EPS resource routes above and assembled into a document Bundle with a Composition.

The installed EPS package contains additional EHDS model profiles that are not registered routes. See EHDS / EPS Coverage for the explicit implemented/gap matrix.

Why Some Targets Use Base R4

Not every source concept has both an nl-core and an eu-base target in the local package set currently used by the service.

Current examples:

  • BgZ-Metadata targets base R4 Provenance
  • eAfspraak-Appointment targets base R4 Appointment
  • zib-AdministrationAgreement targets base R4 MedicationDispense
  • zib-Encounter and nl-core-careteam currently target nl-core only

This is a deliberate contract choice rather than an accidental fallback.

If a source concept is intentionally not carried through, the translation should make that visible in the output and in the mapping docs rather than hiding it behind a generic conversion rule.

Target Family Reference

If you want the conceptual difference between the target families before reading the route table, see Target Profiles.