HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1
1.0.1 - ci-build International flag

HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1, published by My Organization. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HBosires/Starter-FHIR-IG/ and changes regularly. See the Directory of published versions

Logical Model: ExampleLogicalModel - Detailed Descriptions

Active as of 2024-09-27

Definitions for the ExampleLogicalModel logical model.

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

0. ExampleLogicalModel
Definition
Exchange requirements example.

Note: This is for demonstrable purposes only!
ShortExampleLogicalModel
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ExampleLogicalModel.name
Definition

Patient name

ShortName
Control1..*
TypeBackboneElement
Must Supporttrue
4. ExampleLogicalModel.name.firstName
Definition

Patient first name

ShortFirst name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. ExampleLogicalModel.name.middleName
Definition

Patient middle name

ShortMiddle name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. ExampleLogicalModel.maritalStatus
Definition

Patient marital status

ShortMarital status
Control0..1
TypeBackboneElement
Must Supporttrue
10. ExampleLogicalModel.maritalStatus.status
Definition

A marital status

ShortStatus
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Marital Status Codes
(extensible to http://hl7.org/fhir/ValueSet/marital-status)
TypeCodeableConcept
12. ExampleLogicalModel.maritalStatus.effectiveDate
Definition

Date when status came into effect

ShortEffective date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. ExampleLogicalModel.personRelation
Definition

Person who is related to the patient

ShortPerson related to patient
Control0..*
TypeBackboneElement
Must Supporttrue
16. ExampleLogicalModel.personRelation.name
Definition

Patient name

ShortName
Control1..*
TypeBackboneElement
18. ExampleLogicalModel.personRelation.name.firstName
Definition

Person first name

ShortFirst name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. ExampleLogicalModel.personRelation.name.middleName
Definition

Person middle name

ShortMiddle name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. ExampleLogicalModel.personRelation.relationshipType
Definition

How is the person related to the patient

ShortRelationship type
Control1..1
BindingThe codes SHOULD be taken from v3 Code System RoleCode
(preferred to http://terminology.hl7.org/ValueSet/v3-RoleCode)
TypeCoding
24. ExampleLogicalModel.personRelation.maritalStatus
Definition

Related person marital status

ShortMarital status
Control0..1
TypeBackboneElement
Must Supporttrue
26. ExampleLogicalModel.personRelation.maritalStatus.status
Definition

A marital status

ShortStatus
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Marital Status Codes
(extensible to http://hl7.org/fhir/ValueSet/marital-status)
TypeCodeableConcept
28. ExampleLogicalModel.personRelation.maritalStatus.effectiveDate
Definition

Date when status came into effect

ShortEffective date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. ExampleLogicalModel
Definition
Exchange requirements example.

Note: This is for demonstrable purposes only!

Base definition for all elements in a resource.

ShortExampleLogicalModelBase for all elements
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
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. ExampleLogicalModel.name
Definition

Patient name

ShortName
Control1..*
TypeBackboneElement
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ExampleLogicalModel.name.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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())
6. ExampleLogicalModel.name.firstName
Definition

Patient first name

ShortFirst name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. ExampleLogicalModel.name.middleName
Definition

Patient middle name

ShortMiddle name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. ExampleLogicalModel.maritalStatus
Definition

Patient marital status

ShortMarital status
Control0..1
TypeBackboneElement
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ExampleLogicalModel.maritalStatus.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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())
14. ExampleLogicalModel.maritalStatus.status
Definition

A marital status

ShortStatus
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Marital Status Codes
(extensible to http://hl7.org/fhir/ValueSet/marital-status)
TypeCodeableConcept
16. ExampleLogicalModel.maritalStatus.effectiveDate
Definition

Date when status came into effect

ShortEffective date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. ExampleLogicalModel.personRelation
Definition

Person who is related to the patient

ShortPerson related to patient
Control0..*
TypeBackboneElement
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. ExampleLogicalModel.personRelation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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())
22. ExampleLogicalModel.personRelation.name
Definition

Patient name

ShortName
Control1..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. ExampleLogicalModel.personRelation.name.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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())
26. ExampleLogicalModel.personRelation.name.firstName
Definition

Person first name

ShortFirst name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. ExampleLogicalModel.personRelation.name.middleName
Definition

Person middle name

ShortMiddle name
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. ExampleLogicalModel.personRelation.relationshipType
Definition

How is the person related to the patient

ShortRelationship type
Control1..1
BindingThe codes SHOULD be taken from v3 Code System RoleCode
(preferred to http://terminology.hl7.org/ValueSet/v3-RoleCode)
TypeCoding
32. ExampleLogicalModel.personRelation.maritalStatus
Definition

Related person marital status

ShortMarital status
Control0..1
TypeBackboneElement
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. ExampleLogicalModel.personRelation.maritalStatus.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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())
36. ExampleLogicalModel.personRelation.maritalStatus.status
Definition

A marital status

ShortStatus
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Marital Status Codes
(extensible to http://hl7.org/fhir/ValueSet/marital-status)
TypeCodeableConcept
38. ExampleLogicalModel.personRelation.maritalStatus.effectiveDate
Definition

Date when status came into effect

ShortEffective date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. ExampleLogicalModel
Definition
Exchange requirements example.

Note: This is for demonstrable purposes only!
ShortExampleLogicalModel
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. ExampleLogicalModel.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. ExampleLogicalModel.extension
Definition

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.

ShortAdditional content defined by implementations
Comments

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
Summaryfalse
Alternate Namesextensions, 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())
SlicingThis element introduces a set of slices on ExampleLogicalModel.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. ExampleLogicalModel.name
    Definition

    Patient name

    ShortName
    Control1..*
    TypeBackboneElement
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. ExampleLogicalModel.name.id
    Definition

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

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    10. ExampleLogicalModel.name.extension
    Definition

    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.

    ShortAdditional content defined by implementations
    Comments

    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
    Summaryfalse
    Alternate Namesextensions, 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())
    SlicingThis element introduces a set of slices on ExampleLogicalModel.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 12. ExampleLogicalModel.name.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      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())
      14. ExampleLogicalModel.name.firstName
      Definition

      Patient first name

      ShortFirst name
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. ExampleLogicalModel.name.middleName
      Definition

      Patient middle name

      ShortMiddle name
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      18. ExampleLogicalModel.maritalStatus
      Definition

      Patient marital status

      ShortMarital status
      Control0..1
      TypeBackboneElement
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. ExampleLogicalModel.maritalStatus.id
      Definition

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

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      22. ExampleLogicalModel.maritalStatus.extension
      Definition

      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.

      ShortAdditional content defined by implementations
      Comments

      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
      Summaryfalse
      Alternate Namesextensions, 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())
      SlicingThis element introduces a set of slices on ExampleLogicalModel.maritalStatus.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 24. ExampleLogicalModel.maritalStatus.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        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())
        26. ExampleLogicalModel.maritalStatus.status
        Definition

        A marital status

        ShortStatus
        Control1..1
        BindingUnless not suitable, these codes SHALL be taken from Marital Status Codes
        (extensible to http://hl7.org/fhir/ValueSet/marital-status)
        TypeCodeableConcept
        28. ExampleLogicalModel.maritalStatus.effectiveDate
        Definition

        Date when status came into effect

        ShortEffective date
        Control1..1
        Typedate
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        30. ExampleLogicalModel.personRelation
        Definition

        Person who is related to the patient

        ShortPerson related to patient
        Control0..*
        TypeBackboneElement
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. ExampleLogicalModel.personRelation.id
        Definition

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

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        34. ExampleLogicalModel.personRelation.extension
        Definition

        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.

        ShortAdditional content defined by implementations
        Comments

        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
        Summaryfalse
        Alternate Namesextensions, 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())
        SlicingThis element introduces a set of slices on ExampleLogicalModel.personRelation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 36. ExampleLogicalModel.personRelation.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored even if unrecognized
          Comments

          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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content, modifiers
          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())
          38. ExampleLogicalModel.personRelation.name
          Definition

          Patient name

          ShortName
          Control1..*
          TypeBackboneElement
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          40. ExampleLogicalModel.personRelation.name.id
          Definition

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

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          42. ExampleLogicalModel.personRelation.name.extension
          Definition

          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.

          ShortAdditional content defined by implementations
          Comments

          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
          Summaryfalse
          Alternate Namesextensions, 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())
          SlicingThis element introduces a set of slices on ExampleLogicalModel.personRelation.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 44. ExampleLogicalModel.personRelation.name.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content, modifiers
            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())
            46. ExampleLogicalModel.personRelation.name.firstName
            Definition

            Person first name

            ShortFirst name
            Control1..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            48. ExampleLogicalModel.personRelation.name.middleName
            Definition

            Person middle name

            ShortMiddle name
            Control1..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            50. ExampleLogicalModel.personRelation.relationshipType
            Definition

            How is the person related to the patient

            ShortRelationship type
            Control1..1
            BindingThe codes SHOULD be taken from v3 Code System RoleCode
            (preferred to http://terminology.hl7.org/ValueSet/v3-RoleCode)
            TypeCoding
            52. ExampleLogicalModel.personRelation.maritalStatus
            Definition

            Related person marital status

            ShortMarital status
            Control0..1
            TypeBackboneElement
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            54. ExampleLogicalModel.personRelation.maritalStatus.id
            Definition

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

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            56. ExampleLogicalModel.personRelation.maritalStatus.extension
            Definition

            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.

            ShortAdditional content defined by implementations
            Comments

            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
            Summaryfalse
            Alternate Namesextensions, 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())
            SlicingThis element introduces a set of slices on ExampleLogicalModel.personRelation.maritalStatus.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 58. ExampleLogicalModel.personRelation.maritalStatus.modifierExtension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

              ShortExtensions that cannot be ignored even if unrecognized
              Comments

              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 Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              Requirements

              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

              Alternate Namesextensions, user content, modifiers
              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())
              60. ExampleLogicalModel.personRelation.maritalStatus.status
              Definition

              A marital status

              ShortStatus
              Control1..1
              BindingUnless not suitable, these codes SHALL be taken from Marital Status Codes
              (extensible to http://hl7.org/fhir/ValueSet/marital-status)
              TypeCodeableConcept
              62. ExampleLogicalModel.personRelation.maritalStatus.effectiveDate
              Definition

              Date when status came into effect

              ShortEffective date
              Control1..1
              Typedate
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension