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

Logical Model: LogicalMetadata - Detailed Descriptions

Draft as of 2026-05-27

Definitions for the logical-metadata logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. logical-metadata
Definitie

Canonical intermediate logical model for BgZ metadata translation. It is shaped closely to R4 Provenance and preserves only the BgZ metadata content currently translated by this service.


Base definition for all elements in a resource.

KortLogical Model: MetadataBase for all elements
Control0..*
Dit element wordt geraakt door de volgende invariants: ele-1
Is modifierfalse
Logisch modelInstances van dit logish model zijn niet gemarkeerd om doel van een Reference te zijn
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. logical-metadata.id
Definitie

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

KortUnique id for inter-element referencing
Control0..1
Typestring
Is modifierfalse
Xml-formaatIn xml wordt dit attribuut gerepresenteerd als attribuut.
Samenvattingfalse
4. logical-metadata.extension
Definitie

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

KortAdditional content defined by implementations
Opmerkingen

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is modifierfalse
Samenvattingfalse
Alternatieve namenextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingDit element introduceert een set slices op logical-metadata.extensionDe slices zijnZonder volgorde en Open, en kunnen worden gedifferentieerd met de volgende discriminators:
  • value @ url
  • 6. logical-metadata.sourceProfile
    Definitie

    Source profile used to populate this logical model.

    Kortsource Profile
    Control0..1
    Typeuri
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    8. logical-metadata.targetProfile
    Definitie

    Target profile intended for this logical model instance.

    Korttarget Profile
    Control0..1
    Typeuri
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    10. logical-metadata.sourceProfileElementUrl
    Definitie

    Canonical URL of a source-side profile-specific extension or profile element preserved by this logical model.

    KortCanonical URL of a source-side profile-specific extension or profile element preserved by this logical model.
    Control0..*
    Typeuri
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    12. logical-metadata.sourceProfileElementJson
    Definitie

    Serialized source-side profile-specific extension or profile element payload when it cannot be represented by the generic R4 base shape.

    KortSerialized source-side profile-specific extension or profile element payload when it cannot be represented by the generic R4 base shape.
    Control0..*
    Typestring
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    14. logical-metadata.targetProfileElementUrl
    Definitie

    Canonical URL of a target-side profile-specific extension or profile element preserved by this logical model.

    KortCanonical URL of a target-side profile-specific extension or profile element preserved by this logical model.
    Control0..*
    Typeuri
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    16. logical-metadata.targetProfileElementJson
    Definitie

    Serialized target-side profile-specific extension or profile element payload when it cannot be represented by the generic R4 base shape.

    KortSerialized target-side profile-specific extension or profile element payload when it cannot be represented by the generic R4 base shape.
    Control0..*
    Typestring
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    18. logical-metadata.profileSpecificData
    Definitie

    Profile-specific extension data carried explicitly by the logical model alongside the normalized R4 payload.

    KortProfile-specific extension data carried explicitly by the logical model alongside the normalized R4 payload.
    Control0..*
    TypeExtension
    20. logical-metadata.target
    Definitie

    Resources that this metadata record applies to.

    KortResources that this metadata record applies to.
    Control1..*
    TypeReference
    22. logical-metadata.recorded
    Definitie

    Timestamp at which the metadata event was recorded.

    KortTimestamp at which the metadata event was recorded.
    Control1..1
    Typeinstant
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    24. logical-metadata.activity
    Definitie

    Activity that led to the metadata event.

    KortActivity that led to the metadata event.
    Control0..1
    TypeCodeableConcept
    26. logical-metadata.agent
    Definitie

    Agents associated with the metadata event.

    KortAgents associated with the metadata event.
    Control0..*
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-metadata-agent

    Guidance on how to interpret the contents of this table can be foundhere

    0. logical-metadata
    Definitie

    Canonical intermediate logical model for BgZ metadata translation. It is shaped closely to R4 Provenance and preserves only the BgZ metadata content currently translated by this service.

    KortLogical Model: Metadata
    Logisch modelInstances van dit logish model zijn niet gemarkeerd om doel van een Reference te zijn
    2. logical-metadata.sourceProfile
    Definitie

    Source profile used to populate this logical model.

    Kortsource Profile
    Control0..1
    Typeuri
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    4. logical-metadata.targetProfile
    Definitie

    Target profile intended for this logical model instance.

    Korttarget Profile
    Control0..1
    Typeuri
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    6. logical-metadata.sourceProfileElementUrl
    Definitie

    Canonical URL of a source-side profile-specific extension or profile element preserved by this logical model.

    KortCanonical URL of a source-side profile-specific extension or profile element preserved by this logical model.
    Control0..*
    Typeuri
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    8. logical-metadata.sourceProfileElementJson
    Definitie

    Serialized source-side profile-specific extension or profile element payload when it cannot be represented by the generic R4 base shape.

    KortSerialized source-side profile-specific extension or profile element payload when it cannot be represented by the generic R4 base shape.
    Control0..*
    Typestring
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    10. logical-metadata.targetProfileElementUrl
    Definitie

    Canonical URL of a target-side profile-specific extension or profile element preserved by this logical model.

    KortCanonical URL of a target-side profile-specific extension or profile element preserved by this logical model.
    Control0..*
    Typeuri
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    12. logical-metadata.targetProfileElementJson
    Definitie

    Serialized target-side profile-specific extension or profile element payload when it cannot be represented by the generic R4 base shape.

    KortSerialized target-side profile-specific extension or profile element payload when it cannot be represented by the generic R4 base shape.
    Control0..*
    Typestring
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    14. logical-metadata.profileSpecificData
    Definitie

    Profile-specific extension data carried explicitly by the logical model alongside the normalized R4 payload.

    KortProfile-specific extension data carried explicitly by the logical model alongside the normalized R4 payload.
    Control0..*
    TypeExtension
    16. logical-metadata.target
    Definitie

    Resources that this metadata record applies to.

    KortResources that this metadata record applies to.
    Control1..*
    TypeReference
    18. logical-metadata.recorded
    Definitie

    Timestamp at which the metadata event was recorded.

    KortTimestamp at which the metadata event was recorded.
    Control1..1
    Typeinstant
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    20. logical-metadata.activity
    Definitie

    Activity that led to the metadata event.

    KortActivity that led to the metadata event.
    Control0..1
    TypeCodeableConcept
    22. logical-metadata.agent
    Definitie

    Agents associated with the metadata event.

    KortAgents associated with the metadata event.
    Control0..*
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-metadata-agent

    Guidance on how to interpret the contents of this table can be foundhere

    0. logical-metadata
    Definitie

    Canonical intermediate logical model for BgZ metadata translation. It is shaped closely to R4 Provenance and preserves only the BgZ metadata content currently translated by this service.

    KortLogical Model: Metadata
    Control0..*
    Dit element wordt geraakt door de volgende invariants: ele-1
    Is modifierfalse
    Logisch modelInstances van dit logish model zijn niet gemarkeerd om doel van een Reference te zijn
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    2. logical-metadata.id
    Definitie

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    KortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is modifierfalse
    Xml-formaatIn xml wordt dit attribuut gerepresenteerd als attribuut.
    Samenvattingfalse
    4. logical-metadata.extension
    Definitie

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    KortAdditional content defined by implementations
    Opmerkingen

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is modifierfalse
    Samenvattingfalse
    Alternatieve namenextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingDit element introduceert een set slices op logical-metadata.extensionDe slices zijnZonder volgorde en Open, en kunnen worden gedifferentieerd met de volgende discriminators:
    • value @ url
    • 6. logical-metadata.sourceProfile
      Definitie

      Source profile used to populate this logical model.

      Kortsource Profile
      Control0..1
      Typeuri
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      8. logical-metadata.targetProfile
      Definitie

      Target profile intended for this logical model instance.

      Korttarget Profile
      Control0..1
      Typeuri
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      10. logical-metadata.sourceProfileElementUrl
      Definitie

      Canonical URL of a source-side profile-specific extension or profile element preserved by this logical model.

      KortCanonical URL of a source-side profile-specific extension or profile element preserved by this logical model.
      Control0..*
      Typeuri
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      12. logical-metadata.sourceProfileElementJson
      Definitie

      Serialized source-side profile-specific extension or profile element payload when it cannot be represented by the generic R4 base shape.

      KortSerialized source-side profile-specific extension or profile element payload when it cannot be represented by the generic R4 base shape.
      Control0..*
      Typestring
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      14. logical-metadata.targetProfileElementUrl
      Definitie

      Canonical URL of a target-side profile-specific extension or profile element preserved by this logical model.

      KortCanonical URL of a target-side profile-specific extension or profile element preserved by this logical model.
      Control0..*
      Typeuri
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      16. logical-metadata.targetProfileElementJson
      Definitie

      Serialized target-side profile-specific extension or profile element payload when it cannot be represented by the generic R4 base shape.

      KortSerialized target-side profile-specific extension or profile element payload when it cannot be represented by the generic R4 base shape.
      Control0..*
      Typestring
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      18. logical-metadata.profileSpecificData
      Definitie

      Profile-specific extension data carried explicitly by the logical model alongside the normalized R4 payload.

      KortProfile-specific extension data carried explicitly by the logical model alongside the normalized R4 payload.
      Control0..*
      TypeExtension
      20. logical-metadata.target
      Definitie

      Resources that this metadata record applies to.

      KortResources that this metadata record applies to.
      Control1..*
      TypeReference
      22. logical-metadata.recorded
      Definitie

      Timestamp at which the metadata event was recorded.

      KortTimestamp at which the metadata event was recorded.
      Control1..1
      Typeinstant
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      24. logical-metadata.activity
      Definitie

      Activity that led to the metadata event.

      KortActivity that led to the metadata event.
      Control0..1
      TypeCodeableConcept
      26. logical-metadata.agent
      Definitie

      Agents associated with the metadata event.

      KortAgents associated with the metadata event.
      Control0..*
      Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-metadata-agent