HL7® Austria FHIR® Core Implementation Guide
1.1.0 - STU2

HL7® Austria FHIR® Core Implementation Guide - Local Development build (v1.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HL7ATCorePatient - Detailed Descriptions

Active as of 2024-04-27

Definitions for the at-core-patient resource profile.

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

0. Patient
LOINC Code
2. Patient.extension
LOINC Code
SlicingThis element introduces a set of slices on Patient.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Patient.extension:citizenship
    Slice Namecitizenship
    Control0..1
    TypeExtension(Patient Citizenship) (Complex Extension)
    6. Patient.extension:citizenship.extension:code
    Slice Namecode
    8. Patient.extension:citizenship.extension:code.value[x]
    BindingUnless not suitable, these codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/elga-laendercodes
    (extensible to https://termgit.elga.gv.at/ValueSet/elga-laendercodes)
    [x] NoteSee Choice of Data Types for further information about how to use [x]
    10. Patient.extension:PatientReligion
    Slice NamePatientReligion
    Control0..1
    TypeExtension(Patient Religion) (Complex Extension)
    12. Patient.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    LOINC Code
    SlicingThis element introduces a set of slices on Patient.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • value @ type.coding.code
    • 14. Patient.identifier.type
      BindingUnless not suitable, these codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier
      (extensible to https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier)
      16. Patient.identifier:socialSecurityNumber
      Slice NamesocialSecurityNumber
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1
      18. Patient.identifier:socialSecurityNumber.type
      BindingThe codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier
      (required to https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier)
      20. Patient.identifier:socialSecurityNumber.type.coding
      22. Patient.identifier:socialSecurityNumber.type.coding.system
      Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
      24. Patient.identifier:socialSecurityNumber.type.coding.code
      Control1..?
      Fixed ValueSS
      26. Patient.identifier:socialSecurityNumber.type.coding.display
      Fixed ValueSocial Security Number
      28. Patient.identifier:socialSecurityNumber.system
      ShortOID for the Social Security Number in Austria
      Control1..?
      Fixed Valueurn:oid:1.2.40.0.10.1.4.3.1
      30. Patient.identifier:socialSecurityNumber.value
      32. Patient.identifier:socialSecurityNumber.assigner
      34. Patient.identifier:socialSecurityNumber.assigner.display
      Fixed ValueDachverband der österreichischen Sozialversicherungsträger
      36. Patient.identifier:bPK
      Slice NamebPK
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      38. Patient.identifier:bPK.type
      BindingThe codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier
      (required to https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier)
      40. Patient.identifier:bPK.type.coding
      42. Patient.identifier:bPK.type.coding.system
      Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
      44. Patient.identifier:bPK.type.coding.code
      Control1..?
      Fixed ValueNI
      46. Patient.identifier:bPK.type.coding.display
      Fixed ValueNational unique individual identifier
      48. Patient.identifier:bPK.system
      ShortOID for the bPK in Austria
      Control1..?
      Fixed Valueurn:oid:1.2.40.0.10.2.1.1.149
      50. Patient.identifier:bPK.value
      52. Patient.identifier:bPK.assigner
      54. Patient.identifier:bPK.assigner.display
      Fixed ValueBundesministerium für Inneres
      56. Patient.identifier:localPatientId
      Slice NamelocalPatientId
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1
      58. Patient.identifier:localPatientId.type
      BindingThe codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier
      (required to https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier)
      60. Patient.identifier:localPatientId.type.coding
      62. Patient.identifier:localPatientId.type.coding.system
      Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
      64. Patient.identifier:localPatientId.type.coding.code
      Control1..?
      Fixed ValuePI
      66. Patient.identifier:localPatientId.type.coding.display
      Fixed ValuePatient internal identifier
      68. Patient.identifier:localPatientId.system
      ShortNamespace that assigned the localPatientId.
      Control1..?
      70. Patient.identifier:localPatientId.value
      72. Patient.active
      LOINC Code
      74. Patient.name
      Control1..?
      LOINC Code
      76. Patient.name.family
      78. Patient.name.given
      80. Patient.name.prefix
      82. Patient.name.suffix
      84. Patient.telecom
      86. Patient.telecom.system
      88. Patient.telecom.value
      90. Patient.telecom.use
      92. Patient.gender
      Control1..?
      LOINC Code
      94. Patient.gender.extension
      SlicingThis element introduces a set of slices on Patient.gender.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 96. Patient.gender.extension:AdministrativeGenderAddition
        Slice NameAdministrativeGenderAddition
        Control0..1
        TypeExtension(Administrative Gender Addition) (Extension Type: Coding)
        98. Patient.birthDate
        LOINC Code
        100. Patient.deceased[x]
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        LOINC Code
        SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
        • type @ $this
        • 102. Patient.deceased[x]:deceasedBoolean
          Slice NamedeceasedBoolean
          Control0..1
          Typeboolean
          [x] NoteSee Choice of Data Types for further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          104. Patient.deceased[x]:deceasedDateTime
          Slice NamedeceasedDateTime
          Control0..1
          TypedateTime
          [x] NoteSee Choice of Data Types for further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          106. Patient.address
          TypeAddress(HL7® AT Core Address Profile)
          LOINC Code
          108. Patient.address.use
          110. Patient.address.text
          112. Patient.address.line
          114. Patient.address.city
          116. Patient.address.state
          118. Patient.address.postalCode
          120. Patient.address.country
          122. Patient.maritalStatus
          124. Patient.maritalStatus.coding
          126. Patient.maritalStatus.coding.system
          128. Patient.maritalStatus.coding.code
          130. Patient.maritalStatus.coding.display
          132. Patient.multipleBirth[x]
          [x] NoteSee Choice of Data Types for further information about how to use [x]
          LOINC Code
          SlicingThis element introduces a set of slices on Patient.multipleBirth[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
          • type @ $this
          • 134. Patient.multipleBirth[x]:multipleBirthBoolean
            Slice NamemultipleBirthBoolean
            Control0..1
            Typeboolean
            [x] NoteSee Choice of Data Types for further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            136. Patient.multipleBirth[x]:multipleBirthInteger
            Slice NamemultipleBirthInteger
            Control0..1
            Typeinteger
            [x] NoteSee Choice of Data Types for further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            138. Patient.photo
            LOINC Code
            140. Patient.contact
            142. Patient.contact.relationship
            144. Patient.contact.relationship.coding
            146. Patient.contact.relationship.coding.system
            148. Patient.contact.relationship.coding.code
            150. Patient.contact.relationship.coding.display
            152. Patient.contact.name
            154. Patient.contact.name.family
            156. Patient.contact.name.given
            158. Patient.contact.telecom
            160. Patient.contact.telecom.system
            162. Patient.contact.telecom.value
            164. Patient.contact.telecom.use
            166. Patient.contact.address
            TypeAddress(HL7® AT Core Address Profile)
            LOINC Code
            168. Patient.contact.address.use
            170. Patient.contact.address.text
            172. Patient.contact.address.line
            174. Patient.contact.address.city
            176. Patient.contact.address.state
            178. Patient.contact.address.postalCode
            180. Patient.contact.address.country
            182. Patient.contact.gender
            LOINC Code
            184. Patient.contact.gender.extension
            SlicingThis element introduces a set of slices on Patient.contact.gender.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 186. Patient.contact.gender.extension:AdministrativeGenderAddition
              Slice NameAdministrativeGenderAddition
              Control0..1
              TypeExtension(Administrative Gender Addition) (Extension Type: Coding)
              188. Patient.contact.organization
              LOINC Code
              190. Patient.contact.period
              LOINC Code
              192. Patient.communication
              194. Patient.communication.language
              LOINC Code
              196. Patient.communication.preferred
              LOINC Code
              198. Patient.generalPractitioner
              LOINC Code
              200. Patient.managingOrganization
              LOINC Code
              202. Patient.link
              204. Patient.link.other
              LOINC Code
              206. Patient.link.type
              LOINC Code

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

              0. Patient
              Definition

              Demographics and other administrative information about an individual or animal receiving care or other health-related services.

              ShortInformation about an individual or animal receiving health care services
              Control0..*
              Is Modifierfalse
              Must Supportfalse
              Summaryfalse
              Alternate NamesSubjectOfCare Client Resident
              Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
              dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
              dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
              dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
              dom-6: A resource should have narrative for robust management (text.`div`.exists())
              2. Patient.implicitRules
              Definition

              A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

              ShortA set of rules under which this content was created
              Comments

              Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

              Control0..1
              Typeuri
              Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              4. Patient.contained
              Definition

              These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

              ShortContained, inline Resources
              Comments

              This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

              Control0..*
              This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
              TypeResource
              Is Modifierfalse
              Must Supportfalse
              Summaryfalse
              Alternate Namesinline resources, anonymous resources, contained resources
              6. Patient.extension
              Definition

              An Extension


              May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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.

              ShortExtensionAdditional 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
              Must Supportfalse
              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 Patient.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 8. Patient.extension:citizenship
                Slice Namecitizenship
                Definition

                The patient's legal status as citizen of a country.

                ShortNation(s) where the patient claims citizenship
                Control0..1
                TypeExtension(Patient Citizenship) (Complex Extension)
                Is Modifierfalse
                Must Supportfalse
                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())
                LOINC Code
                10. Patient.extension:citizenship.extension:code
                Slice Namecode
                Definition

                An Extension

                ShortExtensionAdditional content defined by implementations
                Control0..1*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                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())
                12. Patient.extension:citizenship.extension:code.extension
                Definition

                An Extension


                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 managable, 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.

                ShortExtensionAdditional 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..0*
                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 Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 14. Patient.extension:citizenship.extension:code.url
                  Definition

                  Source of the definition for the extension code - a logical name or a URL.

                  Shortidentifies the meaning of the extension
                  Comments

                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed Valuecode
                  16. Patient.extension:citizenship.extension:code.value[x]
                  Definition

                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                  ShortValue of extension
                  Control10..1
                  This element is affected by the following invariants: ext-1
                  BindingUnless not suitable, these codes SHALL be taken from For codes, see https://termgit.elga.gv.at/ValueSet/elga-laendercodes
                  (extensible to https://termgit.elga.gv.at/ValueSet/elga-laendercodes)
                  TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
                  [x] NoteSee Choice of Data Types for further information about how to use [x]
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  18. Patient.extension:citizenship.extension:period
                  Slice Nameperiod
                  Definition

                  Period when citizenship was effective.

                  ShortTime period of citizenshipAdditional content defined by implementations
                  Control0..1*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  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())
                  20. Patient.extension:citizenship.extension:period.extension
                  Definition

                  An Extension


                  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 managable, 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.

                  ShortExtensionAdditional 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..0*
                  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 Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 22. Patient.extension:citizenship.extension:period.url
                    Definition

                    Source of the definition for the extension code - a logical name or a URL.

                    Shortidentifies the meaning of the extension
                    Comments

                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    Fixed Valueperiod
                    24. Patient.extension:citizenship.extension:period.value[x]
                    Definition

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                    ShortValue of extension
                    Control10..1
                    This element is affected by the following invariants: ext-1
                    TypePeriod, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
                    [x] NoteSee Choice of Data Types for further information about how to use [x]
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    26. Patient.extension:citizenship.url
                    Definition

                    Source of the definition for the extension code - a logical name or a URL.

                    Shortidentifies the meaning of the extension
                    Comments

                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-citizenship
                    28. Patient.extension:citizenship.value[x]
                    Definition

                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                    ShortValue of extension
                    Control0..01
                    This element is affected by the following invariants: ext-1
                    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    30. Patient.extension:PatientReligion
                    Slice NamePatientReligion
                    Definition

                    HL7® Austria FHIR® Core Extension for the religion (registered in Austria) of a patient. The extension is used to encode the religious confession of a patient (only confessions registered in Austria). Furthermore, it uses the official [HL7 AT CodeSystem](https://termpub.gesundheit.gv.at:443/TermBrowser/gui/main/main.zul?loadType=CodeSystem&loadName=HL7 AT ReligionAustria) for religion and is therefore aligned with the ELGA ValueSet, respectively.

                    ShortPatient Religion
                    Control0..1
                    TypeExtension(Patient Religion) (Complex Extension)
                    Is Modifierfalse
                    Must Supportfalse
                    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())
                    LOINC Code
                    32. Patient.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to 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
                    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 resource that contains them
                    Must Supportfalse
                    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
                    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())
                    34. Patient.identifier
                    Definition

                    An identifier for this patient.

                    ShortAn identifier for this patient
                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..*
                    TypeIdentifier
                    Is Modifierfalse
                    Must Supportfalse
                    Summarytrue
                    Requirements

                    Patients are almost always assigned specific numerical identifiers.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    SlicingThis element introduces a set of slices on Patient.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
                    • value @ type.coding.code
                    • 36. Patient.identifier.use
                      Definition

                      The purpose of this identifier.

                      Shortusual | official | temp | secondary | old (If known)
                      Comments

                      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                      Control0..1
                      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
                      (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

                      Identifies the purpose for this identifier, if known .

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      38. Patient.identifier.type
                      Definition

                      A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                      ShortDescription of identifier
                      Comments

                      This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                      Control0..1
                      BindingUnless not suitable, these codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifierhttp://hl7.org/fhir/ValueSet/identifier-type
                      (extensible to https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      Allows users to make use of identifiers when the identifier system is not known.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      40. Patient.identifier:socialSecurityNumber
                      Slice NamesocialSecurityNumber
                      Definition

                      An identifier for this patient.

                      ShortAn identifier for this patient
                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control0..1*
                      TypeIdentifier
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Requirements

                      Patients are almost always assigned specific numerical identifiers.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      42. Patient.identifier:socialSecurityNumber.use
                      Definition

                      The purpose of this identifier.

                      Shortusual | official | temp | secondary | old (If known)
                      Comments

                      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                      Control0..1
                      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
                      (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

                      Identifies the purpose for this identifier, if known .

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      44. Patient.identifier:socialSecurityNumber.type
                      Definition

                      A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                      ShortDescription of identifier
                      Comments

                      This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                      Control0..1
                      BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifierhttp://hl7.org/fhir/ValueSet/identifier-type
                      (required to https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      Allows users to make use of identifiers when the identifier system is not known.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      46. Patient.identifier:socialSecurityNumber.system
                      Definition

                      Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

                      ShortOID for the Social Security Number in AustriaThe namespace for the identifier value
                      Comments

                      Identifier.system is always case sensitive.

                      Control10..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                      Fixed Valueurn:oid:1.2.40.0.10.1.4.3.1
                      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      48. Patient.identifier:socialSecurityNumber.value
                      Definition

                      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                      ShortThe value that is unique
                      Comments

                      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                      Control0..1
                      This element is affected by the following invariants: ident-1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Example<br/><b>General</b>:123456
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      50. Patient.identifier:bPK
                      Slice NamebPK
                      Definition

                      An identifier for this patient.

                      ShortAn identifier for this patient
                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control0..*
                      TypeIdentifier
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Requirements

                      Patients are almost always assigned specific numerical identifiers.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      52. Patient.identifier:bPK.use
                      Definition

                      The purpose of this identifier.

                      Shortusual | official | temp | secondary | old (If known)
                      Comments

                      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                      Control0..1
                      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
                      (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

                      Identifies the purpose for this identifier, if known .

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      54. Patient.identifier:bPK.type
                      Definition

                      A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                      ShortDescription of identifier
                      Comments

                      This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                      Control0..1
                      BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifierhttp://hl7.org/fhir/ValueSet/identifier-type
                      (required to https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      Allows users to make use of identifiers when the identifier system is not known.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      56. Patient.identifier:bPK.system
                      Definition

                      Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

                      ShortOID for the bPK in AustriaThe namespace for the identifier value
                      Comments

                      Identifier.system is always case sensitive.

                      Control10..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                      Fixed Valueurn:oid:1.2.40.0.10.2.1.1.149
                      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      58. Patient.identifier:bPK.value
                      Definition

                      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                      ShortThe value that is unique
                      Comments

                      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                      Control0..1
                      This element is affected by the following invariants: ident-1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Example<br/><b>General</b>:123456
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      60. Patient.identifier:localPatientId
                      Slice NamelocalPatientId
                      Definition

                      An identifier for this patient.

                      ShortAn identifier for this patient
                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control0..1*
                      TypeIdentifier
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Requirements

                      Patients are almost always assigned specific numerical identifiers.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      62. Patient.identifier:localPatientId.use
                      Definition

                      The purpose of this identifier.

                      Shortusual | official | temp | secondary | old (If known)
                      Comments

                      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                      Control0..1
                      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
                      (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

                      Identifies the purpose for this identifier, if known .

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      64. Patient.identifier:localPatientId.type
                      Definition

                      A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                      ShortDescription of identifier
                      Comments

                      This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                      Control0..1
                      BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifierhttp://hl7.org/fhir/ValueSet/identifier-type
                      (required to https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      Allows users to make use of identifiers when the identifier system is not known.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      66. Patient.identifier:localPatientId.system
                      Definition

                      Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

                      ShortNamespace that assigned the localPatientId.The namespace for the identifier value
                      Comments

                      Identifier.system is always case sensitive.

                      Control10..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      68. Patient.identifier:localPatientId.value
                      Definition

                      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                      ShortThe value that is unique
                      Comments

                      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                      Control0..1
                      This element is affected by the following invariants: ident-1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Example<br/><b>General</b>:123456
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      70. Patient.active
                      Definition

                      Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

                      It is often used to filter patient lists to exclude inactive patients

                      Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

                      ShortWhether this patient's record is in active use
                      Comments

                      If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

                      Control0..1
                      Typeboolean
                      Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summarytrue
                      Requirements

                      Need to be able to mark a patient record as not to be used because it was created in error.

                      Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      72. Patient.name
                      Definition

                      A name associated with the individual.

                      ShortA name associated with the patient
                      Comments

                      A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name.

                      Control10..*
                      TypeHumanName
                      Is Modifierfalse
                      Must Supportfalse
                      Summarytrue
                      Requirements

                      Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      74. Patient.name.use
                      Definition

                      Identifies the purpose for this name.

                      Shortusual | official | temp | nickname | anonymous | old | maiden
                      Comments

                      Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                      Control0..1
                      BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0
                      (required to http://hl7.org/fhir/ValueSet/name-use|5.0.0)

                      The use of a human name.

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Allows the appropriate name for a particular context of use to be selected from among a set of names.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      76. Patient.name.family
                      Definition

                      The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                      ShortFamily name (often called 'Surname')
                      Comments

                      Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Alternate Namessurname
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      78. Patient.name.given
                      Definition

                      Given name.

                      ShortGiven names (not always 'first'). Includes middle names
                      Comments

                      If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                      Control0..*
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Alternate Namesfirst name, middle name
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      80. Patient.name.prefix
                      Definition

                      Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                      ShortParts that come before the name
                      Control0..*
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      82. Patient.name.suffix
                      Definition

                      Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                      ShortParts that come after the name
                      Control0..*
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      84. Patient.gender
                      Definition

                      Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

                      Shortmale | female | other | unknown
                      Comments

                      The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

                      Control10..1
                      BindingThe codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
                      (required to http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0)

                      The gender of a person used for administrative purposes.

                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summarytrue
                      Requirements

                      Needed for identification of the individual, in combination with (at least) name and birth date.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      86. Patient.gender.extension
                      Definition

                      An Extension


                      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 managable, 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.

                      ShortExtensionAdditional 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 Patient.gender.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 88. Patient.gender.extension:AdministrativeGenderAddition
                        Slice NameAdministrativeGenderAddition
                        Definition

                        HL7® Austria FHIR® Core Extension for the administrative gender of a person (Patient, Practitioner, ...). The extension is used to add the missing codes and is applied in case the code for administrative gender itself is set to 'other'.

                        ShortAdministrative Gender Addition
                        Control0..1
                        TypeExtension(Administrative Gender Addition) (Extension Type: Coding)
                        Is Modifierfalse
                        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())
                        LOINC Code
                        90. Patient.birthDate
                        Definition

                        The date of birth for the individual.

                        ShortThe date of birth for the individual
                        Comments

                        Partial dates are allowed if the specific date of birth is unknown. There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

                        Control0..1
                        Typedate
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Requirements

                        Age of the individual drives many clinical processes.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        LOINC Code21112-8
                        92. Patient.deceased[x]
                        Definition

                        Indicates if the individual is deceased or not.

                        ShortIndicates if the individual is deceased or not
                        Comments

                        If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                        Control0..1
                        TypeChoice of: boolean, dateTime
                        [x] NoteSee Choice of Data Types for further information about how to use [x]
                        Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Requirements

                        The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
                        • type @ $this
                        • 94. Patient.deceased[x]:deceasedBoolean
                          Slice NamedeceasedBoolean
                          Definition

                          Indicates if the individual is deceased or not.

                          ShortIndicates if the individual is deceased or not
                          Comments

                          If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                          Control0..1
                          Typeboolean, dateTime
                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                          Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supportfalse
                          Summarytrue
                          Requirements

                          The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          96. Patient.deceased[x]:deceasedDateTime
                          Slice NamedeceasedDateTime
                          Definition

                          Indicates if the individual is deceased or not.

                          ShortIndicates if the individual is deceased or not
                          Comments

                          If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                          Control0..1
                          TypedateTime, boolean
                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                          Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supportfalse
                          Summarytrue
                          Requirements

                          The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          98. Patient.address
                          Definition

                          An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.


                          An address for the individual.

                          ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)An address for the individual
                          Comments

                          Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).


                          Patient may have multiple addresses with different uses or applicable periods.

                          Control0..*
                          TypeAddress(HL7® AT Core Address Profile)
                          Is Modifierfalse
                          Must Supportfalse
                          Requirements

                          May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          at-addr-1: If the extension for street name is used then the value for line must not be empty (line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue()))
                          at-addr-2: If the extension for street number is used then the value for line must not be empty (line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue()))
                          at-addr-3: If the extension for floor/door number is used then the value for line must not be empty (line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue()))
                          100. Patient.address.use
                          Definition

                          The purpose of this address.

                          Shorthome | work | temp | old | billing - purpose of this address
                          Comments

                          Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                          Control0..1
                          BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|5.0.0
                          (required to http://hl7.org/fhir/ValueSet/address-use|5.0.0)

                          The use of an address (home / work / etc.).

                          Typecode
                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Allows an appropriate address to be chosen from a list of many.

                          Example<br/><b>General</b>:home
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          102. Patient.address.text
                          Definition

                          Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

                          ShortText representation of the address
                          Comments

                          Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          A renderable, unencoded form.

                          Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          104. Patient.address.line
                          Definition

                          This component contains the street name, street number, floor and/or door number or additonal information (e.g. street direction, P.O. Box number, delivery hints, and similar address information). This information can be split into structured values in the line-components each defined by international ISO extensions. If these extensions are used then the information they contain has to be written in a concatenated way in the line element itself as well. This makes the usage easier for systems which don't use address data in a structured way.


                          This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                          ShortStreet name, number, direction & P.O. Box etc.
                          Control0..*
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Example<br/><b>General</b>:137 Nowhere Street
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          106. Patient.address.line.extension:street
                          Slice Namestreet
                          Definition

                          Name of the street without the street number

                          ShortName of the street
                          Control0..1
                          TypeExtension(ADXP Street Name) (Extension Type: string)
                          Is Modifierfalse
                          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())
                          LOINC Code
                          108. Patient.address.line.extension:streetNumber
                          Slice NamestreetNumber
                          Definition

                          Number of the street without the street name

                          ShortNumber of the street
                          Control0..1
                          TypeExtension(ADXP House Number) (Extension Type: string)
                          Is Modifierfalse
                          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())
                          LOINC Code
                          110. Patient.address.line.extension:floorDoorNumber
                          Slice NamefloorDoorNumber
                          Definition

                          Floor and/or door number

                          ShortFloor and/or door number
                          Control0..1
                          TypeExtension(ADXP Additional Locator) (Extension Type: string)
                          Is Modifierfalse
                          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())
                          LOINC Code
                          112. Patient.address.line.extension:additionalInformation
                          Slice NameadditionalInformation
                          Definition

                          Additional information about the street address

                          ShortAdditional Information
                          Control0..1
                          TypeExtension(Address Additional Information) (Extension Type: string)
                          Is Modifierfalse
                          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())
                          LOINC Code
                          114. Patient.address.city
                          Definition

                          The name of the city, town, suburb, village or other community or delivery center.

                          ShortName of city, town etc.
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Alternate NamesMunicpality
                          Example<br/><b>General</b>:Erewhon
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          116. Patient.address.district
                          Definition

                          The name of the administrative area (county).

                          ShortDistrict name (aka county)
                          Comments

                          District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                          Control0..01
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Alternate NamesCounty
                          Example<br/><b>General</b>:Madison
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          118. Patient.address.state
                          Definition

                          Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

                          ShortSub-unit of country (abbreviations ok)
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Alternate NamesProvince, Territory
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          120. Patient.address.postalCode
                          Definition

                          A postal code designating a region defined by the postal service.

                          ShortPostal code for area
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Alternate NamesZip
                          Example<br/><b>General</b>:9132
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          122. Patient.address.country
                          Definition

                          Country - a nation as commonly understood or generally accepted.

                          ShortCountry (e.g. may be ISO 3166 2 or 3 letter code)
                          Comments

                          ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          124. Patient.address.period
                          Definition

                          Time period when address was/is in use.

                          ShortTime period when address was/is in use
                          Control0..01
                          TypePeriod
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          Allows addresses to be placed in historical context.

                          Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          126. Patient.multipleBirth[x]
                          Definition

                          Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                          ShortWhether patient is part of a multiple birth
                          Comments

                          Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                          Control0..1
                          TypeChoice of: boolean, integer
                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supportfalse
                          Summaryfalse
                          Requirements

                          For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          SlicingThis element introduces a set of slices on Patient.multipleBirth[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
                          • type @ $this
                          • 128. Patient.multipleBirth[x]:multipleBirthBoolean
                            Slice NamemultipleBirthBoolean
                            Definition

                            Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                            ShortWhether patient is part of a multiple birth
                            Comments

                            Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                            Control0..1
                            Typeboolean, integer
                            [x] NoteSee Choice of Data Types for further information about how to use [x]
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Requirements

                            For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            130. Patient.multipleBirth[x]:multipleBirthInteger
                            Slice NamemultipleBirthInteger
                            Definition

                            Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                            ShortWhether patient is part of a multiple birth
                            Comments

                            Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                            Control0..1
                            Typeinteger, boolean
                            [x] NoteSee Choice of Data Types for further information about how to use [x]
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Requirements

                            For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            132. Patient.photo
                            Definition

                            Image of the patient.

                            ShortImage of the patient
                            Comments

                            Guidelines:

                            • Use id photos, not clinical photos.
                            • Limit dimensions to thumbnail.
                            • Keep byte count low to ease resource updates.
                            Control0..*
                            TypeAttachment
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Requirements

                            Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            134. Patient.generalPractitioner
                            Definition

                            Patient's nominated care provider.

                            ShortPatient's nominated primary care provider
                            Comments

                            This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

                            Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

                            Control0..*
                            TypeReference(Organization, Practitioner, PractitionerRole)
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Alternate NamescareProvider
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            136. Patient.managingOrganization
                            Definition

                            Organization that is the custodian of the patient record.

                            ShortOrganization that is the custodian of the patient record
                            Comments

                            There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                            Control0..1
                            TypeReference(Organization)
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            Requirements

                            Need to know who recognizes this patient record, manages and updates it.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            138. Patient.link
                            Definition

                            Link to a Patient or RelatedPerson resource that concerns the same actual individual.

                            ShortLink to a Patient or RelatedPerson resource that concerns the same actual individual
                            Comments

                            There is no assumption that linked patient records have mutual links.

                            Control0..*
                            TypeBackboneElement
                            Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                            Must Supportfalse
                            Summarytrue
                            Requirements

                            There are multiple use cases:

                            • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                            • Distribution of patient information across multiple servers.
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            140. Patient.link.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 managable, 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())
                            142. Patient.link.other
                            Definition

                            Link to a Patient or RelatedPerson resource that concerns the same actual individual.

                            ShortThe other patient or related person resource that the link refers to
                            Comments

                            Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

                            Control1..1
                            TypeReference(Patient, RelatedPerson)
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            144. Patient.link.type
                            Definition

                            The type of link between this patient resource and another patient resource.

                            Shortreplaced-by | replaces | refer | seealso
                            Control1..1
                            BindingThe codes SHALL be taken from LinkTypehttp://hl7.org/fhir/ValueSet/link-type|5.0.0
                            (required to http://hl7.org/fhir/ValueSet/link-type|5.0.0)

                            The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

                            0. Patient
                            Definition

                            Demographics and other administrative information about an individual or animal receiving care or other health-related services.

                            ShortInformation about an individual or animal receiving health care services
                            Control0..*
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Alternate NamesSubjectOfCare Client Resident
                            Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                            dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                            dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                            dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                            dom-6: A resource should have narrative for robust management (text.`div`.exists())
                            2. Patient.id
                            Definition

                            The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                            ShortLogical id of this artifact
                            Comments

                            Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

                            Control0..1
                            Typeid
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            4. Patient.meta
                            Definition

                            The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                            ShortMetadata about the resource
                            Control0..1
                            TypeMeta
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            6. Patient.implicitRules
                            Definition

                            A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                            ShortA set of rules under which this content was created
                            Comments

                            Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

                            Control0..1
                            Typeuri
                            Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            8. Patient.language
                            Definition

                            The base language in which the resource is written.

                            ShortLanguage of the resource content
                            Comments

                            Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                            Control0..1
                            BindingThe codes SHALL be taken from AllLanguages
                            (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

                            IETF language tag for a human language

                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            10. Patient.text
                            Definition

                            A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                            ShortText summary of the resource, for human interpretation
                            Comments

                            Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                            Control0..1
                            This element is affected by the following invariants: dom-6
                            TypeNarrative
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Alternate Namesnarrative, html, xhtml, display
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            12. Patient.contained
                            Definition

                            These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

                            ShortContained, inline Resources
                            Comments

                            This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

                            Control0..*
                            This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
                            TypeResource
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Alternate Namesinline resources, anonymous resources, contained resources
                            14. Patient.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            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 Patient.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 16. Patient.extension:citizenship
                              Slice Namecitizenship
                              Definition

                              The patient's legal status as citizen of a country.

                              ShortNation(s) where the patient claims citizenship
                              Control0..1
                              TypeExtension(Patient Citizenship) (Complex Extension)
                              Is Modifierfalse
                              Must Supportfalse
                              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())
                              18. Patient.extension:citizenship.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
                              This element is affected by the following invariants: ele-1
                              Typeid
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              20. Patient.extension:citizenship.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 managable, 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 Patient.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 22. Patient.extension:citizenship.extension:code
                                Slice Namecode
                                Definition

                                An Extension

                                ShortExtension
                                Control0..1
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                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())
                                24. Patient.extension:citizenship.extension:code.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
                                This element is affected by the following invariants: ele-1
                                Typeid
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                26. Patient.extension:citizenship.extension:code.extension
                                Definition

                                An Extension

                                ShortExtension
                                Control0..0
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                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 Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 28. Patient.extension:citizenship.extension:code.url
                                  Definition

                                  Source of the definition for the extension code - a logical name or a URL.

                                  Shortidentifies the meaning of the extension
                                  Comments

                                  The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                  Control1..1
                                  Typeuri
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  Fixed Valuecode
                                  30. Patient.extension:citizenship.extension:code.value[x]
                                  Definition

                                  Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                  ShortValue of extension
                                  Control1..1
                                  This element is affected by the following invariants: ext-1
                                  BindingUnless not suitable, these codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/elga-laendercodes
                                  (extensible to https://termgit.elga.gv.at/ValueSet/elga-laendercodes)
                                  TypeCodeableConcept
                                  [x] NoteSee Choice of Data Types for further information about how to use [x]
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  32. Patient.extension:citizenship.extension:period
                                  Slice Nameperiod
                                  Definition

                                  Period when citizenship was effective.

                                  ShortTime period of citizenship
                                  Control0..1
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  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())
                                  34. Patient.extension:citizenship.extension:period.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
                                  This element is affected by the following invariants: ele-1
                                  Typeid
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  36. Patient.extension:citizenship.extension:period.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..0
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  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 Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 38. Patient.extension:citizenship.extension:period.url
                                    Definition

                                    Source of the definition for the extension code - a logical name or a URL.

                                    Shortidentifies the meaning of the extension
                                    Comments

                                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                    Control1..1
                                    Typeuri
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    Fixed Valueperiod
                                    40. Patient.extension:citizenship.extension:period.value[x]
                                    Definition

                                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                    ShortValue of extension
                                    Control1..1
                                    This element is affected by the following invariants: ext-1
                                    TypePeriod
                                    [x] NoteSee Choice of Data Types for further information about how to use [x]
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    42. Patient.extension:citizenship.url
                                    Definition

                                    Source of the definition for the extension code - a logical name or a URL.

                                    Shortidentifies the meaning of the extension
                                    Comments

                                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                    Control1..1
                                    Typeuri
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-citizenship
                                    44. Patient.extension:citizenship.value[x]
                                    Definition

                                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                    ShortValue of extension
                                    Control0..0
                                    This element is affected by the following invariants: ext-1
                                    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    46. Patient.extension:PatientReligion
                                    Slice NamePatientReligion
                                    Definition

                                    HL7® Austria FHIR® Core Extension for the religion (registered in Austria) of a patient. The extension is used to encode the religious confession of a patient (only confessions registered in Austria). Furthermore, it uses the official [HL7 AT CodeSystem](https://termpub.gesundheit.gv.at:443/TermBrowser/gui/main/main.zul?loadType=CodeSystem&loadName=HL7 AT ReligionAustria) for religion and is therefore aligned with the ELGA ValueSet, respectively.

                                    ShortPatient Religion
                                    Control0..1
                                    TypeExtension(Patient Religion) (Complex Extension)
                                    Is Modifierfalse
                                    Must Supportfalse
                                    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())
                                    48. Patient.modifierExtension
                                    Definition

                                    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to 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
                                    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 resource that contains them
                                    Must Supportfalse
                                    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
                                    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())
                                    50. Patient.identifier
                                    Definition

                                    An identifier for this patient.

                                    ShortAn identifier for this patient
                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                    Control0..*
                                    TypeIdentifier
                                    Is Modifierfalse
                                    Must Supportfalse
                                    Summarytrue
                                    Requirements

                                    Patients are almost always assigned specific numerical identifiers.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    SlicingThis element introduces a set of slices on Patient.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                    • value @ type.coding.code
                                    • 52. Patient.identifier.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
                                      This element is affected by the following invariants: ele-1
                                      Typeid
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      54. Patient.identifier.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 managable, 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 Patient.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 56. Patient.identifier.use
                                        Definition

                                        The purpose of this identifier.

                                        Shortusual | official | temp | secondary | old (If known)
                                        Comments

                                        Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                        Control0..1
                                        BindingThe codes SHALL be taken from IdentifierUse
                                        (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

                                        Identifies the purpose for this identifier, if known .

                                        Typecode
                                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        58. Patient.identifier.type
                                        Definition

                                        A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                        ShortDescription of identifier
                                        Comments

                                        This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                        Control0..1
                                        BindingUnless not suitable, these codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier
                                        (extensible to https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier)
                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        Allows users to make use of identifiers when the identifier system is not known.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        60. Patient.identifier.system
                                        Definition

                                        Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

                                        ShortThe namespace for the identifier value
                                        Comments

                                        Identifier.system is always case sensitive.

                                        Control0..1
                                        Typeuri
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                        Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        62. Patient.identifier.value
                                        Definition

                                        The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                        ShortThe value that is unique
                                        Comments

                                        If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                        Control0..1
                                        This element is affected by the following invariants: ident-1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Example<br/><b>General</b>:123456
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        64. Patient.identifier.period
                                        Definition

                                        Time period during which identifier is/was valid for use.

                                        ShortTime period when id is/was valid for use
                                        Control0..1
                                        TypePeriod
                                        Is Modifierfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        66. Patient.identifier.assigner
                                        Definition

                                        Organization that issued/manages the identifier.

                                        ShortOrganization that issued id (may be just text)
                                        Comments

                                        The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                        Control0..1
                                        TypeReference(Organization)
                                        Is Modifierfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        68. Patient.identifier:socialSecurityNumber
                                        Slice NamesocialSecurityNumber
                                        Definition

                                        An identifier for this patient.

                                        ShortAn identifier for this patient
                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                        Control0..1
                                        TypeIdentifier
                                        Is Modifierfalse
                                        Must Supportfalse
                                        Summarytrue
                                        Requirements

                                        Patients are almost always assigned specific numerical identifiers.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        70. Patient.identifier:socialSecurityNumber.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
                                        This element is affected by the following invariants: ele-1
                                        Typeid
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        72. Patient.identifier:socialSecurityNumber.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 managable, 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 Patient.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 74. Patient.identifier:socialSecurityNumber.use
                                          Definition

                                          The purpose of this identifier.

                                          Shortusual | official | temp | secondary | old (If known)
                                          Comments

                                          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                          Control0..1
                                          BindingThe codes SHALL be taken from IdentifierUse
                                          (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

                                          Identifies the purpose for this identifier, if known .

                                          Typecode
                                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          76. Patient.identifier:socialSecurityNumber.type
                                          Definition

                                          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                          ShortDescription of identifier
                                          Comments

                                          This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                          Control0..1
                                          BindingThe codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier
                                          (required to https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier)
                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Summarytrue
                                          Requirements

                                          Allows users to make use of identifiers when the identifier system is not known.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          78. Patient.identifier:socialSecurityNumber.type.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
                                          This element is affected by the following invariants: ele-1
                                          Typeid
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          80. Patient.identifier:socialSecurityNumber.type.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 managable, 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 Patient.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 82. Patient.identifier:socialSecurityNumber.type.coding
                                            Definition

                                            A reference to a code defined by a terminology system.

                                            ShortCode defined by a terminology system
                                            Comments

                                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                            Control0..*
                                            TypeCoding
                                            Is Modifierfalse
                                            Summarytrue
                                            Requirements

                                            Allows for alternative encodings within a code system, and translations to other code systems.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            84. Patient.identifier:socialSecurityNumber.type.coding.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
                                            This element is affected by the following invariants: ele-1
                                            Typeid
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            86. Patient.identifier:socialSecurityNumber.type.coding.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 managable, 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 Patient.identifier.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 88. Patient.identifier:socialSecurityNumber.type.coding.system
                                              Definition

                                              The identification of the code system that defines the meaning of the symbol in the code.

                                              ShortIdentity of the terminology system
                                              Comments

                                              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

                                              Control0..1
                                              Typeuri
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Requirements

                                              Need to be unambiguous about the source of the definition of the symbol.

                                              Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              90. Patient.identifier:socialSecurityNumber.type.coding.version
                                              Definition

                                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                              ShortVersion of the system - if relevant
                                              Comments

                                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                              NoteThis is a business versionId, not a resource version id (see discussion)
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              92. Patient.identifier:socialSecurityNumber.type.coding.code
                                              Definition

                                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                              ShortSymbol in syntax defined by the system
                                              Control1..1
                                              This element is affected by the following invariants: cod-1
                                              Typecode
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Requirements

                                              Need to refer to a particular code in the system.

                                              Fixed ValueSS
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              94. Patient.identifier:socialSecurityNumber.type.coding.display
                                              Definition

                                              A representation of the meaning of the code in the system, following the rules of the system.

                                              ShortRepresentation defined by the system
                                              Control0..1
                                              This element is affected by the following invariants: cod-1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Requirements

                                              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                              Fixed ValueSocial Security Number
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              96. Patient.identifier:socialSecurityNumber.type.coding.userSelected
                                              Definition

                                              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                              ShortIf this coding was chosen directly by the user
                                              Comments

                                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                              Control0..1
                                              Typeboolean
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Requirements

                                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              98. Patient.identifier:socialSecurityNumber.type.text
                                              Definition

                                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                              ShortPlain text representation of the concept
                                              Comments

                                              Very often the text is the same as a displayName of one of the codings.

                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Requirements

                                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              100. Patient.identifier:socialSecurityNumber.system
                                              Definition

                                              Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

                                              ShortOID for the Social Security Number in Austria
                                              Comments

                                              Identifier.system is always case sensitive.

                                              Control1..1
                                              Typeuri
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Requirements

                                              There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                              Fixed Valueurn:oid:1.2.40.0.10.1.4.3.1
                                              Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              102. Patient.identifier:socialSecurityNumber.value
                                              Definition

                                              The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                              ShortThe value that is unique
                                              Comments

                                              If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                              Control0..1
                                              This element is affected by the following invariants: ident-1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Example<br/><b>General</b>:123456
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              104. Patient.identifier:socialSecurityNumber.period
                                              Definition

                                              Time period during which identifier is/was valid for use.

                                              ShortTime period when id is/was valid for use
                                              Control0..1
                                              TypePeriod
                                              Is Modifierfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              106. Patient.identifier:socialSecurityNumber.assigner
                                              Definition

                                              Organization that issued/manages the identifier.

                                              ShortOrganization that issued id (may be just text)
                                              Comments

                                              The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                              Control0..1
                                              TypeReference(Organization)
                                              Is Modifierfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              108. Patient.identifier:socialSecurityNumber.assigner.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
                                              This element is affected by the following invariants: ele-1
                                              Typeid
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              110. Patient.identifier:socialSecurityNumber.assigner.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 managable, 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 Patient.identifier.assigner.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 112. Patient.identifier:socialSecurityNumber.assigner.reference
                                                Definition

                                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                ShortLiteral reference, Relative, internal or absolute URL
                                                Comments

                                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                Control0..1
                                                This element is affected by the following invariants: ref-2, ref-1
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                114. Patient.identifier:socialSecurityNumber.assigner.type
                                                Definition

                                                The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                Comments

                                                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                Control0..1
                                                BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                                Aa resource (or, for logical models, the URI of the logical model).

                                                Typeuri
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                116. Patient.identifier:socialSecurityNumber.assigner.identifier
                                                Definition

                                                An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                ShortLogical reference, when literal reference is not known
                                                Comments

                                                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                Control0..1
                                                This element is affected by the following invariants: ref-2
                                                TypeIdentifier
                                                Is Modifierfalse
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                118. Patient.identifier:socialSecurityNumber.assigner.display
                                                Definition

                                                Plain text narrative that identifies the resource in addition to the resource reference.

                                                ShortText alternative for the resource
                                                Comments

                                                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                Control0..1
                                                This element is affected by the following invariants: ref-2
                                                Typestring
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                Fixed ValueDachverband der österreichischen Sozialversicherungsträger
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                120. Patient.identifier:bPK
                                                Slice NamebPK
                                                Definition

                                                An identifier for this patient.

                                                ShortAn identifier for this patient
                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                Control0..*
                                                TypeIdentifier
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

                                                Patients are almost always assigned specific numerical identifiers.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                122. Patient.identifier:bPK.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
                                                This element is affected by the following invariants: ele-1
                                                Typeid
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                124. Patient.identifier:bPK.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 managable, 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 Patient.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 126. Patient.identifier:bPK.use
                                                  Definition

                                                  The purpose of this identifier.

                                                  Shortusual | official | temp | secondary | old (If known)
                                                  Comments

                                                  Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                  Control0..1
                                                  BindingThe codes SHALL be taken from IdentifierUse
                                                  (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

                                                  Identifies the purpose for this identifier, if known .

                                                  Typecode
                                                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Requirements

                                                  Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  128. Patient.identifier:bPK.type
                                                  Definition

                                                  A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                  ShortDescription of identifier
                                                  Comments

                                                  This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                  Control0..1
                                                  BindingThe codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier
                                                  (required to https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier)
                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Requirements

                                                  Allows users to make use of identifiers when the identifier system is not known.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  130. Patient.identifier:bPK.type.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
                                                  This element is affected by the following invariants: ele-1
                                                  Typeid
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  132. Patient.identifier:bPK.type.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 managable, 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 Patient.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 134. Patient.identifier:bPK.type.coding
                                                    Definition

                                                    A reference to a code defined by a terminology system.

                                                    ShortCode defined by a terminology system
                                                    Comments

                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                    Control0..*
                                                    TypeCoding
                                                    Is Modifierfalse
                                                    Summarytrue
                                                    Requirements

                                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    136. Patient.identifier:bPK.type.coding.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
                                                    This element is affected by the following invariants: ele-1
                                                    Typeid
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    138. Patient.identifier:bPK.type.coding.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 managable, 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 Patient.identifier.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 140. Patient.identifier:bPK.type.coding.system
                                                      Definition

                                                      The identification of the code system that defines the meaning of the symbol in the code.

                                                      ShortIdentity of the terminology system
                                                      Comments

                                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

                                                      Control0..1
                                                      Typeuri
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

                                                      Need to be unambiguous about the source of the definition of the symbol.

                                                      Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      142. Patient.identifier:bPK.type.coding.version
                                                      Definition

                                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                      ShortVersion of the system - if relevant
                                                      Comments

                                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                      NoteThis is a business versionId, not a resource version id (see discussion)
                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      144. Patient.identifier:bPK.type.coding.code
                                                      Definition

                                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                      ShortSymbol in syntax defined by the system
                                                      Control1..1
                                                      This element is affected by the following invariants: cod-1
                                                      Typecode
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

                                                      Need to refer to a particular code in the system.

                                                      Fixed ValueNI
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      146. Patient.identifier:bPK.type.coding.display
                                                      Definition

                                                      A representation of the meaning of the code in the system, following the rules of the system.

                                                      ShortRepresentation defined by the system
                                                      Control0..1
                                                      This element is affected by the following invariants: cod-1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

                                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                      Fixed ValueNational unique individual identifier
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      148. Patient.identifier:bPK.type.coding.userSelected
                                                      Definition

                                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                      ShortIf this coding was chosen directly by the user
                                                      Comments

                                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                      Control0..1
                                                      Typeboolean
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

                                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      150. Patient.identifier:bPK.type.text
                                                      Definition

                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                      ShortPlain text representation of the concept
                                                      Comments

                                                      Very often the text is the same as a displayName of one of the codings.

                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

                                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      152. Patient.identifier:bPK.system
                                                      Definition

                                                      Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

                                                      ShortOID for the bPK in Austria
                                                      Comments

                                                      Identifier.system is always case sensitive.

                                                      Control1..1
                                                      Typeuri
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

                                                      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                      Fixed Valueurn:oid:1.2.40.0.10.2.1.1.149
                                                      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      154. Patient.identifier:bPK.value
                                                      Definition

                                                      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                      ShortThe value that is unique
                                                      Comments

                                                      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                      Control0..1
                                                      This element is affected by the following invariants: ident-1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Example<br/><b>General</b>:123456
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      156. Patient.identifier:bPK.period
                                                      Definition

                                                      Time period during which identifier is/was valid for use.

                                                      ShortTime period when id is/was valid for use
                                                      Control0..1
                                                      TypePeriod
                                                      Is Modifierfalse
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      158. Patient.identifier:bPK.assigner
                                                      Definition

                                                      Organization that issued/manages the identifier.

                                                      ShortOrganization that issued id (may be just text)
                                                      Comments

                                                      The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                      Control0..1
                                                      TypeReference(Organization)
                                                      Is Modifierfalse
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      160. Patient.identifier:bPK.assigner.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
                                                      This element is affected by the following invariants: ele-1
                                                      Typeid
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      162. Patient.identifier:bPK.assigner.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 managable, 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 Patient.identifier.assigner.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 164. Patient.identifier:bPK.assigner.reference
                                                        Definition

                                                        A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                        ShortLiteral reference, Relative, internal or absolute URL
                                                        Comments

                                                        Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                        Control0..1
                                                        This element is affected by the following invariants: ref-2, ref-1
                                                        Typestring
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        166. Patient.identifier:bPK.assigner.type
                                                        Definition

                                                        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                        ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                        Comments

                                                        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                        Control0..1
                                                        BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                        (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                                        Aa resource (or, for logical models, the URI of the logical model).

                                                        Typeuri
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        168. Patient.identifier:bPK.assigner.identifier
                                                        Definition

                                                        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                        ShortLogical reference, when literal reference is not known
                                                        Comments

                                                        When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                        When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                        Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                        Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                        This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                        Control0..1
                                                        This element is affected by the following invariants: ref-2
                                                        TypeIdentifier
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        170. Patient.identifier:bPK.assigner.display
                                                        Definition

                                                        Plain text narrative that identifies the resource in addition to the resource reference.

                                                        ShortText alternative for the resource
                                                        Comments

                                                        This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                        Control0..1
                                                        This element is affected by the following invariants: ref-2
                                                        Typestring
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Fixed ValueBundesministerium für Inneres
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        172. Patient.identifier:localPatientId
                                                        Slice NamelocalPatientId
                                                        Definition

                                                        An identifier for this patient.

                                                        ShortAn identifier for this patient
                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                        Control0..1
                                                        TypeIdentifier
                                                        Is Modifierfalse
                                                        Must Supportfalse
                                                        Summarytrue
                                                        Requirements

                                                        Patients are almost always assigned specific numerical identifiers.

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        174. Patient.identifier:localPatientId.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
                                                        This element is affected by the following invariants: ele-1
                                                        Typeid
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        176. Patient.identifier:localPatientId.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 managable, 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 Patient.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 178. Patient.identifier:localPatientId.use
                                                          Definition

                                                          The purpose of this identifier.

                                                          Shortusual | official | temp | secondary | old (If known)
                                                          Comments

                                                          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                          Control0..1
                                                          BindingThe codes SHALL be taken from IdentifierUse
                                                          (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

                                                          Identifies the purpose for this identifier, if known .

                                                          Typecode
                                                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Requirements

                                                          Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          180. Patient.identifier:localPatientId.type
                                                          Definition

                                                          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                          ShortDescription of identifier
                                                          Comments

                                                          This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                          Control0..1
                                                          BindingThe codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier
                                                          (required to https://termgit.elga.gv.at/ValueSet/hl7-at-patientidentifier)
                                                          TypeCodeableConcept
                                                          Is Modifierfalse
                                                          Summarytrue
                                                          Requirements

                                                          Allows users to make use of identifiers when the identifier system is not known.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          182. Patient.identifier:localPatientId.type.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
                                                          This element is affected by the following invariants: ele-1
                                                          Typeid
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          184. Patient.identifier:localPatientId.type.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 managable, 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 Patient.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 186. Patient.identifier:localPatientId.type.coding
                                                            Definition

                                                            A reference to a code defined by a terminology system.

                                                            ShortCode defined by a terminology system
                                                            Comments

                                                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                            Control0..*
                                                            TypeCoding
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Requirements

                                                            Allows for alternative encodings within a code system, and translations to other code systems.

                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            188. Patient.identifier:localPatientId.type.coding.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
                                                            This element is affected by the following invariants: ele-1
                                                            Typeid
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            190. Patient.identifier:localPatientId.type.coding.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 managable, 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 Patient.identifier.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 192. Patient.identifier:localPatientId.type.coding.system
                                                              Definition

                                                              The identification of the code system that defines the meaning of the symbol in the code.

                                                              ShortIdentity of the terminology system
                                                              Comments

                                                              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

                                                              Control0..1
                                                              Typeuri
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              Need to be unambiguous about the source of the definition of the symbol.

                                                              Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              194. Patient.identifier:localPatientId.type.coding.version
                                                              Definition

                                                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                              ShortVersion of the system - if relevant
                                                              Comments

                                                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                              NoteThis is a business versionId, not a resource version id (see discussion)
                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              196. Patient.identifier:localPatientId.type.coding.code
                                                              Definition

                                                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                              ShortSymbol in syntax defined by the system
                                                              Control1..1
                                                              This element is affected by the following invariants: cod-1
                                                              Typecode
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              Need to refer to a particular code in the system.

                                                              Fixed ValuePI
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              198. Patient.identifier:localPatientId.type.coding.display
                                                              Definition

                                                              A representation of the meaning of the code in the system, following the rules of the system.

                                                              ShortRepresentation defined by the system
                                                              Control0..1
                                                              This element is affected by the following invariants: cod-1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                              Fixed ValuePatient internal identifier
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              200. Patient.identifier:localPatientId.type.coding.userSelected
                                                              Definition

                                                              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                              ShortIf this coding was chosen directly by the user
                                                              Comments

                                                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                              Control0..1
                                                              Typeboolean
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              202. Patient.identifier:localPatientId.type.text
                                                              Definition

                                                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                              ShortPlain text representation of the concept
                                                              Comments

                                                              Very often the text is the same as a displayName of one of the codings.

                                                              Control0..1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              204. Patient.identifier:localPatientId.system
                                                              Definition

                                                              Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

                                                              ShortNamespace that assigned the localPatientId.
                                                              Comments

                                                              Identifier.system is always case sensitive.

                                                              Control1..1
                                                              Typeuri
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Requirements

                                                              There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                              Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              206. Patient.identifier:localPatientId.value
                                                              Definition

                                                              The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                              ShortThe value that is unique
                                                              Comments

                                                              If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                              Control0..1
                                                              This element is affected by the following invariants: ident-1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Example<br/><b>General</b>:123456
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              208. Patient.identifier:localPatientId.period
                                                              Definition

                                                              Time period during which identifier is/was valid for use.

                                                              ShortTime period when id is/was valid for use
                                                              Control0..1
                                                              TypePeriod
                                                              Is Modifierfalse
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              210. Patient.identifier:localPatientId.assigner
                                                              Definition

                                                              Organization that issued/manages the identifier.

                                                              ShortOrganization that issued id (may be just text)
                                                              Comments

                                                              The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                              Control0..1
                                                              TypeReference(Organization)
                                                              Is Modifierfalse
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              212. Patient.active
                                                              Definition

                                                              Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

                                                              It is often used to filter patient lists to exclude inactive patients

                                                              Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

                                                              ShortWhether this patient's record is in active use
                                                              Comments

                                                              If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

                                                              Control0..1
                                                              Typeboolean
                                                              Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Must Supportfalse
                                                              Summarytrue
                                                              Requirements

                                                              Need to be able to mark a patient record as not to be used because it was created in error.

                                                              Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              214. Patient.name
                                                              Definition

                                                              A name associated with the individual.

                                                              ShortA name associated with the patient
                                                              Comments

                                                              A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name.

                                                              Control1..*
                                                              TypeHumanName
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summarytrue
                                                              Requirements

                                                              Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              216. Patient.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
                                                              This element is affected by the following invariants: ele-1
                                                              Typeid
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              218. Patient.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 managable, 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 Patient.name.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 220. Patient.name.use
                                                                Definition

                                                                Identifies the purpose for this name.

                                                                Shortusual | official | temp | nickname | anonymous | old | maiden
                                                                Comments

                                                                Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                                                Control0..1
                                                                BindingThe codes SHALL be taken from NameUse
                                                                (required to http://hl7.org/fhir/ValueSet/name-use|5.0.0)

                                                                The use of a human name.

                                                                Typecode
                                                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Requirements

                                                                Allows the appropriate name for a particular context of use to be selected from among a set of names.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                222. Patient.name.text
                                                                Definition

                                                                Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                                                ShortText representation of the full name
                                                                Comments

                                                                Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                                Control0..1
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Requirements

                                                                A renderable, unencoded form.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                224. Patient.name.family
                                                                Definition

                                                                The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                                ShortFamily name (often called 'Surname')
                                                                Comments

                                                                Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                                                Control0..1
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Alternate Namessurname
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                226. Patient.name.given
                                                                Definition

                                                                Given name.

                                                                ShortGiven names (not always 'first'). Includes middle names
                                                                Comments

                                                                If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                                                Control0..*
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Alternate Namesfirst name, middle name
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                228. Patient.name.prefix
                                                                Definition

                                                                Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                                ShortParts that come before the name
                                                                Control0..*
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                230. Patient.name.suffix
                                                                Definition

                                                                Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                                ShortParts that come after the name
                                                                Control0..*
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                232. Patient.name.period
                                                                Definition

                                                                Indicates the period of time when this name was valid for the named person.

                                                                ShortTime period when name was/is in use
                                                                Control0..1
                                                                TypePeriod
                                                                Is Modifierfalse
                                                                Summarytrue
                                                                Requirements

                                                                Allows names to be placed in historical context.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                234. Patient.telecom
                                                                Definition

                                                                A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                                ShortA contact detail for the individual
                                                                Comments

                                                                A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                                Control0..*
                                                                TypeContactPoint
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summarytrue
                                                                Requirements

                                                                People have (primary) ways to contact them in some way such as phone, email.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                236. Patient.telecom.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
                                                                This element is affected by the following invariants: ele-1
                                                                Typeid
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                238. Patient.telecom.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 managable, 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 Patient.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 240. Patient.telecom.system
                                                                  Definition

                                                                  Telecommunications form for contact point - what communications system is required to make use of the contact.

                                                                  Shortphone | fax | email | pager | url | sms | other
                                                                  Control0..1
                                                                  This element is affected by the following invariants: cpt-2
                                                                  BindingThe codes SHALL be taken from ContactPointSystem
                                                                  (required to http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0)

                                                                  Telecommunications form for contact point.

                                                                  Typecode
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  242. Patient.telecom.value
                                                                  Definition

                                                                  The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                                                  ShortThe actual contact point details
                                                                  Comments

                                                                  Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                                                                  Control0..1
                                                                  This element is affected by the following invariants: cpt-2
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Requirements

                                                                  Need to support legacy numbers that are not in a tightly controlled format.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  244. Patient.telecom.use
                                                                  Definition

                                                                  Identifies the purpose for the contact point.

                                                                  Shorthome | work | temp | old | mobile - purpose of this contact point
                                                                  Comments

                                                                  Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                                                  Control0..1
                                                                  BindingThe codes SHALL be taken from ContactPointUse
                                                                  (required to http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0)

                                                                  Use of contact point.

                                                                  Typecode
                                                                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Requirements

                                                                  Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  246. Patient.telecom.rank
                                                                  Definition

                                                                  Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                  ShortSpecify preferred order of use (1 = highest)
                                                                  Comments

                                                                  Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                                                                  Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions.

                                                                  Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.

                                                                  Control0..1
                                                                  TypepositiveInt
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  248. Patient.telecom.period
                                                                  Definition

                                                                  Time period when the contact point was/is in use.

                                                                  ShortTime period when the contact point was/is in use
                                                                  Control0..1
                                                                  TypePeriod
                                                                  Is Modifierfalse
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  250. Patient.gender
                                                                  Definition

                                                                  Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

                                                                  Shortmale | female | other | unknown
                                                                  Comments

                                                                  The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

                                                                  Control1..1
                                                                  BindingThe codes SHALL be taken from AdministrativeGender
                                                                  (required to http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0)

                                                                  The gender of a person used for administrative purposes.

                                                                  Typecode
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Must Supportfalse
                                                                  Summarytrue
                                                                  Requirements

                                                                  Needed for identification of the individual, in combination with (at least) name and birth date.

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  252. Patient.gender.id
                                                                  Definition

                                                                  unique id for the element within a resource (for internal references)

                                                                  Shortxml:id (or equivalent in JSON)
                                                                  Control0..1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  254. Patient.gender.extension
                                                                  Definition

                                                                  An Extension

                                                                  ShortExtension
                                                                  Control0..*
                                                                  TypeExtension
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  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 Patient.gender.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                  • value @ url
                                                                  • 256. Patient.gender.extension:AdministrativeGenderAddition
                                                                    Slice NameAdministrativeGenderAddition
                                                                    Definition

                                                                    HL7® Austria FHIR® Core Extension for the administrative gender of a person (Patient, Practitioner, ...). The extension is used to add the missing codes and is applied in case the code for administrative gender itself is set to 'other'.

                                                                    ShortAdministrative Gender Addition
                                                                    Control0..1
                                                                    TypeExtension(Administrative Gender Addition) (Extension Type: Coding)
                                                                    Is Modifierfalse
                                                                    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())
                                                                    258. Patient.gender.value
                                                                    Definition

                                                                    Primitive value for code

                                                                    ShortPrimitive value for code
                                                                    Control0..1
                                                                    Typecode
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    260. Patient.birthDate
                                                                    Definition

                                                                    The date of birth for the individual.

                                                                    ShortThe date of birth for the individual
                                                                    Comments

                                                                    Partial dates are allowed if the specific date of birth is unknown. There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

                                                                    Control0..1
                                                                    Typedate
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Must Supportfalse
                                                                    Summarytrue
                                                                    Requirements

                                                                    Age of the individual drives many clinical processes.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    LOINC Code21112-8
                                                                    262. Patient.deceased[x]
                                                                    Definition

                                                                    Indicates if the individual is deceased or not.

                                                                    ShortIndicates if the individual is deceased or not
                                                                    Comments

                                                                    If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                                    Control0..1
                                                                    TypeChoice of: boolean, dateTime
                                                                    [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                    Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Must Supportfalse
                                                                    Summarytrue
                                                                    Requirements

                                                                    The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
                                                                    • type @ $this
                                                                    • 264. Patient.deceased[x]:deceasedBoolean
                                                                      Slice NamedeceasedBoolean
                                                                      Definition

                                                                      Indicates if the individual is deceased or not.

                                                                      ShortIndicates if the individual is deceased or not
                                                                      Comments

                                                                      If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                                      Control0..1
                                                                      Typeboolean
                                                                      [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                      Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      266. Patient.deceased[x]:deceasedDateTime
                                                                      Slice NamedeceasedDateTime
                                                                      Definition

                                                                      Indicates if the individual is deceased or not.

                                                                      ShortIndicates if the individual is deceased or not
                                                                      Comments

                                                                      If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                                      Control0..1
                                                                      TypedateTime
                                                                      [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                      Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                      Must Supportfalse
                                                                      Summarytrue
                                                                      Requirements

                                                                      The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      268. Patient.address
                                                                      Definition

                                                                      An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.

                                                                      ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
                                                                      Comments

                                                                      Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                                                      Control0..*
                                                                      TypeAddress(HL7® AT Core Address Profile)
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Requirements

                                                                      May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      at-addr-1: If the extension for street name is used then the value for line must not be empty (line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue()))
                                                                      at-addr-2: If the extension for street number is used then the value for line must not be empty (line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue()))
                                                                      at-addr-3: If the extension for floor/door number is used then the value for line must not be empty (line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue()))
                                                                      270. Patient.address.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
                                                                      This element is affected by the following invariants: ele-1
                                                                      Typeid
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      272. Patient.address.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 managable, 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 Patient.address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 274. Patient.address.use
                                                                        Definition

                                                                        The purpose of this address.

                                                                        Shorthome | work | temp | old | billing - purpose of this address
                                                                        Comments

                                                                        Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                                                                        Control0..1
                                                                        BindingThe codes SHALL be taken from AddressUse
                                                                        (required to http://hl7.org/fhir/ValueSet/address-use|5.0.0)

                                                                        The use of an address (home / work / etc.).

                                                                        Typecode
                                                                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Requirements

                                                                        Allows an appropriate address to be chosen from a list of many.

                                                                        Example<br/><b>General</b>:home
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        276. Patient.address.type
                                                                        Definition

                                                                        Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                                                                        Shortpostal | physical | both
                                                                        Comments

                                                                        The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                                                        Control0..1
                                                                        BindingThe codes SHALL be taken from AddressType
                                                                        (required to http://hl7.org/fhir/ValueSet/address-type|5.0.0)

                                                                        The type of an address (physical / postal).

                                                                        Typecode
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Example<br/><b>General</b>:both
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        278. Patient.address.text
                                                                        Definition

                                                                        Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

                                                                        ShortText representation of the address
                                                                        Comments

                                                                        Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                                        Control0..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Requirements

                                                                        A renderable, unencoded form.

                                                                        Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        280. Patient.address.line
                                                                        Definition

                                                                        This component contains the street name, street number, floor and/or door number or additonal information (e.g. street direction, P.O. Box number, delivery hints, and similar address information). This information can be split into structured values in the line-components each defined by international ISO extensions. If these extensions are used then the information they contain has to be written in a concatenated way in the line element itself as well. This makes the usage easier for systems which don't use address data in a structured way.

                                                                        ShortStreet name, number, direction & P.O. Box etc.
                                                                        Control0..*
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Example<br/><b>General</b>:137 Nowhere Street
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        282. Patient.address.line.id
                                                                        Definition

                                                                        unique id for the element within a resource (for internal references)

                                                                        Shortxml:id (or equivalent in JSON)
                                                                        Control0..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                        Summaryfalse
                                                                        284. Patient.address.line.extension
                                                                        Definition

                                                                        An Extension

                                                                        ShortExtension
                                                                        Control0..*
                                                                        TypeExtension
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        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 Patient.address.line.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 286. Patient.address.line.extension:street
                                                                          Slice Namestreet
                                                                          Definition

                                                                          Name of the street without the street number

                                                                          ShortName of the street
                                                                          Control0..1
                                                                          TypeExtension(ADXP Street Name) (Extension Type: string)
                                                                          Is Modifierfalse
                                                                          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())
                                                                          288. Patient.address.line.extension:streetNumber
                                                                          Slice NamestreetNumber
                                                                          Definition

                                                                          Number of the street without the street name

                                                                          ShortNumber of the street
                                                                          Control0..1
                                                                          TypeExtension(ADXP House Number) (Extension Type: string)
                                                                          Is Modifierfalse
                                                                          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())
                                                                          290. Patient.address.line.extension:floorDoorNumber
                                                                          Slice NamefloorDoorNumber
                                                                          Definition

                                                                          Floor and/or door number

                                                                          ShortFloor and/or door number
                                                                          Control0..1
                                                                          TypeExtension(ADXP Additional Locator) (Extension Type: string)
                                                                          Is Modifierfalse
                                                                          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())
                                                                          292. Patient.address.line.extension:additionalInformation
                                                                          Slice NameadditionalInformation
                                                                          Definition

                                                                          Additional information about the street address

                                                                          ShortAdditional Information
                                                                          Control0..1
                                                                          TypeExtension(Address Additional Information) (Extension Type: string)
                                                                          Is Modifierfalse
                                                                          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())
                                                                          294. Patient.address.line.value
                                                                          Definition

                                                                          The actual value

                                                                          ShortPrimitive value for string
                                                                          Control0..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          Max Length1048576
                                                                          296. Patient.address.city
                                                                          Definition

                                                                          The name of the city, town, suburb, village or other community or delivery center.

                                                                          ShortName of city, town etc.
                                                                          Control0..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Alternate NamesMunicpality
                                                                          Example<br/><b>General</b>:Erewhon
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          298. Patient.address.district
                                                                          Definition

                                                                          The name of the administrative area (county).

                                                                          ShortDistrict name (aka county)
                                                                          Comments

                                                                          District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                                                                          Control0..0
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Alternate NamesCounty
                                                                          Example<br/><b>General</b>:Madison
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          300. Patient.address.state
                                                                          Definition

                                                                          Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

                                                                          ShortSub-unit of country (abbreviations ok)
                                                                          Control0..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Alternate NamesProvince, Territory
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          302. Patient.address.postalCode
                                                                          Definition

                                                                          A postal code designating a region defined by the postal service.

                                                                          ShortPostal code for area
                                                                          Control0..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Alternate NamesZip
                                                                          Example<br/><b>General</b>:9132
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          304. Patient.address.country
                                                                          Definition

                                                                          Country - a nation as commonly understood or generally accepted.

                                                                          ShortCountry (e.g. may be ISO 3166 2 or 3 letter code)
                                                                          Comments

                                                                          ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

                                                                          Control0..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          306. Patient.address.period
                                                                          Definition

                                                                          Time period when address was/is in use.

                                                                          ShortTime period when address was/is in use
                                                                          Control0..0
                                                                          TypePeriod
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Requirements

                                                                          Allows addresses to be placed in historical context.

                                                                          Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          308. Patient.maritalStatus
                                                                          Definition

                                                                          This field contains a patient's most recent marital (civil) status.

                                                                          ShortMarital (civil) status of a patient
                                                                          Control0..1
                                                                          BindingUnless not suitable, these codes SHALL be taken from MaritalStatusCodes
                                                                          (extensible to http://hl7.org/fhir/ValueSet/marital-status)

                                                                          The domestic partnership status of a person.

                                                                          TypeCodeableConcept
                                                                          Is Modifierfalse
                                                                          Must Supportfalse
                                                                          Summaryfalse
                                                                          Requirements

                                                                          Most, if not all systems capture it.

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          310. Patient.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
                                                                          This element is affected by the following invariants: ele-1
                                                                          Typeid
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          312. Patient.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 managable, 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 Patient.maritalStatus.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 314. Patient.maritalStatus.coding
                                                                            Definition

                                                                            A reference to a code defined by a terminology system.

                                                                            ShortCode defined by a terminology system
                                                                            Comments

                                                                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                            Control0..*
                                                                            TypeCoding
                                                                            Is Modifierfalse
                                                                            Summarytrue
                                                                            Requirements

                                                                            Allows for alternative encodings within a code system, and translations to other code systems.

                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            316. Patient.maritalStatus.coding.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
                                                                            This element is affected by the following invariants: ele-1
                                                                            Typeid
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            318. Patient.maritalStatus.coding.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 managable, 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 Patient.maritalStatus.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 320. Patient.maritalStatus.coding.system
                                                                              Definition

                                                                              The identification of the code system that defines the meaning of the symbol in the code.

                                                                              ShortIdentity of the terminology system
                                                                              Comments

                                                                              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

                                                                              Control0..1
                                                                              Typeuri
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              Need to be unambiguous about the source of the definition of the symbol.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              322. Patient.maritalStatus.coding.version
                                                                              Definition

                                                                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                              ShortVersion of the system - if relevant
                                                                              Comments

                                                                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                              NoteThis is a business versionId, not a resource version id (see discussion)
                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              324. Patient.maritalStatus.coding.code
                                                                              Definition

                                                                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                              ShortSymbol in syntax defined by the system
                                                                              Control0..1
                                                                              This element is affected by the following invariants: cod-1
                                                                              Typecode
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              Need to refer to a particular code in the system.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              326. Patient.maritalStatus.coding.display
                                                                              Definition

                                                                              A representation of the meaning of the code in the system, following the rules of the system.

                                                                              ShortRepresentation defined by the system
                                                                              Control0..1
                                                                              This element is affected by the following invariants: cod-1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              328. Patient.maritalStatus.coding.userSelected
                                                                              Definition

                                                                              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                              ShortIf this coding was chosen directly by the user
                                                                              Comments

                                                                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                              Control0..1
                                                                              Typeboolean
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              330. Patient.maritalStatus.text
                                                                              Definition

                                                                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                              ShortPlain text representation of the concept
                                                                              Comments

                                                                              Very often the text is the same as a displayName of one of the codings.

                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Requirements

                                                                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              332. Patient.multipleBirth[x]
                                                                              Definition

                                                                              Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                              ShortWhether patient is part of a multiple birth
                                                                              Comments

                                                                              Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                              Control0..1
                                                                              TypeChoice of: boolean, integer
                                                                              [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Must Supportfalse
                                                                              Summaryfalse
                                                                              Requirements

                                                                              For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              SlicingThis element introduces a set of slices on Patient.multipleBirth[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
                                                                              • type @ $this
                                                                              • 334. Patient.multipleBirth[x]:multipleBirthBoolean
                                                                                Slice NamemultipleBirthBoolean
                                                                                Definition

                                                                                Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                                ShortWhether patient is part of a multiple birth
                                                                                Comments

                                                                                Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                                Control0..1
                                                                                Typeboolean
                                                                                [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Requirements

                                                                                For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                336. Patient.multipleBirth[x]:multipleBirthInteger
                                                                                Slice NamemultipleBirthInteger
                                                                                Definition

                                                                                Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                                ShortWhether patient is part of a multiple birth
                                                                                Comments

                                                                                Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                                Control0..1
                                                                                Typeinteger
                                                                                [x] NoteSee Choice of Data Types for further information about how to use [x]
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Requirements

                                                                                For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                338. Patient.photo
                                                                                Definition

                                                                                Image of the patient.

                                                                                ShortImage of the patient
                                                                                Comments

                                                                                Guidelines:

                                                                                • Use id photos, not clinical photos.
                                                                                • Limit dimensions to thumbnail.
                                                                                • Keep byte count low to ease resource updates.
                                                                                Control0..*
                                                                                TypeAttachment
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Requirements

                                                                                Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                340. Patient.contact
                                                                                Definition

                                                                                A contact party (e.g. guardian, partner, friend) for the patient.

                                                                                ShortA contact party (e.g. guardian, partner, friend) for the patient
                                                                                Comments

                                                                                Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                                                                Control0..*
                                                                                TypeBackboneElement
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Requirements

                                                                                Need to track people you can contact about the patient.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                                                                342. Patient.contact.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
                                                                                This element is affected by the following invariants: ele-1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                344. Patient.contact.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 managable, 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())
                                                                                346. Patient.contact.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 managable, 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())
                                                                                348. Patient.contact.relationship
                                                                                Definition

                                                                                The nature of the relationship between the patient and the contact person.

                                                                                ShortThe kind of relationship
                                                                                Control0..*
                                                                                BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationship
                                                                                (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship)

                                                                                The nature of the relationship between a patient and a contact person for that patient.

                                                                                TypeCodeableConcept
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Requirements

                                                                                Used to determine which contact person is the most relevant to approach, depending on circumstances.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                350. Patient.contact.relationship.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
                                                                                This element is affected by the following invariants: ele-1
                                                                                Typeid
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                352. Patient.contact.relationship.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 managable, 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 Patient.contact.relationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                                • value @ url
                                                                                • 354. Patient.contact.relationship.coding
                                                                                  Definition

                                                                                  A reference to a code defined by a terminology system.

                                                                                  ShortCode defined by a terminology system
                                                                                  Comments

                                                                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                  Control0..*
                                                                                  TypeCoding
                                                                                  Is Modifierfalse
                                                                                  Summarytrue
                                                                                  Requirements

                                                                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  356. Patient.contact.relationship.coding.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
                                                                                  This element is affected by the following invariants: ele-1
                                                                                  Typeid
                                                                                  Is Modifierfalse
                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                  Summaryfalse
                                                                                  358. Patient.contact.relationship.coding.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 managable, 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 Patient.contact.relationship.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                                  • value @ url
                                                                                  • 360. Patient.contact.relationship.coding.system
                                                                                    Definition

                                                                                    The identification of the code system that defines the meaning of the symbol in the code.

                                                                                    ShortIdentity of the terminology system
                                                                                    Comments

                                                                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

                                                                                    Control0..1
                                                                                    Typeuri
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Requirements

                                                                                    Need to be unambiguous about the source of the definition of the symbol.

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    362. Patient.contact.relationship.coding.version
                                                                                    Definition

                                                                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                    ShortVersion of the system - if relevant
                                                                                    Comments

                                                                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                    NoteThis is a business versionId, not a resource version id (see discussion)
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    364. Patient.contact.relationship.coding.code
                                                                                    Definition

                                                                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                    ShortSymbol in syntax defined by the system
                                                                                    Control0..1
                                                                                    This element is affected by the following invariants: cod-1
                                                                                    Typecode
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Requirements

                                                                                    Need to refer to a particular code in the system.

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    366. Patient.contact.relationship.coding.display
                                                                                    Definition

                                                                                    A representation of the meaning of the code in the system, following the rules of the system.

                                                                                    ShortRepresentation defined by the system
                                                                                    Control0..1
                                                                                    This element is affected by the following invariants: cod-1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Requirements

                                                                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    368. Patient.contact.relationship.coding.userSelected
                                                                                    Definition

                                                                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                    ShortIf this coding was chosen directly by the user
                                                                                    Comments

                                                                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                    Control0..1
                                                                                    Typeboolean
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Requirements

                                                                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    370. Patient.contact.relationship.text
                                                                                    Definition

                                                                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                    ShortPlain text representation of the concept
                                                                                    Comments

                                                                                    Very often the text is the same as a displayName of one of the codings.

                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                    Summarytrue
                                                                                    Requirements

                                                                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    372. Patient.contact.name
                                                                                    Definition

                                                                                    A name associated with the contact person.

                                                                                    ShortA name associated with the contact person
                                                                                    Control0..1
                                                                                    This element is affected by the following invariants: pat-1
                                                                                    TypeHumanName
                                                                                    Is Modifierfalse
                                                                                    Must Supportfalse
                                                                                    Summaryfalse
                                                                                    Requirements

                                                                                    Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    374. Patient.contact.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
                                                                                    This element is affected by the following invariants: ele-1
                                                                                    Typeid
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    376. Patient.contact.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 managable, 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 Patient.contact.name.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                                    • value @ url
                                                                                    • 378. Patient.contact.name.use
                                                                                      Definition

                                                                                      Identifies the purpose for this name.

                                                                                      Shortusual | official | temp | nickname | anonymous | old | maiden
                                                                                      Comments

                                                                                      Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                                                                      Control0..1
                                                                                      BindingThe codes SHALL be taken from NameUse
                                                                                      (required to http://hl7.org/fhir/ValueSet/name-use|5.0.0)

                                                                                      The use of a human name.

                                                                                      Typecode
                                                                                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      Allows the appropriate name for a particular context of use to be selected from among a set of names.

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      380. Patient.contact.name.text
                                                                                      Definition

                                                                                      Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                                                                      ShortText representation of the full name
                                                                                      Comments

                                                                                      Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      A renderable, unencoded form.

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      382. Patient.contact.name.family
                                                                                      Definition

                                                                                      The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                                                      ShortFamily name (often called 'Surname')
                                                                                      Comments

                                                                                      Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Alternate Namessurname
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      384. Patient.contact.name.given
                                                                                      Definition

                                                                                      Given name.

                                                                                      ShortGiven names (not always 'first'). Includes middle names
                                                                                      Comments

                                                                                      If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                                                                      Control0..*
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Alternate Namesfirst name, middle name
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      386. Patient.contact.name.prefix
                                                                                      Definition

                                                                                      Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                                                      ShortParts that come before the name
                                                                                      Control0..*
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      388. Patient.contact.name.suffix
                                                                                      Definition

                                                                                      Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                                                      ShortParts that come after the name
                                                                                      Control0..*
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      390. Patient.contact.name.period
                                                                                      Definition

                                                                                      Indicates the period of time when this name was valid for the named person.

                                                                                      ShortTime period when name was/is in use
                                                                                      Control0..1
                                                                                      TypePeriod
                                                                                      Is Modifierfalse
                                                                                      Summarytrue
                                                                                      Requirements

                                                                                      Allows names to be placed in historical context.

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      392. Patient.contact.telecom
                                                                                      Definition

                                                                                      A contact detail for the person, e.g. a telephone number or an email address.

                                                                                      ShortA contact detail for the person
                                                                                      Comments

                                                                                      Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

                                                                                      Control0..*
                                                                                      This element is affected by the following invariants: pat-1
                                                                                      TypeContactPoint
                                                                                      Is Modifierfalse
                                                                                      Must Supportfalse
                                                                                      Summaryfalse
                                                                                      Requirements

                                                                                      People have (primary) ways to contact them in some way such as phone, email.

                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      394. Patient.contact.telecom.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
                                                                                      This element is affected by the following invariants: ele-1
                                                                                      Typeid
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      396. Patient.contact.telecom.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 managable, 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 Patient.contact.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                                      • value @ url
                                                                                      • 398. Patient.contact.telecom.system
                                                                                        Definition

                                                                                        Telecommunications form for contact point - what communications system is required to make use of the contact.

                                                                                        Shortphone | fax | email | pager | url | sms | other
                                                                                        Control0..1
                                                                                        This element is affected by the following invariants: cpt-2
                                                                                        BindingThe codes SHALL be taken from ContactPointSystem
                                                                                        (required to http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0)

                                                                                        Telecommunications form for contact point.

                                                                                        Typecode
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        400. Patient.contact.telecom.value
                                                                                        Definition

                                                                                        The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                                                                                        ShortThe actual contact point details
                                                                                        Comments

                                                                                        Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                                                                                        Control0..1
                                                                                        This element is affected by the following invariants: cpt-2
                                                                                        Typestring
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Summarytrue
                                                                                        Requirements

                                                                                        Need to support legacy numbers that are not in a tightly controlled format.

                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        402. Patient.contact.telecom.use
                                                                                        Definition

                                                                                        Identifies the purpose for the contact point.

                                                                                        Shorthome | work | temp | old | mobile - purpose of this contact point
                                                                                        Comments

                                                                                        Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                                                                                        Control0..1
                                                                                        BindingThe codes SHALL be taken from ContactPointUse
                                                                                        (required to http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0)

                                                                                        Use of contact point.

                                                                                        Typecode
                                                                                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Summarytrue
                                                                                        Requirements

                                                                                        Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        404. Patient.contact.telecom.rank
                                                                                        Definition

                                                                                        Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                                                                                        ShortSpecify preferred order of use (1 = highest)
                                                                                        Comments

                                                                                        Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                                                                                        Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions.

                                                                                        Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.

                                                                                        Control0..1
                                                                                        TypepositiveInt
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        406. Patient.contact.telecom.period
                                                                                        Definition

                                                                                        Time period when the contact point was/is in use.

                                                                                        ShortTime period when the contact point was/is in use
                                                                                        Control0..1
                                                                                        TypePeriod
                                                                                        Is Modifierfalse
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        408. Patient.contact.address
                                                                                        Definition

                                                                                        An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. The ISO21090-codedString may be used to provide a coded representation of the contents of strings in an Address.

                                                                                        ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
                                                                                        Comments

                                                                                        Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                                                                        Control0..1
                                                                                        TypeAddress(HL7® AT Core Address Profile)
                                                                                        Is Modifierfalse
                                                                                        Must Supportfalse
                                                                                        Requirements

                                                                                        Need to keep track where the contact person can be contacted per postal mail or visited.

                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        at-addr-1: If the extension for street name is used then the value for line must not be empty (line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty() or $this.hasValue()))
                                                                                        at-addr-2: If the extension for street number is used then the value for line must not be empty (line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty() or $this.hasValue()))
                                                                                        at-addr-3: If the extension for floor/door number is used then the value for line must not be empty (line.all($this.extension('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty() or $this.hasValue()))
                                                                                        410. Patient.contact.address.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
                                                                                        This element is affected by the following invariants: ele-1
                                                                                        Typeid
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        412. Patient.contact.address.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 managable, 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 Patient.contact.address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                                        • value @ url
                                                                                        • 414. Patient.contact.address.use
                                                                                          Definition

                                                                                          The purpose of this address.

                                                                                          Shorthome | work | temp | old | billing - purpose of this address
                                                                                          Comments

                                                                                          Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                                                                                          Control0..1
                                                                                          BindingThe codes SHALL be taken from AddressUse
                                                                                          (required to http://hl7.org/fhir/ValueSet/address-use|5.0.0)

                                                                                          The use of an address (home / work / etc.).

                                                                                          Typecode
                                                                                          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Requirements

                                                                                          Allows an appropriate address to be chosen from a list of many.

                                                                                          Example<br/><b>General</b>:home
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          416. Patient.contact.address.type
                                                                                          Definition

                                                                                          Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                                                                                          Shortpostal | physical | both
                                                                                          Comments

                                                                                          The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                                                                          Control0..1
                                                                                          BindingThe codes SHALL be taken from AddressType
                                                                                          (required to http://hl7.org/fhir/ValueSet/address-type|5.0.0)

                                                                                          The type of an address (physical / postal).

                                                                                          Typecode
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Example<br/><b>General</b>:both
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          418. Patient.contact.address.text
                                                                                          Definition

                                                                                          Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

                                                                                          ShortText representation of the address
                                                                                          Comments

                                                                                          Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                                                          Control0..1
                                                                                          Typestring
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Requirements

                                                                                          A renderable, unencoded form.

                                                                                          Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          420. Patient.contact.address.line
                                                                                          Definition

                                                                                          This component contains the street name, street number, floor and/or door number or additonal information (e.g. street direction, P.O. Box number, delivery hints, and similar address information). This information can be split into structured values in the line-components each defined by international ISO extensions. If these extensions are used then the information they contain has to be written in a concatenated way in the line element itself as well. This makes the usage easier for systems which don't use address data in a structured way.

                                                                                          ShortStreet name, number, direction & P.O. Box etc.
                                                                                          Control0..*
                                                                                          Typestring
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Summarytrue
                                                                                          Example<br/><b>General</b>:137 Nowhere Street
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          422. Patient.contact.address.line.id
                                                                                          Definition

                                                                                          unique id for the element within a resource (for internal references)

                                                                                          Shortxml:id (or equivalent in JSON)
                                                                                          Control0..1
                                                                                          Typestring
                                                                                          Is Modifierfalse
                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                          Summaryfalse
                                                                                          424. Patient.contact.address.line.extension
                                                                                          Definition

                                                                                          An Extension

                                                                                          ShortExtension
                                                                                          Control0..*
                                                                                          TypeExtension
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          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 Patient.contact.address.line.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                                          • value @ url
                                                                                          • 426. Patient.contact.address.line.extension:street
                                                                                            Slice Namestreet
                                                                                            Definition

                                                                                            Name of the street without the street number

                                                                                            ShortName of the street
                                                                                            Control0..1
                                                                                            TypeExtension(ADXP Street Name) (Extension Type: string)
                                                                                            Is Modifierfalse
                                                                                            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())
                                                                                            428. Patient.contact.address.line.extension:streetNumber
                                                                                            Slice NamestreetNumber
                                                                                            Definition

                                                                                            Number of the street without the street name

                                                                                            ShortNumber of the street
                                                                                            Control0..1
                                                                                            TypeExtension(ADXP House Number) (Extension Type: string)
                                                                                            Is Modifierfalse
                                                                                            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())
                                                                                            430. Patient.contact.address.line.extension:floorDoorNumber
                                                                                            Slice NamefloorDoorNumber
                                                                                            Definition

                                                                                            Floor and/or door number

                                                                                            ShortFloor and/or door number
                                                                                            Control0..1
                                                                                            TypeExtension(ADXP Additional Locator) (Extension Type: string)
                                                                                            Is Modifierfalse
                                                                                            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())
                                                                                            432. Patient.contact.address.line.extension:additionalInformation
                                                                                            Slice NameadditionalInformation
                                                                                            Definition

                                                                                            Additional information about the street address

                                                                                            ShortAdditional Information
                                                                                            Control0..1
                                                                                            TypeExtension(Address Additional Information) (Extension Type: string)
                                                                                            Is Modifierfalse
                                                                                            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())
                                                                                            434. Patient.contact.address.line.value
                                                                                            Definition

                                                                                            The actual value

                                                                                            ShortPrimitive value for string
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            Max Length1048576
                                                                                            436. Patient.contact.address.city
                                                                                            Definition

                                                                                            The name of the city, town, suburb, village or other community or delivery center.

                                                                                            ShortName of city, town etc.
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Summarytrue
                                                                                            Alternate NamesMunicpality
                                                                                            Example<br/><b>General</b>:Erewhon
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            438. Patient.contact.address.district
                                                                                            Definition

                                                                                            The name of the administrative area (county).

                                                                                            ShortDistrict name (aka county)
                                                                                            Comments

                                                                                            District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                                                                                            Control0..0
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Summarytrue
                                                                                            Alternate NamesCounty
                                                                                            Example<br/><b>General</b>:Madison
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            440. Patient.contact.address.state
                                                                                            Definition

                                                                                            Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

                                                                                            ShortSub-unit of country (abbreviations ok)
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Summarytrue
                                                                                            Alternate NamesProvince, Territory
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            442. Patient.contact.address.postalCode
                                                                                            Definition

                                                                                            A postal code designating a region defined by the postal service.

                                                                                            ShortPostal code for area
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Summarytrue
                                                                                            Alternate NamesZip
                                                                                            Example<br/><b>General</b>:9132
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            444. Patient.contact.address.country
                                                                                            Definition

                                                                                            Country - a nation as commonly understood or generally accepted.

                                                                                            ShortCountry (e.g. may be ISO 3166 2 or 3 letter code)
                                                                                            Comments

                                                                                            ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Summarytrue
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            446. Patient.contact.address.period
                                                                                            Definition

                                                                                            Time period when address was/is in use.

                                                                                            ShortTime period when address was/is in use
                                                                                            Control0..0
                                                                                            TypePeriod
                                                                                            Is Modifierfalse
                                                                                            Summarytrue
                                                                                            Requirements

                                                                                            Allows addresses to be placed in historical context.

                                                                                            Example<br/><b>General</b>:{ "start" : "2010-03-23", "end" : "2010-07-01" }
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            448. Patient.contact.gender
                                                                                            Definition

                                                                                            Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.

                                                                                            Shortmale | female | other | unknown
                                                                                            Control0..1
                                                                                            BindingThe codes SHALL be taken from AdministrativeGender
                                                                                            (required to http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0)

                                                                                            The gender of a person used for administrative purposes.

                                                                                            Typecode
                                                                                            Is Modifierfalse
                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                            Must Supportfalse
                                                                                            Summaryfalse
                                                                                            Requirements

                                                                                            Needed to address the person correctly.

                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            450. Patient.contact.gender.id
                                                                                            Definition

                                                                                            unique id for the element within a resource (for internal references)

                                                                                            Shortxml:id (or equivalent in JSON)
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            452. Patient.contact.gender.extension
                                                                                            Definition

                                                                                            An Extension

                                                                                            ShortExtension
                                                                                            Control0..*
                                                                                            TypeExtension
                                                                                            Is Modifierfalse
                                                                                            Summaryfalse
                                                                                            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 Patient.contact.gender.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                                                                                            • value @ url
                                                                                            • 454. Patient.contact.gender.extension:AdministrativeGenderAddition
                                                                                              Slice NameAdministrativeGenderAddition
                                                                                              Definition

                                                                                              HL7® Austria FHIR® Core Extension for the administrative gender of a person (Patient, Practitioner, ...). The extension is used to add the missing codes and is applied in case the code for administrative gender itself is set to 'other'.

                                                                                              ShortAdministrative Gender Addition
                                                                                              Control0..1
                                                                                              TypeExtension(Administrative Gender Addition) (Extension Type: Coding)
                                                                                              Is Modifierfalse
                                                                                              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())
                                                                                              456. Patient.contact.gender.value
                                                                                              Definition

                                                                                              Primitive value for code

                                                                                              ShortPrimitive value for code
                                                                                              Control0..1
                                                                                              Typecode
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              458. Patient.contact.organization
                                                                                              Definition

                                                                                              Organization on behalf of which the contact is acting or for which the contact is working.

                                                                                              ShortOrganization that is associated with the contact
                                                                                              Control0..1
                                                                                              This element is affected by the following invariants: pat-1
                                                                                              TypeReference(Organization)
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              For guardians or business related contacts, the organization is relevant.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              460. Patient.contact.period
                                                                                              Definition

                                                                                              The period during which this contact person or organization is valid to be contacted relating to this patient.

                                                                                              ShortThe period during which this contact person or organization is valid to be contacted relating to this patient
                                                                                              Control0..1
                                                                                              TypePeriod
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              462. Patient.communication
                                                                                              Definition

                                                                                              A language which may be used to communicate with the patient about his or her health.

                                                                                              ShortA language which may be used to communicate with the patient about his or her health
                                                                                              Comments

                                                                                              If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                                                                              Control0..*
                                                                                              TypeBackboneElement
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              464. Patient.communication.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
                                                                                              This element is affected by the following invariants: ele-1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              466. Patient.communication.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 managable, 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())
                                                                                              468. Patient.communication.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 managable, 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())
                                                                                              470. Patient.communication.language
                                                                                              Definition

                                                                                              The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-AU" for Australian English.

                                                                                              ShortThe language which can be used to communicate with the patient about his or her health
                                                                                              Comments

                                                                                              The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

                                                                                              Control1..1
                                                                                              BindingThe codes SHALL be taken from AllLanguages
                                                                                              (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

                                                                                              IETF language tag for a human language

                                                                                              TypeCodeableConcept
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              472. Patient.communication.preferred
                                                                                              Definition

                                                                                              Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

                                                                                              ShortLanguage preference indicator
                                                                                              Comments

                                                                                              This language is specifically identified for communicating healthcare information.

                                                                                              Control0..1
                                                                                              Typeboolean
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Requirements

                                                                                              People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              474. Patient.generalPractitioner
                                                                                              Definition

                                                                                              Patient's nominated care provider.

                                                                                              ShortPatient's nominated primary care provider
                                                                                              Comments

                                                                                              This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

                                                                                              Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

                                                                                              Control0..*
                                                                                              TypeReference(Organization, Practitioner, PractitionerRole)
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summaryfalse
                                                                                              Alternate NamescareProvider
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              476. Patient.managingOrganization
                                                                                              Definition

                                                                                              Organization that is the custodian of the patient record.

                                                                                              ShortOrganization that is the custodian of the patient record
                                                                                              Comments

                                                                                              There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                                                                                              Control0..1
                                                                                              TypeReference(Organization)
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summarytrue
                                                                                              Requirements

                                                                                              Need to know who recognizes this patient record, manages and updates it.

                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              478. Patient.link
                                                                                              Definition

                                                                                              Link to a Patient or RelatedPerson resource that concerns the same actual individual.

                                                                                              ShortLink to a Patient or RelatedPerson resource that concerns the same actual individual
                                                                                              Comments

                                                                                              There is no assumption that linked patient records have mutual links.

                                                                                              Control0..*
                                                                                              TypeBackboneElement
                                                                                              Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                                                                                              Must Supportfalse
                                                                                              Summarytrue
                                                                                              Requirements

                                                                                              There are multiple use cases:

                                                                                              • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                                                                                              • Distribution of patient information across multiple servers.
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              480. Patient.link.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
                                                                                              This element is affected by the following invariants: ele-1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              482. Patient.link.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 managable, 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())
                                                                                              484. Patient.link.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 managable, 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())
                                                                                              486. Patient.link.other
                                                                                              Definition

                                                                                              Link to a Patient or RelatedPerson resource that concerns the same actual individual.

                                                                                              ShortThe other patient or related person resource that the link refers to
                                                                                              Comments

                                                                                              Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

                                                                                              Control1..1
                                                                                              TypeReference(Patient, RelatedPerson)
                                                                                              Is Modifierfalse
                                                                                              Must Supportfalse
                                                                                              Summarytrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              488. Patient.link.type
                                                                                              Definition

                                                                                              The type of link between this patient resource and another patient resource.

                                                                                              Shortreplaced-by | replaces | refer | seealso
                                                                                              Control1..1
                                                                                              BindingThe codes SHALL be taken from LinkType
                                                                                              (required to http://hl7.org/fhir/ValueSet/link-type|5.0.0)

                                                                                              The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

                                                                                              Typecode
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supportfalse
                                                                                              Summarytrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))