Moderne Patient:innenabrechnung und Datenkommunikation on FHIR (MOPED)
0.1.0 - ci-build

Moderne Patient:innenabrechnung und Datenkommunikation on FHIR (MOPED) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: MOPEDPatientBund - Detailed Descriptions

Draft as of 2024-11-21

Definitions for the MOPEDPatientBund resource profile.

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

0. Patient
2. Patient.extension:PatientReligion
Slice NamePatientReligion
Control0..0
4. Patient.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0
6. Patient.identifier:socialSecurityNumber
Slice NamesocialSecurityNumber
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0
8. Patient.identifier:bPK
Slice NamebPK
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0
10. Patient.identifier:localPatientId
Slice NamelocalPatientId
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..0
12. Patient.name
14. Patient.name.extension
Control1..?
16. Patient.name.extension:data-absent-reason
Slice Namedata-absent-reason
Control1..1
TypeExtension(Data Absent Reason) (Extension Type: code)
18. Patient.name.extension:data-absent-reason.value[x]
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Pattern Valuemasked
20. Patient.telecom
Control0..0
22. Patient.birthDate
Control0..0
LOINC Code
24. Patient.address
26. Patient.address.text
Control0..0
28. Patient.address.line
Control0..0
30. Patient.address.city
Control0..0

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: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())
8. 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())
10. 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 areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 12. 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
    14. 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] NoteSeeChoice of Data Typesfor 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()))
    16. 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())
    18. 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 areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 20. 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
      22. 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] NoteSeeChoice of Data Typesfor 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()))
      24. 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
      26. 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()))
      28. 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://build.fhir.org/ig/HL7Austria/HL7-AT-FHIR-Core-R5/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..0
      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())
      30. Patient.extension:birthPlace
      Slice NamebirthPlace
      Definition

      The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.

      ShortPlace of Birth for patient
      Control0..1
      TypeExtension(Patient Birth Place) (Extension Type: Address)
      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())
      32. Patient.extension:birthPlace.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. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 34. Patient.extension:birthPlace.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-birthPlace
        36. Patient.extension:birthPlace.value[x]
        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.


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

        ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)Value of extension
        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).

        Control10..1
        This element is affected by the following invariants: ext-1
        TypeAddress(HL7® AT Core Address Profile), date, Meta, 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, 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] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        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()))
        38. 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())
        40. 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..0*
        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 areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ type.coding.code
        • 42. 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..0*
          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()))
          46. 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..0*
          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()))
          50. 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..0*
          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()))
          54. 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()))
          56. 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()))
          58. Patient.name.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.

          Control10..*
          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 areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 60. Patient.name.extension:data-absent-reason
            Slice Namedata-absent-reason
            Definition

            Provides a reason why the expected value or elements in the element that is extended are missing.

            Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
            Control1..1
            TypeExtension(Data Absent Reason) (Extension Type: code)
            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())
            62. Patient.name.extension:data-absent-reason.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.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 64. Patient.name.extension:data-absent-reason.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/data-absent-reason
              66. Patient.name.extension:data-absent-reason.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
              BindingThe codes SHALL be taken from For codes, see DataAbsentReason
              (required to http://hl7.org/fhir/ValueSet/data-absent-reason)
              Typecode, 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, CodeableConcept, ParameterDefinition, dateTime, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Pattern Valuemasked
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              68. 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()))
              70. 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..0*
              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()))
              73. 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()))
              75. 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())
              77. 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..01
              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
              79. 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] NoteSeeChoice of Data Typesfor 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 areUnordered and Closed, and can be differentiated using the following discriminators:
              • type @ $this
              • 81. 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] NoteSeeChoice of Data Typesfor 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()))
                83. 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] NoteSeeChoice of Data Typesfor 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()))
                85. 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] NoteSeeChoice of Data Typesfor 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 areUnordered and Closed, and can be differentiated using the following discriminators:
                • type @ $this
                • 87. 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] NoteSeeChoice of Data Typesfor 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()))
                  89. 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] NoteSeeChoice of Data Typesfor 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()))
                  91. 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()))
                  93. 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())
                  95. 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()))
                  97. 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 areUnordered 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 areUnordered 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 areUnordered 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] NoteSeeChoice of Data Typesfor 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 areUnordered 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] NoteSeeChoice of Data Typesfor 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://build.fhir.org/ig/HL7Austria/HL7-AT-FHIR-Core-R5/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..0
                          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.extension:birthPlace
                          Slice NamebirthPlace
                          Definition

                          The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.

                          ShortPlace of Birth for patient
                          Control0..1
                          TypeExtension(Patient Birth Place) (Extension Type: Address)
                          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())
                          50. Patient.extension:birthPlace.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
                          52. Patient.extension:birthPlace.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. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 54. Patient.extension:birthPlace.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-birthPlace
                            56. Patient.extension:birthPlace.value[x]
                            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).

                            Control1..1
                            TypeAddress(HL7® AT Core Address Profile)
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifierfalse
                            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()))
                            58. 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())
                            60. 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..0
                            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 areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ type.coding.code
                            • 62. 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..0
                              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()))
                              89. 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..0
                              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()))
                              116. 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..0
                              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()))
                              137. 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()))
                              139. 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()))
                              141. 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
                              143. Patient.name.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control1..*
                              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.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 145. Patient.name.extension:data-absent-reason
                                Slice Namedata-absent-reason
                                Definition

                                Provides a reason why the expected value or elements in the element that is extended are missing.

                                Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
                                Control1..1
                                TypeExtension(Data Absent Reason) (Extension Type: code)
                                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())
                                147. Patient.name.extension:data-absent-reason.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
                                149. Patient.name.extension:data-absent-reason.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.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 151. Patient.name.extension:data-absent-reason.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/data-absent-reason
                                  153. Patient.name.extension:data-absent-reason.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
                                  BindingThe codes SHALL be taken from DataAbsentReason
                                  (required to http://hl7.org/fhir/ValueSet/data-absent-reason)
                                  Typecode
                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summaryfalse
                                  Pattern Valuemasked
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  155. 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()))
                                  157. 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()))
                                  159. 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()))
                                  161. 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()))
                                  163. 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()))
                                  165. 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()))
                                  167. 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()))
                                  169. 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..0
                                  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()))
                                  178. 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()))
                                  180. 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
                                  182. 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 areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 184. 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())
                                    186. 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
                                    188. 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..0
                                    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
                                    190. 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] NoteSeeChoice of Data Typesfor 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 areUnordered and Closed, and can be differentiated using the following discriminators:
                                    • type @ $this
                                    • 192. 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] NoteSeeChoice of Data Typesfor 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()))
                                      194. 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] NoteSeeChoice of Data Typesfor 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()))
                                      196. 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()))
                                      198. 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
                                      200. 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 areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 202. Patient.address.extension:municipalityCode
                                        Slice NamemunicipalityCode
                                        Definition

                                        HL7® Austria FHIR® Core Extension for the municipality code part of the Austrian address

                                        ShortAddress Municipality Code
                                        Control0..1
                                        TypeExtension(Address Municipality Code) (Extension Type: string)
                                        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())
                                        204. 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()))
                                        206. 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()))
                                        208. 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..0
                                        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()))
                                        210. 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..0
                                        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()))
                                        219. Patient.address.city
                                        Definition

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

                                        ShortName of city, town etc.
                                        Control0..0
                                        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()))
                                        221. 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()))
                                        223. 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()))
                                        225. 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()))
                                        227. 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()))
                                        229. 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()))
                                        231. 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()))
                                        233. 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
                                        235. 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 areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 237. 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()))
                                          239. 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
                                          241. 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 areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 243. 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()))
                                            245. 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 version Id, 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()))
                                            247. 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()))
                                            249. 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()))
                                            251. 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()))
                                            253. 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()))
                                            255. 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] NoteSeeChoice of Data Typesfor 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 areUnordered and Closed, and can be differentiated using the following discriminators:
                                            • type @ $this
                                            • 257. 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] NoteSeeChoice of Data Typesfor 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()))
                                              259. 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] NoteSeeChoice of Data Typesfor 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()))
                                              261. 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()))
                                              263. 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())
                                              265. 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
                                              267. 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())
                                              269. 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())
                                              271. 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()))
                                              273. 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
                                              275. 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 areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 277. 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()))
                                                279. 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
                                                281. 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 areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 283. 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()))
                                                  285. 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 version Id, 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()))
                                                  287. 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()))
                                                  289. 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()))
                                                  291. 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()))
                                                  293. 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()))
                                                  295. 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()))
                                                  297. 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
                                                  299. 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 areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 301. 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()))
                                                    303. 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()))
                                                    305. 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()))
                                                    307. 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()))
                                                    309. 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()))
                                                    311. 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()))
                                                    313. 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()))
                                                    315. 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()))
                                                    317. 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
                                                    319. 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 areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 321. 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()))
                                                      323. 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()))
                                                      325. 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()))
                                                      327. 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()))
                                                      329. 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()))
                                                      331. 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()))
                                                      333. 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
                                                      335. 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 areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 337. Patient.contact.address.extension:municipalityCode
                                                        Slice NamemunicipalityCode
                                                        Definition

                                                        HL7® Austria FHIR® Core Extension for the municipality code part of the Austrian address

                                                        ShortAddress Municipality Code
                                                        Control0..1
                                                        TypeExtension(Address Municipality Code) (Extension Type: string)
                                                        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())
                                                        339. 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()))
                                                        341. 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()))
                                                        343. 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()))
                                                        345. 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()))
                                                        347. 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
                                                        349. 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 areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 351. 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())
                                                          353. 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())
                                                          355. 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())
                                                          357. 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())
                                                          359. 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 Length:1048576
                                                          361. 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()))
                                                          363. 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()))
                                                          365. 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()))
                                                          367. 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()))
                                                          369. 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()))
                                                          371. 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()))
                                                          373. 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()))
                                                          375. 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
                                                          377. 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 areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 379. 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())
                                                            381. 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
                                                            383. 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()))
                                                            385. 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()))
                                                            387. 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()))
                                                            389. 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
                                                            391. 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())
                                                            393. 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())
                                                            395. 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()))
                                                            397. 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()))
                                                            399. 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()))
                                                            401. 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()))
                                                            403. 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()))
                                                            405. 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
                                                            407. 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())
                                                            409. 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())
                                                            411. 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()))
                                                            413. 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()))