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

Draft as of 2026-07-11

Definitions for the logical-document-reference logical model.

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

0. logical-document-reference
Definitie

Canonical intermediate logical model for DocumentReference-shaped nl-core routes.


Base definition for all elements in a resource.

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

    FHIR source resource type accepted on the source side.

    KortFHIR source resource type accepted on the source side.
    Control0..1
    Typecode
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    12. logical-document-reference.targetResourceType
    Definitie

    FHIR target resource type produced on the target side.

    KortFHIR target resource type produced on the target side.
    Control0..1
    Typecode
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    14. logical-document-reference.masterIdentifier
    Definitie

    Master identifier.

    KortMaster identifier.
    Control0..1
    TypeIdentifier
    16. logical-document-reference.identifier
    Definitie

    Document identifiers.

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

    Document reference status.

    KortDocument reference status.
    Control0..1
    Typecode
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    20. logical-document-reference.docStatus
    Definitie

    Document status.

    KortDocument status.
    Control0..1
    Typecode
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    22. logical-document-reference.type
    Definitie

    Document type.

    KortDocument type.
    Control0..1
    TypeCodeableConcept
    24. logical-document-reference.category
    Definitie

    Categories.

    KortCategories.
    Control0..*
    TypeCodeableConcept
    26. logical-document-reference.subject
    Definitie

    Subject.

    KortSubject.
    Control0..1
    TypeReference
    28. logical-document-reference.date
    Definitie

    Document date.

    KortDocument date.
    Control0..1
    Typeinstant
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    30. logical-document-reference.author
    Definitie

    Authors.

    KortAuthors.
    Control0..*
    TypeReference
    32. logical-document-reference.authenticator
    Definitie

    Authenticator.

    KortAuthenticator.
    Control0..1
    TypeReference
    34. logical-document-reference.custodian
    Definitie

    Custodian.

    KortCustodian.
    Control0..1
    TypeReference
    36. logical-document-reference.relatesToTarget
    Definitie

    Related document targets.

    KortRelated document targets.
    Control0..*
    TypeReference
    38. logical-document-reference.description
    Definitie

    Description.

    KortDescription.
    Control0..1
    Typestring
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    40. logical-document-reference.securityLabel
    Definitie

    Security labels.

    KortSecurity labels.
    Control0..*
    TypeCodeableConcept
    42. logical-document-reference.contentAttachment
    Definitie

    Document content attachments.

    KortDocument content attachments.
    Control0..*
    TypeAttachment
    44. logical-document-reference.contextEncounter
    Definitie

    Context encounters.

    KortContext encounters.
    Control0..*
    TypeReference
    46. logical-document-reference.contextEvent
    Definitie

    Context events.

    KortContext events.
    Control0..*
    TypeCodeableConcept
    48. logical-document-reference.contextPeriod
    Definitie

    Context period.

    KortContext period.
    Control0..1
    TypePeriod
    50. logical-document-reference.contextFacilityType
    Definitie

    Facility type.

    KortFacility type.
    Control0..1
    TypeCodeableConcept
    52. logical-document-reference.contextPracticeSetting
    Definitie

    Practice setting.

    KortPractice setting.
    Control0..1
    TypeCodeableConcept
    54. logical-document-reference.contextSourcePatientInfo
    Definitie

    Source patient info.

    KortSource patient info.
    Control0..1
    TypeReference
    56. logical-document-reference.contextRelated
    Definitie

    Related context references.

    KortRelated context references.
    Control0..*
    TypeReference

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

    0. logical-document-reference
    Definitie

    Canonical intermediate logical model for DocumentReference-shaped nl-core routes.

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

    FHIR source resource type accepted on the source side.

    KortFHIR source resource type accepted on the source side.
    Control0..1
    Typecode
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    8. logical-document-reference.targetResourceType
    Definitie

    FHIR target resource type produced on the target side.

    KortFHIR target resource type produced on the target side.
    Control0..1
    Typecode
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    10. logical-document-reference.masterIdentifier
    Definitie

    Master identifier.

    KortMaster identifier.
    Control0..1
    TypeIdentifier
    12. logical-document-reference.identifier
    Definitie

    Document identifiers.

    KortDocument identifiers.
    NotitieDit is een business-identifier, geen resource-identifier (zie discussie)
    Control0..*
    TypeIdentifier
    14. logical-document-reference.status
    Definitie

    Document reference status.

    KortDocument reference status.
    Control0..1
    Typecode
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    16. logical-document-reference.docStatus
    Definitie

    Document status.

    KortDocument status.
    Control0..1
    Typecode
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    18. logical-document-reference.type
    Definitie

    Document type.

    KortDocument type.
    Control0..1
    TypeCodeableConcept
    20. logical-document-reference.category
    Definitie

    Categories.

    KortCategories.
    Control0..*
    TypeCodeableConcept
    22. logical-document-reference.subject
    Definitie

    Subject.

    KortSubject.
    Control0..1
    TypeReference
    24. logical-document-reference.date
    Definitie

    Document date.

    KortDocument date.
    Control0..1
    Typeinstant
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    26. logical-document-reference.author
    Definitie

    Authors.

    KortAuthors.
    Control0..*
    TypeReference
    28. logical-document-reference.authenticator
    Definitie

    Authenticator.

    KortAuthenticator.
    Control0..1
    TypeReference
    30. logical-document-reference.custodian
    Definitie

    Custodian.

    KortCustodian.
    Control0..1
    TypeReference
    32. logical-document-reference.relatesToTarget
    Definitie

    Related document targets.

    KortRelated document targets.
    Control0..*
    TypeReference
    34. logical-document-reference.description
    Definitie

    Description.

    KortDescription.
    Control0..1
    Typestring
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    36. logical-document-reference.securityLabel
    Definitie

    Security labels.

    KortSecurity labels.
    Control0..*
    TypeCodeableConcept
    38. logical-document-reference.contentAttachment
    Definitie

    Document content attachments.

    KortDocument content attachments.
    Control0..*
    TypeAttachment
    40. logical-document-reference.contextEncounter
    Definitie

    Context encounters.

    KortContext encounters.
    Control0..*
    TypeReference
    42. logical-document-reference.contextEvent
    Definitie

    Context events.

    KortContext events.
    Control0..*
    TypeCodeableConcept
    44. logical-document-reference.contextPeriod
    Definitie

    Context period.

    KortContext period.
    Control0..1
    TypePeriod
    46. logical-document-reference.contextFacilityType
    Definitie

    Facility type.

    KortFacility type.
    Control0..1
    TypeCodeableConcept
    48. logical-document-reference.contextPracticeSetting
    Definitie

    Practice setting.

    KortPractice setting.
    Control0..1
    TypeCodeableConcept
    50. logical-document-reference.contextSourcePatientInfo
    Definitie

    Source patient info.

    KortSource patient info.
    Control0..1
    TypeReference
    52. logical-document-reference.contextRelated
    Definitie

    Related context references.

    KortRelated context references.
    Control0..*
    TypeReference

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

    0. logical-document-reference
    Definitie

    Canonical intermediate logical model for DocumentReference-shaped nl-core routes.

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

      FHIR source resource type accepted on the source side.

      KortFHIR source resource type accepted on the source side.
      Control0..1
      Typecode
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      12. logical-document-reference.targetResourceType
      Definitie

      FHIR target resource type produced on the target side.

      KortFHIR target resource type produced on the target side.
      Control0..1
      Typecode
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      14. logical-document-reference.masterIdentifier
      Definitie

      Master identifier.

      KortMaster identifier.
      Control0..1
      TypeIdentifier
      16. logical-document-reference.identifier
      Definitie

      Document identifiers.

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

      Document reference status.

      KortDocument reference status.
      Control0..1
      Typecode
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      20. logical-document-reference.docStatus
      Definitie

      Document status.

      KortDocument status.
      Control0..1
      Typecode
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      22. logical-document-reference.type
      Definitie

      Document type.

      KortDocument type.
      Control0..1
      TypeCodeableConcept
      24. logical-document-reference.category
      Definitie

      Categories.

      KortCategories.
      Control0..*
      TypeCodeableConcept
      26. logical-document-reference.subject
      Definitie

      Subject.

      KortSubject.
      Control0..1
      TypeReference
      28. logical-document-reference.date
      Definitie

      Document date.

      KortDocument date.
      Control0..1
      Typeinstant
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      30. logical-document-reference.author
      Definitie

      Authors.

      KortAuthors.
      Control0..*
      TypeReference
      32. logical-document-reference.authenticator
      Definitie

      Authenticator.

      KortAuthenticator.
      Control0..1
      TypeReference
      34. logical-document-reference.custodian
      Definitie

      Custodian.

      KortCustodian.
      Control0..1
      TypeReference
      36. logical-document-reference.relatesToTarget
      Definitie

      Related document targets.

      KortRelated document targets.
      Control0..*
      TypeReference
      38. logical-document-reference.description
      Definitie

      Description.

      KortDescription.
      Control0..1
      Typestring
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      40. logical-document-reference.securityLabel
      Definitie

      Security labels.

      KortSecurity labels.
      Control0..*
      TypeCodeableConcept
      42. logical-document-reference.contentAttachment
      Definitie

      Document content attachments.

      KortDocument content attachments.
      Control0..*
      TypeAttachment
      44. logical-document-reference.contextEncounter
      Definitie

      Context encounters.

      KortContext encounters.
      Control0..*
      TypeReference
      46. logical-document-reference.contextEvent
      Definitie

      Context events.

      KortContext events.
      Control0..*
      TypeCodeableConcept
      48. logical-document-reference.contextPeriod
      Definitie

      Context period.

      KortContext period.
      Control0..1
      TypePeriod
      50. logical-document-reference.contextFacilityType
      Definitie

      Facility type.

      KortFacility type.
      Control0..1
      TypeCodeableConcept
      52. logical-document-reference.contextPracticeSetting
      Definitie

      Practice setting.

      KortPractice setting.
      Control0..1
      TypeCodeableConcept
      54. logical-document-reference.contextSourcePatientInfo
      Definitie

      Source patient info.

      KortSource patient info.
      Control0..1
      TypeReference
      56. logical-document-reference.contextRelated
      Definitie

      Related context references.

      KortRelated context references.
      Control0..*
      TypeReference