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

Draft as of 2026-04-01

Definitions for the logical-patient logical model.

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

0. logical-patient
Definitie

Canonical intermediate logical model for Patient translation. It is shaped to the full Patient core structure, aligned with eu-base as the structural baseline, and extended with Dutch zib and nl-core patient semantics using future-oriented normalized field names.


Base definition for all elements in a resource.

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

    Dutch BSN identifier when present as the dedicated patient identifier.

    KortDutch BSN identifier when present as the dedicated patient identifier.
    Control0..1
    TypeIdentifier
    12. logical-patient.identifier
    Definitie

    Patient identifiers.

    KortPatient identifiers.
    NotitieDit is een business-identifier, geen resource-identifier (zie discussie)
    Control0..*
    TypeIdentifier
    14. logical-patient.active
    Definitie

    Whether the patient record is active.

    KortWhether the patient record is active.
    Control0..1
    Typeboolean
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    16. logical-patient.name
    Definitie

    Patient names.

    KortPatient names.
    Control0..*
    TypeHumanName
    18. logical-patient.photo
    Definitie

    Patient photos.

    KortPatient photos.
    Control0..*
    TypeAttachment
    20. logical-patient.preferredPharmacy
    Definitie

    Preferred pharmacy reference when carried on the BgZ patient source.

    KortPreferred pharmacy reference when carried on the BgZ patient source.
    Control0..1
    TypeReference(Organization)
    22. logical-patient.telecom
    Definitie

    Patient contact points.

    KortPatient contact points.
    Control0..*
    TypeContactPoint
    24. logical-patient.telephoneNumber
    Definitie

    Patient telephone contact points.

    KortPatient telephone contact points.
    Control0..*
    TypeContactPoint
    26. logical-patient.emailAddress
    Definitie

    Patient email contact points.

    KortPatient email contact points.
    Control0..*
    TypeContactPoint
    28. logical-patient.gender
    Definitie

    Administrative gender.

    KortAdministrative gender.
    Control0..1
    Typecode
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    30. logical-patient.genderAdditionalCoding
    Definitie

    Additional Dutch coding for administrative gender when present.

    KortAdditional Dutch coding for administrative gender when present.
    Control0..1
    TypeCodeableConcept
    32. logical-patient.birthDate
    Definitie

    Date of birth.

    KortDate of birth.
    Control0..1
    Typedate
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    34. logical-patient.deceasedBoolean
    Definitie

    Whether the patient is deceased.

    KortWhether the patient is deceased.
    Control0..1
    Typeboolean
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    36. logical-patient.deceasedDateTime
    Definitie

    Date and time of death when recorded.

    KortDate and time of death when recorded.
    Control0..1
    TypedateTime
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    38. logical-patient.address
    Definitie

    Patient addresses.

    KortPatient addresses.
    Control0..*
    TypeAddress
    40. logical-patient.maritalStatus
    Definitie

    Formal marital or civil status.

    KortFormal marital or civil status.
    Control0..1
    TypeCodeableConcept
    42. logical-patient.multipleBirthBoolean
    Definitie

    Whether the patient is part of a multiple birth.

    KortWhether the patient is part of a multiple birth.
    Control0..1
    Typeboolean
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    44. logical-patient.multipleBirthInteger
    Definitie

    Birth order within a multiple birth when recorded as a number.

    KortBirth order within a multiple birth when recorded as a number.
    Control0..1
    Typeinteger
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    46. logical-patient.nationality
    Definitie

    Country of citizenship or nationality with optional associated period.

    KortCountry of citizenship or nationality with optional associated period.
    Control0..*
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-patient-nationality
    48. logical-patient.legalStatus
    Definitie

    Legal status when carried on the BgZ patient source.

    KortLegal status when carried on the BgZ patient source.
    Control0..1
    TypeCodeableConcept
    50. logical-patient.lifeStance
    Definitie

    Life stance when carried on the BgZ patient source.

    KortLife stance when carried on the BgZ patient source.
    Control0..1
    TypeCodeableConcept
    52. logical-patient.communication
    Definitie

    Communication and language proficiency information.

    KortCommunication and language proficiency information.
    Control0..*
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-patient-communication
    54. logical-patient.contact
    Definitie

    Contact person information.

    KortContact person information.
    Control0..*
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-patient-contact
    56. logical-patient.generalPractitioner
    Definitie

    General practitioner or responsible health professional reference.

    KortGeneral practitioner or responsible health professional reference.
    Control0..*
    TypeReference
    58. logical-patient.generalPractitionerRole
    Definitie

    PractitionerRole references carried through the Dutch STU3 practitioner-role reference extension.

    KortPractitionerRole references carried through the Dutch STU3 practitioner-role reference extension.
    Control0..*
    TypeReference(PractitionerRole)
    60. logical-patient.managingOrganization
    Definitie

    Organization that manages the patient record.

    KortOrganization that manages the patient record.
    Control0..1
    TypeReference(Organization)
    62. logical-patient.link
    Definitie

    Links to other patient or related person records.

    KortLinks to other patient or related person records.
    Control0..*
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-patient-link

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

    0. logical-patient
    Definitie

    Canonical intermediate logical model for Patient translation. It is shaped to the full Patient core structure, aligned with eu-base as the structural baseline, and extended with Dutch zib and nl-core patient semantics using future-oriented normalized field names.

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

    Dutch BSN identifier when present as the dedicated patient identifier.

    KortDutch BSN identifier when present as the dedicated patient identifier.
    Control0..1
    TypeIdentifier
    8. logical-patient.identifier
    Definitie

    Patient identifiers.

    KortPatient identifiers.
    NotitieDit is een business-identifier, geen resource-identifier (zie discussie)
    Control0..*
    TypeIdentifier
    10. logical-patient.active
    Definitie

    Whether the patient record is active.

    KortWhether the patient record is active.
    Control0..1
    Typeboolean
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    12. logical-patient.name
    Definitie

    Patient names.

    KortPatient names.
    Control0..*
    TypeHumanName
    14. logical-patient.photo
    Definitie

    Patient photos.

    KortPatient photos.
    Control0..*
    TypeAttachment
    16. logical-patient.preferredPharmacy
    Definitie

    Preferred pharmacy reference when carried on the BgZ patient source.

    KortPreferred pharmacy reference when carried on the BgZ patient source.
    Control0..1
    TypeReference(Organization)
    18. logical-patient.telecom
    Definitie

    Patient contact points.

    KortPatient contact points.
    Control0..*
    TypeContactPoint
    20. logical-patient.telephoneNumber
    Definitie

    Patient telephone contact points.

    KortPatient telephone contact points.
    Control0..*
    TypeContactPoint
    22. logical-patient.emailAddress
    Definitie

    Patient email contact points.

    KortPatient email contact points.
    Control0..*
    TypeContactPoint
    24. logical-patient.gender
    Definitie

    Administrative gender.

    KortAdministrative gender.
    Control0..1
    Typecode
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    26. logical-patient.genderAdditionalCoding
    Definitie

    Additional Dutch coding for administrative gender when present.

    KortAdditional Dutch coding for administrative gender when present.
    Control0..1
    TypeCodeableConcept
    28. logical-patient.birthDate
    Definitie

    Date of birth.

    KortDate of birth.
    Control0..1
    Typedate
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    30. logical-patient.deceasedBoolean
    Definitie

    Whether the patient is deceased.

    KortWhether the patient is deceased.
    Control0..1
    Typeboolean
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    32. logical-patient.deceasedDateTime
    Definitie

    Date and time of death when recorded.

    KortDate and time of death when recorded.
    Control0..1
    TypedateTime
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    34. logical-patient.address
    Definitie

    Patient addresses.

    KortPatient addresses.
    Control0..*
    TypeAddress
    36. logical-patient.maritalStatus
    Definitie

    Formal marital or civil status.

    KortFormal marital or civil status.
    Control0..1
    TypeCodeableConcept
    38. logical-patient.multipleBirthBoolean
    Definitie

    Whether the patient is part of a multiple birth.

    KortWhether the patient is part of a multiple birth.
    Control0..1
    Typeboolean
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    40. logical-patient.multipleBirthInteger
    Definitie

    Birth order within a multiple birth when recorded as a number.

    KortBirth order within a multiple birth when recorded as a number.
    Control0..1
    Typeinteger
    Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
    42. logical-patient.nationality
    Definitie

    Country of citizenship or nationality with optional associated period.

    KortCountry of citizenship or nationality with optional associated period.
    Control0..*
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-patient-nationality
    44. logical-patient.legalStatus
    Definitie

    Legal status when carried on the BgZ patient source.

    KortLegal status when carried on the BgZ patient source.
    Control0..1
    TypeCodeableConcept
    46. logical-patient.lifeStance
    Definitie

    Life stance when carried on the BgZ patient source.

    KortLife stance when carried on the BgZ patient source.
    Control0..1
    TypeCodeableConcept
    48. logical-patient.communication
    Definitie

    Communication and language proficiency information.

    KortCommunication and language proficiency information.
    Control0..*
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-patient-communication
    50. logical-patient.contact
    Definitie

    Contact person information.

    KortContact person information.
    Control0..*
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-patient-contact
    52. logical-patient.generalPractitioner
    Definitie

    General practitioner or responsible health professional reference.

    KortGeneral practitioner or responsible health professional reference.
    Control0..*
    TypeReference
    54. logical-patient.generalPractitionerRole
    Definitie

    PractitionerRole references carried through the Dutch STU3 practitioner-role reference extension.

    KortPractitionerRole references carried through the Dutch STU3 practitioner-role reference extension.
    Control0..*
    TypeReference(PractitionerRole)
    56. logical-patient.managingOrganization
    Definitie

    Organization that manages the patient record.

    KortOrganization that manages the patient record.
    Control0..1
    TypeReference(Organization)
    58. logical-patient.link
    Definitie

    Links to other patient or related person records.

    KortLinks to other patient or related person records.
    Control0..*
    Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-patient-link

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

    0. logical-patient
    Definitie

    Canonical intermediate logical model for Patient translation. It is shaped to the full Patient core structure, aligned with eu-base as the structural baseline, and extended with Dutch zib and nl-core patient semantics using future-oriented normalized field names.

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

      Dutch BSN identifier when present as the dedicated patient identifier.

      KortDutch BSN identifier when present as the dedicated patient identifier.
      Control0..1
      TypeIdentifier
      12. logical-patient.identifier
      Definitie

      Patient identifiers.

      KortPatient identifiers.
      NotitieDit is een business-identifier, geen resource-identifier (zie discussie)
      Control0..*
      TypeIdentifier
      14. logical-patient.active
      Definitie

      Whether the patient record is active.

      KortWhether the patient record is active.
      Control0..1
      Typeboolean
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      16. logical-patient.name
      Definitie

      Patient names.

      KortPatient names.
      Control0..*
      TypeHumanName
      18. logical-patient.photo
      Definitie

      Patient photos.

      KortPatient photos.
      Control0..*
      TypeAttachment
      20. logical-patient.preferredPharmacy
      Definitie

      Preferred pharmacy reference when carried on the BgZ patient source.

      KortPreferred pharmacy reference when carried on the BgZ patient source.
      Control0..1
      TypeReference(Organization)
      22. logical-patient.telecom
      Definitie

      Patient contact points.

      KortPatient contact points.
      Control0..*
      TypeContactPoint
      24. logical-patient.telephoneNumber
      Definitie

      Patient telephone contact points.

      KortPatient telephone contact points.
      Control0..*
      TypeContactPoint
      26. logical-patient.emailAddress
      Definitie

      Patient email contact points.

      KortPatient email contact points.
      Control0..*
      TypeContactPoint
      28. logical-patient.gender
      Definitie

      Administrative gender.

      KortAdministrative gender.
      Control0..1
      Typecode
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      30. logical-patient.genderAdditionalCoding
      Definitie

      Additional Dutch coding for administrative gender when present.

      KortAdditional Dutch coding for administrative gender when present.
      Control0..1
      TypeCodeableConcept
      32. logical-patient.birthDate
      Definitie

      Date of birth.

      KortDate of birth.
      Control0..1
      Typedate
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      34. logical-patient.deceasedBoolean
      Definitie

      Whether the patient is deceased.

      KortWhether the patient is deceased.
      Control0..1
      Typeboolean
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      36. logical-patient.deceasedDateTime
      Definitie

      Date and time of death when recorded.

      KortDate and time of death when recorded.
      Control0..1
      TypedateTime
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      38. logical-patient.address
      Definitie

      Patient addresses.

      KortPatient addresses.
      Control0..*
      TypeAddress
      40. logical-patient.maritalStatus
      Definitie

      Formal marital or civil status.

      KortFormal marital or civil status.
      Control0..1
      TypeCodeableConcept
      42. logical-patient.multipleBirthBoolean
      Definitie

      Whether the patient is part of a multiple birth.

      KortWhether the patient is part of a multiple birth.
      Control0..1
      Typeboolean
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      44. logical-patient.multipleBirthInteger
      Definitie

      Birth order within a multiple birth when recorded as a number.

      KortBirth order within a multiple birth when recorded as a number.
      Control0..1
      Typeinteger
      Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
      46. logical-patient.nationality
      Definitie

      Country of citizenship or nationality with optional associated period.

      KortCountry of citizenship or nationality with optional associated period.
      Control0..*
      Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-patient-nationality
      48. logical-patient.legalStatus
      Definitie

      Legal status when carried on the BgZ patient source.

      KortLegal status when carried on the BgZ patient source.
      Control0..1
      TypeCodeableConcept
      50. logical-patient.lifeStance
      Definitie

      Life stance when carried on the BgZ patient source.

      KortLife stance when carried on the BgZ patient source.
      Control0..1
      TypeCodeableConcept
      52. logical-patient.communication
      Definitie

      Communication and language proficiency information.

      KortCommunication and language proficiency information.
      Control0..*
      Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-patient-communication
      54. logical-patient.contact
      Definitie

      Contact person information.

      KortContact person information.
      Control0..*
      Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-patient-contact
      56. logical-patient.generalPractitioner
      Definitie

      General practitioner or responsible health professional reference.

      KortGeneral practitioner or responsible health professional reference.
      Control0..*
      TypeReference
      58. logical-patient.generalPractitionerRole
      Definitie

      PractitionerRole references carried through the Dutch STU3 practitioner-role reference extension.

      KortPractitionerRole references carried through the Dutch STU3 practitioner-role reference extension.
      Control0..*
      TypeReference(PractitionerRole)
      60. logical-patient.managingOrganization
      Definitie

      Organization that manages the patient record.

      KortOrganization that manages the patient record.
      Control0..1
      TypeReference(Organization)
      62. logical-patient.link
      Definitie

      Links to other patient or related person records.

      KortLinks to other patient or related person records.
      Control0..*
      Typehttps://translate-ig.cumuluz.dev/ig/StructureDefinition/logical-patient-link