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: LogicalEncounter - Detailed Descriptions

Draft as of 2026-05-27

Definitions for the logical-encounter logical model.

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

0. logical-encounter
Definitie

Canonical intermediate logical model for Encounter translation. It is shaped to the R4 Encounter structure where practical, while keeping the Dutch STU3 zib encounter additions explicit.


Base definition for all elements in a resource.

KortLogical Model: EncounterBase 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-encounter.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-encounter.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-encounter.extensionDe slices zijnZonder volgorde en Open, en kunnen worden gedifferentieerd met de volgende discriminators:
  • value @ url
  • 6. logical-encounter.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-encounter.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-encounter.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-encounter.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-encounter.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-encounter.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-encounter.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-encounter.identifier
    Definitie

    Encounter identifiers.

    KortEncounter identifiers.
    NotitieDit is een business-identifier, geen resource-identifier (zie discussie)
    Control0..*
    TypeIdentifier
    22. logical-encounter.status
    Definitie

    Current status of the encounter.

    KortCurrent status of the encounter.
    Control1..1
    Typecode
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    24. logical-encounter.class
    Definitie

    Classification of patient encounter.

    KortClassification of patient encounter.
    Control1..1
    TypeCoding
    26. logical-encounter.type
    Definitie

    Encounter type concepts.

    KortEncounter type concepts.
    Control0..*
    TypeCodeableConcept
    28. logical-encounter.subject
    Definitie

    Patient or subject of the encounter.

    KortPatient or subject of the encounter.
    Control0..1
    TypeReference(Patient)
    30. logical-encounter.episodeOfCare
    Definitie

    Episodes of care associated with the encounter.

    KortEpisodes of care associated with the encounter.
    Control0..*
    TypeReference
    32. logical-encounter.participant
    Definitie

    Participants involved in the encounter.

    KortParticipants involved in the encounter.
    Control0..*
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-encounter-participant
    34. logical-encounter.period
    Definitie

    Start and optional end of the encounter.

    KortStart and optional end of the encounter.
    Control0..1
    TypePeriod
    36. logical-encounter.reasonCode
    Definitie

    Textual or coded deviating result carried as an encounter reason.

    KortTextual or coded deviating result carried as an encounter reason.
    Control0..*
    TypeCodeableConcept
    38. logical-encounter.reasonReferenceProblem
    Definitie

    Problem references that explain why the encounter took place.

    KortProblem references that explain why the encounter took place.
    Control0..*
    TypeReference(Condition)
    40. logical-encounter.reasonReferenceProcedure
    Definitie

    Procedure references that explain why the encounter took place.

    KortProcedure references that explain why the encounter took place.
    Control0..*
    TypeReference(Procedure)
    42. logical-encounter.hospitalization
    Definitie

    Admission and discharge context when supplied on the source encounter.

    KortAdmission and discharge context when supplied on the source encounter.
    Control0..1
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-encounter-hospitalization
    44. logical-encounter.serviceProvider
    Definitie

    Service provider organization associated with the encounter.

    KortService provider organization associated with the encounter.
    Control0..1
    TypeReference(Organization)

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

    0. logical-encounter
    Definitie

    Canonical intermediate logical model for Encounter translation. It is shaped to the R4 Encounter structure where practical, while keeping the Dutch STU3 zib encounter additions explicit.

    KortLogical Model: Encounter
    Logisch modelInstances van dit logish model zijn niet gemarkeerd om doel van een Reference te zijn
    2. logical-encounter.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-encounter.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-encounter.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-encounter.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-encounter.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-encounter.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-encounter.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-encounter.identifier
    Definitie

    Encounter identifiers.

    KortEncounter identifiers.
    NotitieDit is een business-identifier, geen resource-identifier (zie discussie)
    Control0..*
    TypeIdentifier
    18. logical-encounter.status
    Definitie

    Current status of the encounter.

    KortCurrent status of the encounter.
    Control1..1
    Typecode
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    20. logical-encounter.class
    Definitie

    Classification of patient encounter.

    KortClassification of patient encounter.
    Control1..1
    TypeCoding
    22. logical-encounter.type
    Definitie

    Encounter type concepts.

    KortEncounter type concepts.
    Control0..*
    TypeCodeableConcept
    24. logical-encounter.subject
    Definitie

    Patient or subject of the encounter.

    KortPatient or subject of the encounter.
    Control0..1
    TypeReference(Patient)
    26. logical-encounter.episodeOfCare
    Definitie

    Episodes of care associated with the encounter.

    KortEpisodes of care associated with the encounter.
    Control0..*
    TypeReference
    28. logical-encounter.participant
    Definitie

    Participants involved in the encounter.

    KortParticipants involved in the encounter.
    Control0..*
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-encounter-participant
    30. logical-encounter.period
    Definitie

    Start and optional end of the encounter.

    KortStart and optional end of the encounter.
    Control0..1
    TypePeriod
    32. logical-encounter.reasonCode
    Definitie

    Textual or coded deviating result carried as an encounter reason.

    KortTextual or coded deviating result carried as an encounter reason.
    Control0..*
    TypeCodeableConcept
    34. logical-encounter.reasonReferenceProblem
    Definitie

    Problem references that explain why the encounter took place.

    KortProblem references that explain why the encounter took place.
    Control0..*
    TypeReference(Condition)
    36. logical-encounter.reasonReferenceProcedure
    Definitie

    Procedure references that explain why the encounter took place.

    KortProcedure references that explain why the encounter took place.
    Control0..*
    TypeReference(Procedure)
    38. logical-encounter.hospitalization
    Definitie

    Admission and discharge context when supplied on the source encounter.

    KortAdmission and discharge context when supplied on the source encounter.
    Control0..1
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-encounter-hospitalization
    40. logical-encounter.serviceProvider
    Definitie

    Service provider organization associated with the encounter.

    KortService provider organization associated with the encounter.
    Control0..1
    TypeReference(Organization)

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

    0. logical-encounter
    Definitie

    Canonical intermediate logical model for Encounter translation. It is shaped to the R4 Encounter structure where practical, while keeping the Dutch STU3 zib encounter additions explicit.

    KortLogical Model: Encounter
    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-encounter.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-encounter.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-encounter.extensionDe slices zijnZonder volgorde en Open, en kunnen worden gedifferentieerd met de volgende discriminators:
    • value @ url
    • 6. logical-encounter.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-encounter.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-encounter.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-encounter.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-encounter.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-encounter.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-encounter.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-encounter.identifier
      Definitie

      Encounter identifiers.

      KortEncounter identifiers.
      NotitieDit is een business-identifier, geen resource-identifier (zie discussie)
      Control0..*
      TypeIdentifier
      22. logical-encounter.status
      Definitie

      Current status of the encounter.

      KortCurrent status of the encounter.
      Control1..1
      Typecode
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      24. logical-encounter.class
      Definitie

      Classification of patient encounter.

      KortClassification of patient encounter.
      Control1..1
      TypeCoding
      26. logical-encounter.type
      Definitie

      Encounter type concepts.

      KortEncounter type concepts.
      Control0..*
      TypeCodeableConcept
      28. logical-encounter.subject
      Definitie

      Patient or subject of the encounter.

      KortPatient or subject of the encounter.
      Control0..1
      TypeReference(Patient)
      30. logical-encounter.episodeOfCare
      Definitie

      Episodes of care associated with the encounter.

      KortEpisodes of care associated with the encounter.
      Control0..*
      TypeReference
      32. logical-encounter.participant
      Definitie

      Participants involved in the encounter.

      KortParticipants involved in the encounter.
      Control0..*
      Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-encounter-participant
      34. logical-encounter.period
      Definitie

      Start and optional end of the encounter.

      KortStart and optional end of the encounter.
      Control0..1
      TypePeriod
      36. logical-encounter.reasonCode
      Definitie

      Textual or coded deviating result carried as an encounter reason.

      KortTextual or coded deviating result carried as an encounter reason.
      Control0..*
      TypeCodeableConcept
      38. logical-encounter.reasonReferenceProblem
      Definitie

      Problem references that explain why the encounter took place.

      KortProblem references that explain why the encounter took place.
      Control0..*
      TypeReference(Condition)
      40. logical-encounter.reasonReferenceProcedure
      Definitie

      Procedure references that explain why the encounter took place.

      KortProcedure references that explain why the encounter took place.
      Control0..*
      TypeReference(Procedure)
      42. logical-encounter.hospitalization
      Definitie

      Admission and discharge context when supplied on the source encounter.

      KortAdmission and discharge context when supplied on the source encounter.
      Control0..1
      Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-encounter-hospitalization
      44. logical-encounter.serviceProvider
      Definitie

      Service provider organization associated with the encounter.

      KortService provider organization associated with the encounter.
      Control0..1
      TypeReference(Organization)