Central Cancer Registry Reporting Content IG
2.0.0-ballot - STU 2 -Ballot United States of America flag

Central Cancer Registry Reporting Content IG, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-central-cancer-registry-reporting-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CentralCancerRegistryReportingPatient - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the central-cancer-registry-reporting-patient resource profile.

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

0. Patient
Definition

This profile is based on the Patient resource and establishes the core elements, extensions, vocabularies and value sets for representing a patient for central cancer registry reporting.

ShortCentral Cancer Registry Reporting Patient
2. Patient.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
Must Supporttrue
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.system
  • value @ type.coding.code
  • 4. Patient.identifier:MedicareIdentifier
    Slice NameMedicareIdentifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    Must Supporttrue
    6. Patient.identifier:MedicareIdentifier.type
    Control1..1
    TypeCodeableConcept
    Must Supporttrue
    8. Patient.identifier:MedicareIdentifier.type.coding
    Control1..1
    Must Supporttrue
    10. Patient.identifier:MedicareIdentifier.type.coding.system
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
    12. Patient.identifier:MedicareIdentifier.type.coding.code
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Fixed ValueMC
    14. Patient.identifier:MedicaidIdentifier
    Slice NameMedicaidIdentifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    Must Supporttrue
    16. Patient.identifier:MedicaidIdentifier.type
    Control1..1
    TypeCodeableConcept
    Must Supporttrue
    18. Patient.identifier:MedicaidIdentifier.type.coding
    Control1..1
    Must Supporttrue
    20. Patient.identifier:MedicaidIdentifier.type.coding.system
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
    22. Patient.identifier:MedicaidIdentifier.type.coding.code
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Fixed ValueMA
    24. Patient.identifier:MR
    Slice NameMR
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    Must Supporttrue
    26. Patient.identifier:MR.type
    Control1..1
    TypeCodeableConcept
    Must Supporttrue
    28. Patient.identifier:MR.type.coding
    Control1..1
    Must Supporttrue
    30. Patient.identifier:MR.type.coding.system
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
    32. Patient.identifier:MR.type.coding.code
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Fixed ValueMR
    34. Patient.identifier:SSNIdentifier
    Slice NameSSNIdentifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    Must Supporttrue
    36. Patient.identifier:SSNIdentifier.type
    Control1..1
    TypeCodeableConcept
    Must Supporttrue
    38. Patient.identifier:SSNIdentifier.type.coding
    Control1..1
    Must Supporttrue
    40. Patient.identifier:SSNIdentifier.type.coding.system
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
    42. Patient.identifier:SSNIdentifier.type.coding.code
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Fixed ValueSS
    44. Patient.name
    Control1..*
    Must Supporttrue
    46. Patient.name.family
    Control1..1
    Must Supporttrue
    48. Patient.name.family.extension:data-absent-reason
    Slice Namedata-absent-reason
    Control0..1
    TypeExtension(Data Absent Reason) (Extension Type: code)
    Must Supporttrue
    50. Patient.name.given
    Control1..*
    Must Supporttrue
    52. Patient.name.given.extension:data-absent-reason
    Slice Namedata-absent-reason
    Control0..1
    TypeExtension(Data Absent Reason) (Extension Type: code)
    Must Supporttrue
    54. Patient.address
    Control1..*
    Must Supporttrue
    56. Patient.address.state
    Control1..1
    Must Supporttrue
    58. Patient.address.state.extension:data-absent-reason
    Slice Namedata-absent-reason
    Control0..1
    TypeExtension(Data Absent Reason) (Extension Type: code)
    Must Supporttrue
    60. Patient.maritalStatus
    Control0..1
    Must Supporttrue
    62. Patient.generalPractitioner
    Control0..1
    TypeReference(US Core Practitioner Profile)
    Must Supporttrue
    64. Patient.managingOrganization
    Control0..1
    TypeReference(Central Cancer Registry Reporting Organization)
    Must Supporttrue

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

    0. Patient
    Definition

    This profile is based on the Patient resource and establishes the core elements, extensions, vocabularies and value sets for representing a patient for central cancer registry reporting.


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

    ShortCentral Cancer Registry Reporting PatientInformation about an individual or animal receiving health care services
    Comments

    -

    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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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())
    us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. ((name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').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 it's 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 it's meaning or interpretation
    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()))
    4. Patient.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    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.

    Control20..*
    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. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. Patient.extension:race
      Slice Namerace
      Definition

      Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:

      • American Indian or Alaska Native
      • Asian
      • Black or African American
      • Native Hawaiian or Other Pacific Islander
      • White.
      ShortUS Core Race Extension
      Control1..1
      This element is affected by the following invariants: ele-1
      TypeExtension(US Core Race Extension) (Complex Extension)
      Is Modifierfalse
      Must Supporttrue
      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:race.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      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.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 10. Patient.extension:race.extension:ombCategory
        Slice NameombCategory
        Definition

        The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.

        ShortAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|WhiteAdditional content defined by implementations
        Control0..5*
        TypeExtension
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        12. Patient.extension:race.extension:ombCategory.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 ValueombCategory
        14. Patient.extension:race.extension:ombCategory.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
        BindingThe codes SHALL be taken from For codes, see OMB Race Categories
        (required to http://hl7.org/fhir/us/core/ValueSet/omb-race-category)

        The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.

        TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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:race.extension:detailed
        Slice Namedetailed
        Definition

        The 900+ CDC race codes that are grouped under one of the 5 OMB race category codes:.

        ShortExtended race codesAdditional content defined by implementations
        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())
        18. Patient.extension:race.extension:detailed.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 Valuedetailed
        20. Patient.extension:race.extension:detailed.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
        BindingThe codes SHALL be taken from For codes, see Detailed Race
        (required to http://hl7.org/fhir/us/core/ValueSet/detailed-race)
        TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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()))
        22. Patient.extension:race.extension:text
        Slice Nametext
        Definition

        Plain text representation of the race concept(s).

        ShortRace TextAdditional content defined by implementations
        Control10..1*
        TypeExtension
        Is Modifierfalse
        Must Supporttrue
        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:race.extension:text.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 Valuetext
        26. Patient.extension:race.extension:text.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
        Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. Patient.extension:race.extension:dataAbsentReason
        Slice NamedataAbsentReason
        Definition

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

        ShortFor masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked"
        Control0..1
        TypeExtension(Data Absent Reason) (Extension Type: code)
        Is Modifierfalse
        Must Supporttrue
        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())
        30. Patient.extension:race.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        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
        • 32. Patient.extension:race.extension:dataAbsentReason.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
          34. Patient.extension:race.extension:dataAbsentReason.value[x]
          Definition

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


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

          ShortValue of extension
          Control10..1
          BindingThe codes SHALL be taken from For codes, see DataAbsentReason
          (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

          Used to specify why the normally expected content of the data element is missing.

          Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
          Must Supporttrue
          Summaryfalse
          Fixed Valuemasked
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          36. Patient.extension:race.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/us/core/StructureDefinition/us-core-race
          38. Patient.extension:race.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
          TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, 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()))
          40. Patient.extension:ethnicity
          Slice Nameethnicity
          Definition

          Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the CDC ethnicity and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.

          ShortUS Core ethnicity Extension
          Control1..1
          This element is affected by the following invariants: ele-1
          TypeExtension(US Core Ethnicity Extension) (Complex Extension)
          Is Modifierfalse
          Must Supporttrue
          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())
          42. Patient.extension:ethnicity.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          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.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 44. Patient.extension:ethnicity.extension:ombCategory
            Slice NameombCategory
            Definition

            The 2 ethnicity category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.

            ShortHispanic or Latino|Not Hispanic or LatinoAdditional content defined by implementations
            Control0..1*
            TypeExtension
            Is Modifierfalse
            Must Supporttrue
            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())
            46. Patient.extension:ethnicity.extension:ombCategory.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 ValueombCategory
            48. Patient.extension:ethnicity.extension:ombCategory.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
            BindingThe codes SHALL be taken from For codes, see OMB Ethnicity Categories
            (required to http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category)
            TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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()))
            50. Patient.extension:ethnicity.extension:detailed
            Slice Namedetailed
            Definition

            The 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes.

            ShortExtended ethnicity codesAdditional content defined by implementations
            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())
            52. Patient.extension:ethnicity.extension:detailed.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 Valuedetailed
            54. Patient.extension:ethnicity.extension:detailed.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
            BindingThe codes SHALL be taken from For codes, see Detailed ethnicity
            (required to http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity)
            TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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()))
            56. Patient.extension:ethnicity.extension:text
            Slice Nametext
            Definition

            Plain text representation of the ethnicity concept(s).

            Shortethnicity TextAdditional content defined by implementations
            Control10..1*
            TypeExtension
            Is Modifierfalse
            Must Supporttrue
            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())
            58. Patient.extension:ethnicity.extension:text.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 Valuetext
            60. Patient.extension:ethnicity.extension:text.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
            Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            62. Patient.extension:ethnicity.extension:dataAbsentReason
            Slice NamedataAbsentReason
            Definition

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

            ShortFor masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked"
            Control0..1
            TypeExtension(Data Absent Reason) (Extension Type: code)
            Is Modifierfalse
            Must Supporttrue
            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())
            64. Patient.extension:ethnicity.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            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
            • 66. Patient.extension:ethnicity.extension:dataAbsentReason.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
              68. Patient.extension:ethnicity.extension:dataAbsentReason.value[x]
              Definition

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


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

              ShortValue of extension
              Control10..1
              BindingThe codes SHALL be taken from For codes, see DataAbsentReason
              (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

              Used to specify why the normally expected content of the data element is missing.

              Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
              Must Supporttrue
              Summaryfalse
              Fixed Valuemasked
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              70. Patient.extension:ethnicity.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/us/core/StructureDefinition/us-core-ethnicity
              72. Patient.extension:ethnicity.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
              TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, 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()))
              74. Patient.extension:birthsex
              Slice Namebirthsex
              Definition

              A code classifying the person's sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC).

              ShortExtension
              Comments

              The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex.

              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(US Core Birth Sex Extension) (Extension Type: code)
              Is Modifierfalse
              Must Supporttrue
              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())
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              76. Patient.extension:genderIdentity
              Slice NamegenderIdentity
              Definition

              An Extension

              ShortExtension
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(US Core Gender Identity Extension) (Extension Type: CodeableConcept)
              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())
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              78. 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 Supporttrue
              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())
              80. Patient.extension:individualGenderIdentity
              Slice NameindividualGenderIdentity
              Definition

              An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.

              ShortThe individual's gender identity
              Comments

              This represents an individual’s identity, ascertained by asking them what that identity is.

              Control0..*
              TypeExtension(Individual Gender Identity) (Complex Extension)
              Is Modifierfalse
              Must Supporttrue
              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())
              82. Patient.extension:tribalAffiliation
              Slice NametribalAffiliation
              Definition

              Affiliated tribe name and whether or not the patient is an enrolled member

              ShortTribal affiliation and membership of the patient
              Control0..*
              TypeExtension(US Public Health Tribal Affiliation Extension) (Complex Extension)
              Is Modifierfalse
              Must Supporttrue
              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())
              84. 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 manageable, 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
              Summaryfalse
              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())
              86. Patient.identifier
              Definition

              An identifier for this patient.

              ShortAn identifier for this patient
              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control10..*
              TypeIdentifier
              Is Modifierfalse
              Must Supporttrue
              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.system
              • value @ type.coding.code
              • 88. Patient.identifier.extension:dataAbsentReason
                Slice NamedataAbsentReason
                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
                Control0..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())
                90. Patient.identifier.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                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.identifier.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 92. Patient.identifier.extension:dataAbsentReason.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
                  94. Patient.identifier.extension:dataAbsentReason.value[x]
                  Definition

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


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

                  ShortValue of extension
                  Control10..1
                  BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                  (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                  Used to specify why the normally expected content of the data element is missing.

                  Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                  Must Supporttrue
                  Summaryfalse
                  Fixed Valuemasked
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  96. Patient.identifier.use
                  Definition

                  The purpose of this identifier.

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

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

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

                  Identifies the purpose for this identifier, if known .

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

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

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

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

                  ShortThe namespace for the identifier value
                  Comments

                  Identifier.system is always case sensitive.

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

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

                  ExampleGeneral: http://www.acme.com/identifiers/patient
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  100. Patient.identifier.value
                  Definition

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

                  ShortThe value that is unique within the system.
                  Comments

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

                  Control10..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Summarytrue
                  ExampleGeneral: 123456
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  102. Patient.identifier:MedicareIdentifier
                  Slice NameMedicareIdentifier
                  Definition

                  An identifier for this patient.

                  ShortAn identifier for this patient
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..1*
                  TypeIdentifier
                  Is Modifierfalse
                  Must Supporttrue
                  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()))
                  104. Patient.identifier:MedicareIdentifier.extension:dataAbsentReason
                  Slice NamedataAbsentReason
                  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
                  Control0..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())
                  106. Patient.identifier:MedicareIdentifier.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  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.identifier.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 108. Patient.identifier:MedicareIdentifier.extension:dataAbsentReason.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
                    110. Patient.identifier:MedicareIdentifier.extension:dataAbsentReason.value[x]
                    Definition

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


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

                    ShortValue of extension
                    Control10..1
                    BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                    (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                    Used to specify why the normally expected content of the data element is missing.

                    Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                    Must Supporttrue
                    Summaryfalse
                    Fixed Valuemasked
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    112. Patient.identifier:MedicareIdentifier.use
                    Definition

                    The purpose of this identifier.

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

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

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

                    Identifies the purpose for this identifier, if known .

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

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

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

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

                    ShortDescription of identifier
                    Comments

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

                    Control10..1
                    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
                    (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

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

                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Requirements

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

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

                    A reference to a code defined by a terminology system.

                    ShortCode defined by a terminology system
                    Comments

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

                    Control10..1*
                    TypeCoding
                    Is Modifierfalse
                    Must Supporttrue
                    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()))
                    118. Patient.identifier:MedicareIdentifier.type.coding.system
                    Definition

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

                    ShortIdentity of the terminology system
                    Comments

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

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

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

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

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

                    ShortSymbol in syntax defined by the system
                    Control10..1
                    Typecode
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    Need to refer to a particular code in the system.

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

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

                    ShortThe namespace for the identifier value
                    Comments

                    Identifier.system is always case sensitive.

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

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

                    ExampleGeneral: http://www.acme.com/identifiers/patient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    124. Patient.identifier:MedicareIdentifier.value
                    Definition

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

                    ShortThe value that is unique within the system.
                    Comments

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

                    Control10..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    ExampleGeneral: 123456
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    126. Patient.identifier:MedicaidIdentifier
                    Slice NameMedicaidIdentifier
                    Definition

                    An identifier for this patient.

                    ShortAn identifier for this patient
                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..1*
                    TypeIdentifier
                    Is Modifierfalse
                    Must Supporttrue
                    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()))
                    128. Patient.identifier:MedicaidIdentifier.extension:dataAbsentReason
                    Slice NamedataAbsentReason
                    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
                    Control0..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())
                    130. Patient.identifier:MedicaidIdentifier.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    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.identifier.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 132. Patient.identifier:MedicaidIdentifier.extension:dataAbsentReason.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
                      134. Patient.identifier:MedicaidIdentifier.extension:dataAbsentReason.value[x]
                      Definition

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


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

                      ShortValue of extension
                      Control10..1
                      BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                      (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                      Used to specify why the normally expected content of the data element is missing.

                      Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                      Must Supporttrue
                      Summaryfalse
                      Fixed Valuemasked
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      136. Patient.identifier:MedicaidIdentifier.use
                      Definition

                      The purpose of this identifier.

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

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

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

                      Identifies the purpose for this identifier, if known .

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

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

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

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

                      ShortDescription of identifier
                      Comments

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

                      Control10..1
                      BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
                      (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

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

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Requirements

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

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

                      A reference to a code defined by a terminology system.

                      ShortCode defined by a terminology system
                      Comments

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

                      Control10..1*
                      TypeCoding
                      Is Modifierfalse
                      Must Supporttrue
                      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()))
                      142. Patient.identifier:MedicaidIdentifier.type.coding.system
                      Definition

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

                      ShortIdentity of the terminology system
                      Comments

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

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

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

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

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

                      ShortSymbol in syntax defined by the system
                      Control10..1
                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Need to refer to a particular code in the system.

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

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

                      ShortThe namespace for the identifier value
                      Comments

                      Identifier.system is always case sensitive.

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

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

                      ExampleGeneral: http://www.acme.com/identifiers/patient
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      148. Patient.identifier:MedicaidIdentifier.value
                      Definition

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

                      ShortThe value that is unique within the system.
                      Comments

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

                      Control10..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summarytrue
                      ExampleGeneral: 123456
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      150. Patient.identifier:MR
                      Slice NameMR
                      Definition

                      An identifier for this patient.

                      ShortAn identifier for this patient
                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control0..*
                      TypeIdentifier
                      Is Modifierfalse
                      Must Supporttrue
                      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()))
                      152. Patient.identifier:MR.extension:dataAbsentReason
                      Slice NamedataAbsentReason
                      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
                      Control0..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())
                      154. Patient.identifier:MR.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      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.identifier.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 156. Patient.identifier:MR.extension:dataAbsentReason.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
                        158. Patient.identifier:MR.extension:dataAbsentReason.value[x]
                        Definition

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


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

                        ShortValue of extension
                        Control10..1
                        BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                        (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                        Used to specify why the normally expected content of the data element is missing.

                        Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                        Must Supporttrue
                        Summaryfalse
                        Fixed Valuemasked
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        160. Patient.identifier:MR.use
                        Definition

                        The purpose of this identifier.

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

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

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

                        Identifies the purpose for this identifier, if known .

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

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

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

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

                        ShortDescription of identifier
                        Comments

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

                        Control10..1
                        BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
                        (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

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

                        TypeCodeableConcept
                        Is Modifierfalse
                        Must Supporttrue
                        Summarytrue
                        Requirements

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

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

                        A reference to a code defined by a terminology system.

                        ShortCode defined by a terminology system
                        Comments

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

                        Control10..1*
                        TypeCoding
                        Is Modifierfalse
                        Must Supporttrue
                        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()))
                        166. Patient.identifier:MR.type.coding.system
                        Definition

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

                        ShortIdentity of the terminology system
                        Comments

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

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

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

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

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

                        ShortSymbol in syntax defined by the system
                        Control10..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Need to refer to a particular code in the system.

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

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

                        ShortThe namespace for the identifier value
                        Comments

                        Identifier.system is always case sensitive.

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

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

                        ExampleGeneral: http://www.acme.com/identifiers/patient
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        172. Patient.identifier:MR.value
                        Definition

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

                        ShortThe value that is unique within the system.
                        Comments

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

                        Control10..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        ExampleGeneral: 123456
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        174. Patient.identifier:SSNIdentifier
                        Slice NameSSNIdentifier
                        Definition

                        An identifier for this patient.

                        ShortAn identifier for this patient
                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..1*
                        TypeIdentifier
                        Is Modifierfalse
                        Must Supporttrue
                        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()))
                        176. Patient.identifier:SSNIdentifier.extension:dataAbsentReason
                        Slice NamedataAbsentReason
                        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
                        Control0..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())
                        178. Patient.identifier:SSNIdentifier.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        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.identifier.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 180. Patient.identifier:SSNIdentifier.extension:dataAbsentReason.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
                          182. Patient.identifier:SSNIdentifier.extension:dataAbsentReason.value[x]
                          Definition

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


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

                          ShortValue of extension
                          Control10..1
                          BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                          (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                          Used to specify why the normally expected content of the data element is missing.

                          Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                          Must Supporttrue
                          Summaryfalse
                          Fixed Valuemasked
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          184. Patient.identifier:SSNIdentifier.use
                          Definition

                          The purpose of this identifier.

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

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

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

                          Identifies the purpose for this identifier, if known .

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

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

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

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

                          ShortDescription of identifier
                          Comments

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

                          Control10..1
                          BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
                          (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

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

                          TypeCodeableConcept
                          Is Modifierfalse
                          Must Supporttrue
                          Summarytrue
                          Requirements

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

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

                          A reference to a code defined by a terminology system.

                          ShortCode defined by a terminology system
                          Comments

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

                          Control10..1*
                          TypeCoding
                          Is Modifierfalse
                          Must Supporttrue
                          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()))
                          190. Patient.identifier:SSNIdentifier.type.coding.system
                          Definition

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

                          ShortIdentity of the terminology system
                          Comments

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

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

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

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

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

                          ShortSymbol in syntax defined by the system
                          Control10..1
                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Requirements

                          Need to refer to a particular code in the system.

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

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

                          ShortThe namespace for the identifier value
                          Comments

                          Identifier.system is always case sensitive.

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

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

                          ExampleGeneral: http://www.acme.com/identifiers/patient
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          196. Patient.identifier:SSNIdentifier.value
                          Definition

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

                          ShortThe value that is unique within the system.
                          Comments

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

                          Control10..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          ExampleGeneral: 123456
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          198. 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
                          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()))
                          200. 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.

                          Control10..*
                          TypeHumanName
                          Is Modifierfalse
                          Must Supporttrue
                          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()))
                          202. Patient.name.extension:dataAbsentReason
                          Slice NamedataAbsentReason
                          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
                          Control0..1
                          TypeExtension(Data Absent Reason) (Extension Type: code)
                          Is Modifierfalse
                          Must Supporttrue
                          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.name.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          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
                          • 206. Patient.name.extension:dataAbsentReason.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
                            208. Patient.name.extension:dataAbsentReason.value[x]
                            Definition

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


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

                            ShortValue of extension
                            Control10..1
                            BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                            (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                            Used to specify why the normally expected content of the data element is missing.

                            Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                            Must Supporttrue
                            Summaryfalse
                            Fixed Valuemasked
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            210. 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|4.0.1
                            (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                            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()))
                            212. 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).

                            Control10..1
                            This element is affected by the following invariants: us-core-6
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Alternate Namessurname
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            214. Patient.name.family.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
                            Control0..1
                            TypeExtension(Data Absent Reason) (Extension Type: code)
                            Is Modifierfalse
                            Must Supporttrue
                            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())
                            ele-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())
                            216. 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.

                            Control10..*
                            This element is affected by the following invariants: us-core-6
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Alternate Namesfirst name, middle name
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            218. Patient.name.given.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
                            Control0..1
                            TypeExtension(Data Absent Reason) (Extension Type: code)
                            Is Modifierfalse
                            Must Supporttrue
                            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())
                            ele-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())
                            220. 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).

                            Control10..*
                            TypeContactPoint
                            Is Modifierfalse
                            Must Supporttrue
                            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()))
                            SlicingThis element introduces a set of slices on Patient.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ system
                            • 222. Patient.telecom.extension:dataAbsentReason
                              Slice NamedataAbsentReason
                              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
                              Control0..1
                              TypeExtension(Data Absent Reason) (Extension Type: code)
                              Is Modifierfalse
                              Must Supporttrue
                              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())
                              224. Patient.telecom.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                              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.telecom.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 226. Patient.telecom.extension:dataAbsentReason.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
                                228. Patient.telecom.extension:dataAbsentReason.value[x]
                                Definition

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


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

                                ShortValue of extension
                                Control10..1
                                BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                                (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                Used to specify why the normally expected content of the data element is missing.

                                Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                                Must Supporttrue
                                Summaryfalse
                                Fixed Valuemasked
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                230. Patient.telecom.system
                                Definition

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

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

                                Telecommunications form for contact point.

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

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

                                ShortThe actual contact point details
                                Comments

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

                                Control10..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                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()))
                                234. Patient.telecom.use
                                Definition

                                Identifies the purpose for the contact point.

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

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

                                Control0..1
                                BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
                                (required to http://hl7.org/fhir/ValueSet/contact-point-use)
                                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
                                Must Supporttrue
                                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()))
                                236. Patient.telecom:phone
                                Slice Namephone
                                Definition

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

                                ShortA contact detail for the individual
                                Comments

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

                                Control0..*
                                TypeContactPoint
                                Is Modifierfalse
                                Must Supporttrue
                                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()))
                                238. Patient.telecom:phone.extension:dataAbsentReason
                                Slice NamedataAbsentReason
                                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
                                Control0..1
                                TypeExtension(Data Absent Reason) (Extension Type: code)
                                Is Modifierfalse
                                Must Supporttrue
                                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())
                                240. Patient.telecom:phone.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
                                Control10..1
                                This element is affected by the following invariants: cpt-2
                                BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                                (required to http://hl7.org/fhir/ValueSet/contact-point-system)

                                Telecommunications form for contact point.

                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summarytrue
                                Fixed Valuephone
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                242. Patient.telecom:phone.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.

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

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

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                244. Patient.telecom:phone.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 ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
                                (required to http://hl7.org/fhir/ValueSet/contact-point-use)
                                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
                                Must Supporttrue
                                Summarytrue
                                Requirements

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

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

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

                                ShortA contact detail for the individual
                                Comments

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

                                Control0..*
                                TypeContactPoint
                                Is Modifierfalse
                                Must Supporttrue
                                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()))
                                248. Patient.telecom:email.extension:dataAbsentReason
                                Slice NamedataAbsentReason
                                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
                                Control0..1
                                TypeExtension(Data Absent Reason) (Extension Type: code)
                                Is Modifierfalse
                                Must Supporttrue
                                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())
                                250. Patient.telecom:email.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
                                Control10..1
                                This element is affected by the following invariants: cpt-2
                                BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                                (required to http://hl7.org/fhir/ValueSet/contact-point-system)

                                Telecommunications form for contact point.

                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summarytrue
                                Fixed Valueemail
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                252. Patient.telecom:email.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.

                                Control10..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                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()))
                                254. Patient.telecom:email.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 ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
                                (required to http://hl7.org/fhir/ValueSet/contact-point-use)
                                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
                                Must Supporttrue
                                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()))
                                256. 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|4.0.1
                                (required to http://hl7.org/fhir/ValueSet/administrative-gender)
                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                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()))
                                258. Patient.gender.extension:dataAbsentReason
                                Slice NamedataAbsentReason
                                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
                                Control0..1
                                This element is affected by the following invariants: ele-1
                                TypeExtension(Data Absent Reason) (Extension Type: code)
                                Is Modifierfalse
                                Must Supporttrue
                                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())
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                260. Patient.gender.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                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.gender.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 262. Patient.gender.extension:dataAbsentReason.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
                                  264. Patient.gender.extension:dataAbsentReason.value[x]
                                  Definition

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


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

                                  ShortValue of extension
                                  Control10..1
                                  BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                                  (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                  Used to specify why the normally expected content of the data element is missing.

                                  Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                                  Must Supporttrue
                                  Summaryfalse
                                  Fixed Valuemasked
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  266. Patient.birthDate
                                  Definition

                                  The date of birth for the individual.

                                  ShortThe date of birth for the individual
                                  Comments

                                  At least an estimated year should be provided as a guess if the real DOB 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).

                                  Control10..1
                                  Typedate
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  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
                                  268. Patient.birthDate.extension:dataAbsentReason
                                  Slice NamedataAbsentReason
                                  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
                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(Data Absent Reason) (Extension Type: code)
                                  Is Modifierfalse
                                  Must Supporttrue
                                  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())
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  270. Patient.birthDate.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                  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.birthDate.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 272. Patient.birthDate.extension:dataAbsentReason.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
                                    274. Patient.birthDate.extension:dataAbsentReason.value[x]
                                    Definition

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


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

                                    ShortValue of extension
                                    Control10..1
                                    BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                                    (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                    Used to specify why the normally expected content of the data element is missing.

                                    Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                                    Must Supporttrue
                                    Summaryfalse
                                    Fixed Valuemasked
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    276. Patient.deceased[x]
                                    Definition

                                    Indicates if the individual is deceased or not.

                                    ShortIf patient is deceased, use type dateTime and set to deceased date.Indicates 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.

                                    Control10..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 Supporttrue
                                    Must Support TypesNo must-support rules about the choice of types/profiles
                                    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()))
                                    278. Patient.address
                                    Definition

                                    If the patient is homeless, complete as much address information as possible (city, zip, county, etc.) and use the Characteristics of Home Environment profile in the Social History Section of the eICR Composition to indicate that the patient is homeless.


                                    An address for the individual.

                                    ShortAn address for the individual
                                    Comments

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

                                    Control10..*
                                    TypeAddress
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Summarytrue
                                    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()))
                                    280. Patient.address.extension:dataAbsentReason
                                    Slice NamedataAbsentReason
                                    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
                                    Control0..1
                                    TypeExtension(Data Absent Reason) (Extension Type: code)
                                    Is Modifierfalse
                                    Must Supporttrue
                                    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())
                                    282. Patient.address.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                    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.address.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 284. Patient.address.extension:dataAbsentReason.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
                                      286. Patient.address.extension:dataAbsentReason.value[x]
                                      Definition

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


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

                                      ShortValue of extension
                                      Control10..1
                                      BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                                      (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                      Used to specify why the normally expected content of the data element is missing.

                                      Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                                      Must Supporttrue
                                      Summaryfalse
                                      Fixed Valuemasked
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      288. Patient.address.use
                                      Definition

                                      The purpose of this address.

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

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

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

                                      The use of an address.

                                      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.

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

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

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

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

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

                                      The name of the administrative area (county).

                                      ShortCountyDistrict 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..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Alternate NamesCounty
                                      ExampleGeneral: Madison
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      296. 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)
                                      Control10..1
                                      BindingUnless not suitable, these codes SHALL be taken from For codes, see USPS Two Letter Alphabetic Codes
                                      (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state)

                                      Two Letter USPS alphabetic codes.

                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Alternate NamesProvince, Territory
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      298. Patient.address.state.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
                                      Control0..1
                                      TypeExtension(Data Absent Reason) (Extension Type: code)
                                      Is Modifierfalse
                                      Must Supporttrue
                                      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())
                                      ele-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())
                                      300. Patient.address.postalCode
                                      Definition

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

                                      ShortUS Zip CodesPostal code for area
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supporttrue
                                      Summarytrue
                                      Alternate NamesZip, Zip Code
                                      ExampleGeneral: 9132
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      302. Patient.address.period
                                      Definition

                                      Time period when address was/is in use.

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

                                      Allows addresses to be placed in historical context.

                                      ExampleGeneral: { "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()))
                                      304. 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 Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status
                                      (extensible to http://hl7.org/fhir/ValueSet/marital-status)

                                      The domestic partnership status of a person.

                                      TypeCodeableConcept
                                      Is Modifierfalse
                                      Must Supporttrue
                                      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()))
                                      306. 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 Supporttrue
                                      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())
                                      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())
                                      308. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                      ShortExtensions that cannot be ignored even if unrecognized
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                      Control0..*
                                      TypeExtension
                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                      Summarytrue
                                      Requirements

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

                                      Alternate Namesextensions, user content, modifiers
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      310. Patient.contact.relationship
                                      Definition

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

                                      ShortThe kind of relationship
                                      Control10..1*
                                      BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship
                                      (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 Supporttrue
                                      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()))
                                      312. Patient.contact.name
                                      Definition

                                      A name associated with the contact person.

                                      ShortA name associated with the contact person
                                      Control10..1
                                      TypeHumanName
                                      Is Modifierfalse
                                      Must Supporttrue
                                      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()))
                                      314. Patient.contact.name.extension:dataAbsentReason
                                      Slice NamedataAbsentReason
                                      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
                                      Control0..1
                                      TypeExtension(Data Absent Reason) (Extension Type: code)
                                      Is Modifierfalse
                                      Must Supporttrue
                                      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())
                                      316. Patient.contact.name.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                      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.contact.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 318. Patient.contact.name.extension:dataAbsentReason.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
                                        320. Patient.contact.name.extension:dataAbsentReason.value[x]
                                        Definition

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


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

                                        ShortValue of extension
                                        Control10..1
                                        BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                                        (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                        Used to specify why the normally expected content of the data element is missing.

                                        Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                                        Must Supporttrue
                                        Summaryfalse
                                        Fixed Valuemasked
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        322. 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 NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
                                        (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                        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()))
                                        324. 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.

                                        Control10..*
                                        TypeContactPoint
                                        Is Modifierfalse
                                        Must Supporttrue
                                        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()))
                                        326. Patient.contact.telecom.extension:dataAbsentReason
                                        Slice NamedataAbsentReason
                                        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
                                        Control0..1
                                        TypeExtension(Data Absent Reason) (Extension Type: code)
                                        Is Modifierfalse
                                        Must Supporttrue
                                        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())
                                        328. Patient.contact.telecom.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        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.contact.telecom.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 330. Patient.contact.telecom.extension:dataAbsentReason.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
                                          332. Patient.contact.telecom.extension:dataAbsentReason.value[x]
                                          Definition

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


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

                                          ShortValue of extension
                                          Control10..1
                                          BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                                          (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                          Used to specify why the normally expected content of the data element is missing.

                                          Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                                          Must Supporttrue
                                          Summaryfalse
                                          Fixed Valuemasked
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          334. 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 ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
                                          (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

                                          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()))
                                          336. Patient.contact.address
                                          Definition

                                          Address for the contact person.

                                          ShortAddress for the contact person
                                          Control10..1
                                          TypeAddress
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summaryfalse
                                          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()))
                                          338. Patient.contact.address.extension:dataAbsentReason
                                          Slice NamedataAbsentReason
                                          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
                                          Control0..1
                                          TypeExtension(Data Absent Reason) (Extension Type: code)
                                          Is Modifierfalse
                                          Must Supporttrue
                                          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())
                                          340. Patient.contact.address.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                          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.contact.address.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 342. Patient.contact.address.extension:dataAbsentReason.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
                                            344. Patient.contact.address.extension:dataAbsentReason.value[x]
                                            Definition

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


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

                                            ShortValue of extension
                                            Control10..1
                                            BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                                            (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                            Used to specify why the normally expected content of the data element is missing.

                                            Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                                            Must Supporttrue
                                            Summaryfalse
                                            Fixed Valuemasked
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            346. 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 AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
                                            (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                                            The use of an address.

                                            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.

                                            ExampleGeneral: home
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            348. 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.

                                            Control10..*
                                            TypeBackboneElement
                                            Is Modifierfalse
                                            Must Supporttrue
                                            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()))
                                            350. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                            ShortExtensions that cannot be ignored even if unrecognized
                                            Comments

                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                            Control0..*
                                            TypeExtension
                                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                            Summarytrue
                                            Requirements

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

                                            Alternate Namesextensions, user content, modifiers
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            352. 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-EN" for England 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
                                            BindingUnless not suitable, these codes SHALL be taken from The codes SHOULD be taken from Language codes with language and optionally a region modifierhttp://hl7.org/fhir/ValueSet/languages
                                            (extensible to http://hl7.org/fhir/us/core/ValueSet/simple-language)
                                            TypeCodeableConcept
                                            Is Modifierfalse
                                            Must Supporttrue
                                            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()))
                                            354. Patient.communication.language.extension:dataAbsentReason
                                            Slice NamedataAbsentReason
                                            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
                                            Control0..1
                                            TypeExtension(Data Absent Reason) (Extension Type: code)
                                            Is Modifierfalse
                                            Must Supporttrue
                                            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())
                                            356. Patient.communication.language.extension:dataAbsentReason.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                            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.communication.language.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 358. Patient.communication.language.extension:dataAbsentReason.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
                                              360. Patient.communication.language.extension:dataAbsentReason.value[x]
                                              Definition

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


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

                                              ShortValue of extension
                                              Control10..1
                                              BindingThe codes SHALL be taken from For codes, see DataAbsentReason
                                              (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                              Used to specify why the normally expected content of the data element is missing.

                                              Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                                              Must Supporttrue
                                              Summaryfalse
                                              Fixed Valuemasked
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              362. 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..1*
                                              TypeReference(US Core Practitioner Profile, Organization, Practitioner, PractitionerRole)
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Summaryfalse
                                              Alternate NamescareProvider
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              364. 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(Central Cancer Registry Reporting Organization, Organization)
                                              Is Modifierfalse
                                              Must Supporttrue
                                              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()))
                                              366. Patient.link
                                              Definition

                                              Link to another patient resource that concerns the same actual patient.

                                              ShortLink to another patient resource that concerns the same actual person
                                              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'
                                              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()))
                                              368. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                              ShortExtensions that cannot be ignored even if unrecognized
                                              Comments

                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                              Control0..*
                                              TypeExtension
                                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                              Summarytrue
                                              Requirements

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

                                              Alternate Namesextensions, user content, modifiers
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              370. Patient.link.other
                                              Definition

                                              The other patient resource that the link refers to.

                                              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
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              372. 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|4.0.1
                                              (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

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

                                              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()))

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

                                              0. Patient
                                              Definition

                                              This profile is based on the Patient resource and establishes the core elements, extensions, vocabularies and value sets for representing a patient for central cancer registry reporting.

                                              ShortCentral Cancer Registry Reporting Patient
                                              Comments

                                              -

                                              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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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())
                                              us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. ((name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').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

                                              The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                                              Control0..1
                                              Typeid
                                              Is Modifierfalse
                                              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
                                              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 it's 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 it's meaning or interpretation
                                              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()))
                                              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 SHOULD be taken from CommonLanguages
                                              (preferred to http://hl7.org/fhir/ValueSet/languages)

                                              A human language.

                                              Additional BindingsPurpose
                                              AllLanguagesMax Binding
                                              Typecode
                                              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()))
                                              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 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
                                              TypeNarrative
                                              Is Modifierfalse
                                              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, and nor can they have their own independent transaction scope.

                                              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..*
                                              TypeResource
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesinline resources, anonymous resources, contained resources
                                              14. Patient.extension
                                              Definition

                                              An Extension

                                              ShortExtension
                                              Control2..*
                                              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. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 16. Patient.extension:race
                                                Slice Namerace
                                                Definition

                                                Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:

                                                • American Indian or Alaska Native
                                                • Asian
                                                • Black or African American
                                                • Native Hawaiian or Other Pacific Islander
                                                • White.
                                                ShortUS Core Race Extension
                                                Control1..1
                                                This element is affected by the following invariants: ele-1
                                                TypeExtension(US Core Race Extension) (Complex Extension)
                                                Is Modifierfalse
                                                Must Supporttrue
                                                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:race.id
                                                Definition

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

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                20. Patient.extension:race.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.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 22. Patient.extension:race.extension:ombCategory
                                                  Slice NameombCategory
                                                  Definition

                                                  The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.

                                                  ShortAmerican Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
                                                  Control0..5
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  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:race.extension:ombCategory.id
                                                  Definition

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

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

                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                  ShortAdditional content defined by implementations
                                                  Comments

                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 28. Patient.extension:race.extension:ombCategory.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 ValueombCategory
                                                    30. Patient.extension:race.extension:ombCategory.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
                                                    BindingThe codes SHALL be taken from OMB Race Categories
                                                    (required to http://hl7.org/fhir/us/core/ValueSet/omb-race-category)

                                                    The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.

                                                    TypeCoding
                                                    [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:race.extension:detailed
                                                    Slice Namedetailed
                                                    Definition

                                                    The 900+ CDC race codes that are grouped under one of the 5 OMB race category codes:.

                                                    ShortExtended race codes
                                                    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())
                                                    34. Patient.extension:race.extension:detailed.id
                                                    Definition

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

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

                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                    ShortAdditional content defined by implementations
                                                    Comments

                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Alternate Namesextensions, user content
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 38. Patient.extension:race.extension:detailed.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 Valuedetailed
                                                      40. Patient.extension:race.extension:detailed.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
                                                      BindingThe codes SHALL be taken from Detailed Race
                                                      (required to http://hl7.org/fhir/us/core/ValueSet/detailed-race)
                                                      TypeCoding
                                                      [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:race.extension:text
                                                      Slice Nametext
                                                      Definition

                                                      Plain text representation of the race concept(s).

                                                      ShortRace Text
                                                      Control1..1
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      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())
                                                      44. Patient.extension:race.extension:text.id
                                                      Definition

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

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

                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                      ShortAdditional content defined by implementations
                                                      Comments

                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Alternate Namesextensions, user content
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 48. Patient.extension:race.extension:text.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 Valuetext
                                                        50. Patient.extension:race.extension:text.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
                                                        Typestring
                                                        [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
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        52. Patient.extension:race.extension:dataAbsentReason
                                                        Slice NamedataAbsentReason
                                                        Definition

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

                                                        ShortFor masking purposes, use the data-absent-reason extension and set the required us-core-race extension text to "masked"
                                                        Control0..1
                                                        TypeExtension(Data Absent Reason) (Extension Type: code)
                                                        Is Modifierfalse
                                                        Must Supporttrue
                                                        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())
                                                        54. Patient.extension:race.extension:dataAbsentReason.id
                                                        Definition

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

                                                        ShortUnique id for inter-element referencing
                                                        Control0..1
                                                        Typestring
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        56. Patient.extension:race.extension:dataAbsentReason.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
                                                        • 58. Patient.extension:race.extension:dataAbsentReason.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
                                                          60. Patient.extension:race.extension:dataAbsentReason.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
                                                          BindingThe codes SHALL be taken from DataAbsentReason
                                                          (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                          Used to specify why the normally expected content of the data element is missing.

                                                          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
                                                          Must Supporttrue
                                                          Summaryfalse
                                                          Fixed Valuemasked
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          62. Patient.extension:race.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/us/core/StructureDefinition/us-core-race
                                                          64. Patient.extension:race.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
                                                          TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, 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()))
                                                          66. Patient.extension:ethnicity
                                                          Slice Nameethnicity
                                                          Definition

                                                          Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the CDC ethnicity and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.

                                                          ShortUS Core ethnicity Extension
                                                          Control1..1
                                                          This element is affected by the following invariants: ele-1
                                                          TypeExtension(US Core Ethnicity Extension) (Complex Extension)
                                                          Is Modifierfalse
                                                          Must Supporttrue
                                                          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())
                                                          68. Patient.extension:ethnicity.id
                                                          Definition

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

                                                          ShortUnique id for inter-element referencing
                                                          Control0..1
                                                          Typestring
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          70. Patient.extension:ethnicity.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.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 72. Patient.extension:ethnicity.extension:ombCategory
                                                            Slice NameombCategory
                                                            Definition

                                                            The 2 ethnicity category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.

                                                            ShortHispanic or Latino|Not Hispanic or Latino
                                                            Control0..1
                                                            TypeExtension
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            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())
                                                            74. Patient.extension:ethnicity.extension:ombCategory.id
                                                            Definition

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

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

                                                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                            ShortAdditional content defined by implementations
                                                            Comments

                                                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                            Control0..*
                                                            TypeExtension
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Alternate Namesextensions, user content
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 78. Patient.extension:ethnicity.extension:ombCategory.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 ValueombCategory
                                                              80. Patient.extension:ethnicity.extension:ombCategory.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
                                                              BindingThe codes SHALL be taken from OMB Ethnicity Categories
                                                              (required to http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category)
                                                              TypeCoding
                                                              [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()))
                                                              82. Patient.extension:ethnicity.extension:detailed
                                                              Slice Namedetailed
                                                              Definition

                                                              The 41 CDC ethnicity codes that are grouped under one of the 2 OMB ethnicity category codes.

                                                              ShortExtended ethnicity codes
                                                              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())
                                                              84. Patient.extension:ethnicity.extension:detailed.id
                                                              Definition

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

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

                                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                              ShortAdditional content defined by implementations
                                                              Comments

                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                              Control0..*
                                                              TypeExtension
                                                              Is Modifierfalse
                                                              Summaryfalse
                                                              Alternate Namesextensions, user content
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                              SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 88. Patient.extension:ethnicity.extension:detailed.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 Valuedetailed
                                                                90. Patient.extension:ethnicity.extension:detailed.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
                                                                BindingThe codes SHALL be taken from Detailed ethnicity
                                                                (required to http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity)
                                                                TypeCoding
                                                                [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()))
                                                                92. Patient.extension:ethnicity.extension:text
                                                                Slice Nametext
                                                                Definition

                                                                Plain text representation of the ethnicity concept(s).

                                                                Shortethnicity Text
                                                                Control1..1
                                                                TypeExtension
                                                                Is Modifierfalse
                                                                Must Supporttrue
                                                                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())
                                                                94. Patient.extension:ethnicity.extension:text.id
                                                                Definition

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

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

                                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                ShortAdditional content defined by implementations
                                                                Comments

                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                Control0..*
                                                                TypeExtension
                                                                Is Modifierfalse
                                                                Summaryfalse
                                                                Alternate Namesextensions, user content
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 98. Patient.extension:ethnicity.extension:text.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 Valuetext
                                                                  100. Patient.extension:ethnicity.extension:text.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
                                                                  Typestring
                                                                  [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
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  102. Patient.extension:ethnicity.extension:dataAbsentReason
                                                                  Slice NamedataAbsentReason
                                                                  Definition

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

                                                                  ShortFor masking purposes, use the data-absent-reason extension and set the required us-core-ethnicity extension text to "masked"
                                                                  Control0..1
                                                                  TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  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())
                                                                  104. Patient.extension:ethnicity.extension:dataAbsentReason.id
                                                                  Definition

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

                                                                  ShortUnique id for inter-element referencing
                                                                  Control0..1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  106. Patient.extension:ethnicity.extension:dataAbsentReason.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
                                                                  • 108. Patient.extension:ethnicity.extension:dataAbsentReason.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
                                                                    110. Patient.extension:ethnicity.extension:dataAbsentReason.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
                                                                    BindingThe codes SHALL be taken from DataAbsentReason
                                                                    (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                    Used to specify why the normally expected content of the data element is missing.

                                                                    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
                                                                    Must Supporttrue
                                                                    Summaryfalse
                                                                    Fixed Valuemasked
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    112. Patient.extension:ethnicity.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/us/core/StructureDefinition/us-core-ethnicity
                                                                    114. Patient.extension:ethnicity.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
                                                                    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, 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()))
                                                                    116. Patient.extension:birthsex
                                                                    Slice Namebirthsex
                                                                    Definition

                                                                    A code classifying the person's sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC).

                                                                    ShortExtension
                                                                    Comments

                                                                    The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex.

                                                                    Control0..1
                                                                    This element is affected by the following invariants: ele-1
                                                                    TypeExtension(US Core Birth Sex Extension) (Extension Type: code)
                                                                    Is Modifierfalse
                                                                    Must Supporttrue
                                                                    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())
                                                                    118. Patient.extension:genderIdentity
                                                                    Slice NamegenderIdentity
                                                                    Definition

                                                                    An Extension

                                                                    ShortExtension
                                                                    Control0..1
                                                                    This element is affected by the following invariants: ele-1
                                                                    TypeExtension(US Core Gender Identity Extension) (Extension Type: CodeableConcept)
                                                                    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())
                                                                    120. 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 Supporttrue
                                                                    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())
                                                                    122. Patient.extension:individualGenderIdentity
                                                                    Slice NameindividualGenderIdentity
                                                                    Definition

                                                                    An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.

                                                                    ShortThe individual's gender identity
                                                                    Comments

                                                                    This represents an individual’s identity, ascertained by asking them what that identity is.

                                                                    Control0..*
                                                                    TypeExtension(Individual Gender Identity) (Complex Extension)
                                                                    Is Modifierfalse
                                                                    Must Supporttrue
                                                                    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())
                                                                    124. Patient.extension:tribalAffiliation
                                                                    Slice NametribalAffiliation
                                                                    Definition

                                                                    Affiliated tribe name and whether or not the patient is an enrolled member

                                                                    ShortTribal affiliation and membership of the patient
                                                                    Control0..*
                                                                    TypeExtension(US Public Health Tribal Affiliation Extension) (Complex Extension)
                                                                    Is Modifierfalse
                                                                    Must Supporttrue
                                                                    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())
                                                                    126. 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 manageable, 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
                                                                    Summaryfalse
                                                                    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())
                                                                    128. Patient.identifier
                                                                    Definition

                                                                    An identifier for this patient.

                                                                    ShortAn identifier for this patient
                                                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                    Control1..*
                                                                    TypeIdentifier
                                                                    Is Modifierfalse
                                                                    Must Supporttrue
                                                                    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.system
                                                                    • value @ type.coding.code
                                                                    • 130. Patient.identifier.id
                                                                      Definition

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

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

                                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                      ShortAdditional content defined by implementations
                                                                      Comments

                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                      Control0..*
                                                                      TypeExtension
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Alternate Namesextensions, user content
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 134. Patient.identifier.extension:dataAbsentReason
                                                                        Slice NamedataAbsentReason
                                                                        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
                                                                        Control0..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())
                                                                        136. Patient.identifier.extension:dataAbsentReason.id
                                                                        Definition

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

                                                                        ShortUnique id for inter-element referencing
                                                                        Control0..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                        Summaryfalse
                                                                        138. Patient.identifier.extension:dataAbsentReason.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.identifier.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 140. Patient.identifier.extension:dataAbsentReason.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
                                                                          142. Patient.identifier.extension:dataAbsentReason.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
                                                                          BindingThe codes SHALL be taken from DataAbsentReason
                                                                          (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                          Used to specify why the normally expected content of the data element is missing.

                                                                          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
                                                                          Must Supporttrue
                                                                          Summaryfalse
                                                                          Fixed Valuemasked
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          144. Patient.identifier.use
                                                                          Definition

                                                                          The purpose of this identifier.

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

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

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

                                                                          Identifies the purpose for this identifier, if known .

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

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

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

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

                                                                          ShortDescription of identifier
                                                                          Comments

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

                                                                          Control0..1
                                                                          BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                                          (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

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

                                                                          TypeCodeableConcept
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Requirements

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

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

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

                                                                          ShortThe namespace for the identifier value
                                                                          Comments

                                                                          Identifier.system is always case sensitive.

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

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

                                                                          ExampleGeneral: http://www.acme.com/identifiers/patient
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          150. Patient.identifier.value
                                                                          Definition

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

                                                                          ShortThe value that is unique within the system.
                                                                          Comments

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

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

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

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

                                                                          Organization that issued/manages the identifier.

                                                                          ShortOrganization that issued id (may be just text)
                                                                          Comments

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

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

                                                                          An identifier for this patient.

                                                                          ShortAn identifier for this patient
                                                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                          Control0..1
                                                                          TypeIdentifier
                                                                          Is Modifierfalse
                                                                          Must Supporttrue
                                                                          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()))
                                                                          158. Patient.identifier:MedicareIdentifier.id
                                                                          Definition

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

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

                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                          ShortAdditional content defined by implementations
                                                                          Comments

                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                          Control0..*
                                                                          TypeExtension
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Alternate Namesextensions, user content
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 162. Patient.identifier:MedicareIdentifier.extension:dataAbsentReason
                                                                            Slice NamedataAbsentReason
                                                                            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
                                                                            Control0..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())
                                                                            164. Patient.identifier:MedicareIdentifier.extension:dataAbsentReason.id
                                                                            Definition

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

                                                                            ShortUnique id for inter-element referencing
                                                                            Control0..1
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            166. Patient.identifier:MedicareIdentifier.extension:dataAbsentReason.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.identifier.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 168. Patient.identifier:MedicareIdentifier.extension:dataAbsentReason.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
                                                                              170. Patient.identifier:MedicareIdentifier.extension:dataAbsentReason.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
                                                                              BindingThe codes SHALL be taken from DataAbsentReason
                                                                              (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                              Used to specify why the normally expected content of the data element is missing.

                                                                              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
                                                                              Must Supporttrue
                                                                              Summaryfalse
                                                                              Fixed Valuemasked
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              172. Patient.identifier:MedicareIdentifier.use
                                                                              Definition

                                                                              The purpose of this identifier.

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

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

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

                                                                              Identifies the purpose for this identifier, if known .

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

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

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

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

                                                                              ShortDescription of identifier
                                                                              Comments

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

                                                                              Control1..1
                                                                              BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                                              (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

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

                                                                              TypeCodeableConcept
                                                                              Is Modifierfalse
                                                                              Must Supporttrue
                                                                              Summarytrue
                                                                              Requirements

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

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

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

                                                                              ShortUnique id for inter-element referencing
                                                                              Control0..1
                                                                              Typestring
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              178. Patient.identifier:MedicareIdentifier.type.extension
                                                                              Definition

                                                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                              ShortAdditional content defined by implementations
                                                                              Comments

                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                              Control0..*
                                                                              TypeExtension
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Alternate Namesextensions, user content
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              SlicingThis element introduces a set of slices on Patient.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                              • value @ url
                                                                              • 180. Patient.identifier:MedicareIdentifier.type.coding
                                                                                Definition

                                                                                A reference to a code defined by a terminology system.

                                                                                ShortCode defined by a terminology system
                                                                                Comments

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

                                                                                Control1..1
                                                                                TypeCoding
                                                                                Is Modifierfalse
                                                                                Must Supporttrue
                                                                                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()))
                                                                                182. Patient.identifier:MedicareIdentifier.type.coding.id
                                                                                Definition

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

                                                                                ShortUnique id for inter-element referencing
                                                                                Control0..1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                184. Patient.identifier:MedicareIdentifier.type.coding.extension
                                                                                Definition

                                                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                ShortAdditional content defined by implementations
                                                                                Comments

                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                Control0..*
                                                                                TypeExtension
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Alternate Namesextensions, user content
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                SlicingThis element introduces a set of slices on Patient.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                • value @ url
                                                                                • 186. Patient.identifier:MedicareIdentifier.type.coding.system
                                                                                  Definition

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

                                                                                  ShortIdentity of the terminology system
                                                                                  Comments

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

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

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

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

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

                                                                                  ShortVersion of the system - if relevant
                                                                                  Comments

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

                                                                                  NoteThis is a business 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()))
                                                                                  190. Patient.identifier:MedicareIdentifier.type.coding.code
                                                                                  Definition

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

                                                                                  ShortSymbol in syntax defined by the system
                                                                                  Control1..1
                                                                                  Typecode
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Must Supporttrue
                                                                                  Summarytrue
                                                                                  Requirements

                                                                                  Need to refer to a particular code in the system.

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

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

                                                                                  ShortRepresentation defined by the system
                                                                                  Control0..1
                                                                                  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()))
                                                                                  194. Patient.identifier:MedicareIdentifier.type.coding.userSelected
                                                                                  Definition

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

                                                                                  ShortIf this coding was chosen directly by the user
                                                                                  Comments

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

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

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

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

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

                                                                                  ShortPlain text representation of the concept
                                                                                  Comments

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

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

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

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

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

                                                                                  ShortThe namespace for the identifier value
                                                                                  Comments

                                                                                  Identifier.system is always case sensitive.

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

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

                                                                                  ExampleGeneral: http://www.acme.com/identifiers/patient
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  200. Patient.identifier:MedicareIdentifier.value
                                                                                  Definition

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

                                                                                  ShortThe value that is unique within the system.
                                                                                  Comments

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

                                                                                  Control1..1
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Must Supporttrue
                                                                                  Summarytrue
                                                                                  ExampleGeneral: 123456
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  202. Patient.identifier:MedicareIdentifier.period
                                                                                  Definition

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

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

                                                                                  Organization that issued/manages the identifier.

                                                                                  ShortOrganization that issued id (may be just text)
                                                                                  Comments

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

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

                                                                                  An identifier for this patient.

                                                                                  ShortAn identifier for this patient
                                                                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                  Control0..1
                                                                                  TypeIdentifier
                                                                                  Is Modifierfalse
                                                                                  Must Supporttrue
                                                                                  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()))
                                                                                  208. Patient.identifier:MedicaidIdentifier.id
                                                                                  Definition

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

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

                                                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                  ShortAdditional content defined by implementations
                                                                                  Comments

                                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                  Control0..*
                                                                                  TypeExtension
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Alternate Namesextensions, user content
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                  • value @ url
                                                                                  • 212. Patient.identifier:MedicaidIdentifier.extension:dataAbsentReason
                                                                                    Slice NamedataAbsentReason
                                                                                    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
                                                                                    Control0..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())
                                                                                    214. Patient.identifier:MedicaidIdentifier.extension:dataAbsentReason.id
                                                                                    Definition

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

                                                                                    ShortUnique id for inter-element referencing
                                                                                    Control0..1
                                                                                    Typestring
                                                                                    Is Modifierfalse
                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                    Summaryfalse
                                                                                    216. Patient.identifier:MedicaidIdentifier.extension:dataAbsentReason.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.identifier.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                    • value @ url
                                                                                    • 218. Patient.identifier:MedicaidIdentifier.extension:dataAbsentReason.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
                                                                                      220. Patient.identifier:MedicaidIdentifier.extension:dataAbsentReason.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
                                                                                      BindingThe codes SHALL be taken from DataAbsentReason
                                                                                      (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                                      Used to specify why the normally expected content of the data element is missing.

                                                                                      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
                                                                                      Must Supporttrue
                                                                                      Summaryfalse
                                                                                      Fixed Valuemasked
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      222. Patient.identifier:MedicaidIdentifier.use
                                                                                      Definition

                                                                                      The purpose of this identifier.

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

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

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

                                                                                      Identifies the purpose for this identifier, if known .

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

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

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

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

                                                                                      ShortDescription of identifier
                                                                                      Comments

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

                                                                                      Control1..1
                                                                                      BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                                                      (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

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

                                                                                      TypeCodeableConcept
                                                                                      Is Modifierfalse
                                                                                      Must Supporttrue
                                                                                      Summarytrue
                                                                                      Requirements

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

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

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

                                                                                      ShortUnique id for inter-element referencing
                                                                                      Control0..1
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      228. Patient.identifier:MedicaidIdentifier.type.extension
                                                                                      Definition

                                                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                      ShortAdditional content defined by implementations
                                                                                      Comments

                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                      Control0..*
                                                                                      TypeExtension
                                                                                      Is Modifierfalse
                                                                                      Summaryfalse
                                                                                      Alternate Namesextensions, user content
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                      SlicingThis element introduces a set of slices on Patient.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                      • value @ url
                                                                                      • 230. Patient.identifier:MedicaidIdentifier.type.coding
                                                                                        Definition

                                                                                        A reference to a code defined by a terminology system.

                                                                                        ShortCode defined by a terminology system
                                                                                        Comments

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

                                                                                        Control1..1
                                                                                        TypeCoding
                                                                                        Is Modifierfalse
                                                                                        Must Supporttrue
                                                                                        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()))
                                                                                        232. Patient.identifier:MedicaidIdentifier.type.coding.id
                                                                                        Definition

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

                                                                                        ShortUnique id for inter-element referencing
                                                                                        Control0..1
                                                                                        Typestring
                                                                                        Is Modifierfalse
                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                        Summaryfalse
                                                                                        234. Patient.identifier:MedicaidIdentifier.type.coding.extension
                                                                                        Definition

                                                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                        ShortAdditional content defined by implementations
                                                                                        Comments

                                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                        Control0..*
                                                                                        TypeExtension
                                                                                        Is Modifierfalse
                                                                                        Summaryfalse
                                                                                        Alternate Namesextensions, user content
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                        SlicingThis element introduces a set of slices on Patient.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                        • value @ url
                                                                                        • 236. Patient.identifier:MedicaidIdentifier.type.coding.system
                                                                                          Definition

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

                                                                                          ShortIdentity of the terminology system
                                                                                          Comments

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

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

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

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

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

                                                                                          ShortVersion of the system - if relevant
                                                                                          Comments

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

                                                                                          NoteThis is a business 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()))
                                                                                          240. Patient.identifier:MedicaidIdentifier.type.coding.code
                                                                                          Definition

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

                                                                                          ShortSymbol in syntax defined by the system
                                                                                          Control1..1
                                                                                          Typecode
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Must Supporttrue
                                                                                          Summarytrue
                                                                                          Requirements

                                                                                          Need to refer to a particular code in the system.

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

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

                                                                                          ShortRepresentation defined by the system
                                                                                          Control0..1
                                                                                          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()))
                                                                                          244. Patient.identifier:MedicaidIdentifier.type.coding.userSelected
                                                                                          Definition

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

                                                                                          ShortIf this coding was chosen directly by the user
                                                                                          Comments

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

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

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

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

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

                                                                                          ShortPlain text representation of the concept
                                                                                          Comments

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

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

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

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

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

                                                                                          ShortThe namespace for the identifier value
                                                                                          Comments

                                                                                          Identifier.system is always case sensitive.

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

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

                                                                                          ExampleGeneral: http://www.acme.com/identifiers/patient
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          250. Patient.identifier:MedicaidIdentifier.value
                                                                                          Definition

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

                                                                                          ShortThe value that is unique within the system.
                                                                                          Comments

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

                                                                                          Control1..1
                                                                                          Typestring
                                                                                          Is Modifierfalse
                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                          Must Supporttrue
                                                                                          Summarytrue
                                                                                          ExampleGeneral: 123456
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          252. Patient.identifier:MedicaidIdentifier.period
                                                                                          Definition

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

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

                                                                                          Organization that issued/manages the identifier.

                                                                                          ShortOrganization that issued id (may be just text)
                                                                                          Comments

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

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

                                                                                          An identifier for this patient.

                                                                                          ShortAn identifier for this patient
                                                                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                          Control0..*
                                                                                          TypeIdentifier
                                                                                          Is Modifierfalse
                                                                                          Must Supporttrue
                                                                                          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()))
                                                                                          258. Patient.identifier:MR.id
                                                                                          Definition

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

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

                                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                          ShortAdditional content defined by implementations
                                                                                          Comments

                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                          Control0..*
                                                                                          TypeExtension
                                                                                          Is Modifierfalse
                                                                                          Summaryfalse
                                                                                          Alternate Namesextensions, user content
                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                          SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                          • value @ url
                                                                                          • 262. Patient.identifier:MR.extension:dataAbsentReason
                                                                                            Slice NamedataAbsentReason
                                                                                            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
                                                                                            Control0..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())
                                                                                            264. Patient.identifier:MR.extension:dataAbsentReason.id
                                                                                            Definition

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

                                                                                            ShortUnique id for inter-element referencing
                                                                                            Control0..1
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            266. Patient.identifier:MR.extension:dataAbsentReason.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.identifier.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                            • value @ url
                                                                                            • 268. Patient.identifier:MR.extension:dataAbsentReason.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
                                                                                              270. Patient.identifier:MR.extension:dataAbsentReason.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
                                                                                              BindingThe codes SHALL be taken from DataAbsentReason
                                                                                              (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                                              Used to specify why the normally expected content of the data element is missing.

                                                                                              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
                                                                                              Must Supporttrue
                                                                                              Summaryfalse
                                                                                              Fixed Valuemasked
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              272. Patient.identifier:MR.use
                                                                                              Definition

                                                                                              The purpose of this identifier.

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

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

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

                                                                                              Identifies the purpose for this identifier, if known .

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

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

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

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

                                                                                              ShortDescription of identifier
                                                                                              Comments

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

                                                                                              Control1..1
                                                                                              BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                                                              (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

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

                                                                                              TypeCodeableConcept
                                                                                              Is Modifierfalse
                                                                                              Must Supporttrue
                                                                                              Summarytrue
                                                                                              Requirements

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

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

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

                                                                                              ShortUnique id for inter-element referencing
                                                                                              Control0..1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                              Summaryfalse
                                                                                              278. Patient.identifier:MR.type.extension
                                                                                              Definition

                                                                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                              ShortAdditional content defined by implementations
                                                                                              Comments

                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                              Control0..*
                                                                                              TypeExtension
                                                                                              Is Modifierfalse
                                                                                              Summaryfalse
                                                                                              Alternate Namesextensions, user content
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                              SlicingThis element introduces a set of slices on Patient.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                              • value @ url
                                                                                              • 280. Patient.identifier:MR.type.coding
                                                                                                Definition

                                                                                                A reference to a code defined by a terminology system.

                                                                                                ShortCode defined by a terminology system
                                                                                                Comments

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

                                                                                                Control1..1
                                                                                                TypeCoding
                                                                                                Is Modifierfalse
                                                                                                Must Supporttrue
                                                                                                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()))
                                                                                                282. Patient.identifier:MR.type.coding.id
                                                                                                Definition

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

                                                                                                ShortUnique id for inter-element referencing
                                                                                                Control0..1
                                                                                                Typestring
                                                                                                Is Modifierfalse
                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                Summaryfalse
                                                                                                284. Patient.identifier:MR.type.coding.extension
                                                                                                Definition

                                                                                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                ShortAdditional content defined by implementations
                                                                                                Comments

                                                                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                Control0..*
                                                                                                TypeExtension
                                                                                                Is Modifierfalse
                                                                                                Summaryfalse
                                                                                                Alternate Namesextensions, user content
                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                SlicingThis element introduces a set of slices on Patient.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                • value @ url
                                                                                                • 286. Patient.identifier:MR.type.coding.system
                                                                                                  Definition

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

                                                                                                  ShortIdentity of the terminology system
                                                                                                  Comments

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

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

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

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

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

                                                                                                  ShortVersion of the system - if relevant
                                                                                                  Comments

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

                                                                                                  NoteThis is a business 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()))
                                                                                                  290. Patient.identifier:MR.type.coding.code
                                                                                                  Definition

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

                                                                                                  ShortSymbol in syntax defined by the system
                                                                                                  Control1..1
                                                                                                  Typecode
                                                                                                  Is Modifierfalse
                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                  Must Supporttrue
                                                                                                  Summarytrue
                                                                                                  Requirements

                                                                                                  Need to refer to a particular code in the system.

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

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

                                                                                                  ShortRepresentation defined by the system
                                                                                                  Control0..1
                                                                                                  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()))
                                                                                                  294. Patient.identifier:MR.type.coding.userSelected
                                                                                                  Definition

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

                                                                                                  ShortIf this coding was chosen directly by the user
                                                                                                  Comments

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

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

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

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

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

                                                                                                  ShortPlain text representation of the concept
                                                                                                  Comments

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

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

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

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

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

                                                                                                  ShortThe namespace for the identifier value
                                                                                                  Comments

                                                                                                  Identifier.system is always case sensitive.

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

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

                                                                                                  ExampleGeneral: http://www.acme.com/identifiers/patient
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  300. Patient.identifier:MR.value
                                                                                                  Definition

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

                                                                                                  ShortThe value that is unique within the system.
                                                                                                  Comments

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

                                                                                                  Control1..1
                                                                                                  Typestring
                                                                                                  Is Modifierfalse
                                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                  Must Supporttrue
                                                                                                  Summarytrue
                                                                                                  ExampleGeneral: 123456
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  302. Patient.identifier:MR.period
                                                                                                  Definition

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

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

                                                                                                  Organization that issued/manages the identifier.

                                                                                                  ShortOrganization that issued id (may be just text)
                                                                                                  Comments

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

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

                                                                                                  An identifier for this patient.

                                                                                                  ShortAn identifier for this patient
                                                                                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                  Control0..1
                                                                                                  TypeIdentifier
                                                                                                  Is Modifierfalse
                                                                                                  Must Supporttrue
                                                                                                  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()))
                                                                                                  308. Patient.identifier:SSNIdentifier.id
                                                                                                  Definition

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

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

                                                                                                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                  ShortAdditional content defined by implementations
                                                                                                  Comments

                                                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                  Control0..*
                                                                                                  TypeExtension
                                                                                                  Is Modifierfalse
                                                                                                  Summaryfalse
                                                                                                  Alternate Namesextensions, user content
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                  SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                  • value @ url
                                                                                                  • 312. Patient.identifier:SSNIdentifier.extension:dataAbsentReason
                                                                                                    Slice NamedataAbsentReason
                                                                                                    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
                                                                                                    Control0..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())
                                                                                                    314. Patient.identifier:SSNIdentifier.extension:dataAbsentReason.id
                                                                                                    Definition

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

                                                                                                    ShortUnique id for inter-element referencing
                                                                                                    Control0..1
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                    Summaryfalse
                                                                                                    316. Patient.identifier:SSNIdentifier.extension:dataAbsentReason.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.identifier.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                    • value @ url
                                                                                                    • 318. Patient.identifier:SSNIdentifier.extension:dataAbsentReason.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
                                                                                                      320. Patient.identifier:SSNIdentifier.extension:dataAbsentReason.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
                                                                                                      BindingThe codes SHALL be taken from DataAbsentReason
                                                                                                      (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                                                      Used to specify why the normally expected content of the data element is missing.

                                                                                                      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
                                                                                                      Must Supporttrue
                                                                                                      Summaryfalse
                                                                                                      Fixed Valuemasked
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      322. Patient.identifier:SSNIdentifier.use
                                                                                                      Definition

                                                                                                      The purpose of this identifier.

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

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

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

                                                                                                      Identifies the purpose for this identifier, if known .

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

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

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

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

                                                                                                      ShortDescription of identifier
                                                                                                      Comments

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

                                                                                                      Control1..1
                                                                                                      BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                                                                      (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

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

                                                                                                      TypeCodeableConcept
                                                                                                      Is Modifierfalse
                                                                                                      Must Supporttrue
                                                                                                      Summarytrue
                                                                                                      Requirements

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

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

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

                                                                                                      ShortUnique id for inter-element referencing
                                                                                                      Control0..1
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                      Summaryfalse
                                                                                                      328. Patient.identifier:SSNIdentifier.type.extension
                                                                                                      Definition

                                                                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                      ShortAdditional content defined by implementations
                                                                                                      Comments

                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                      Control0..*
                                                                                                      TypeExtension
                                                                                                      Is Modifierfalse
                                                                                                      Summaryfalse
                                                                                                      Alternate Namesextensions, user content
                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                      SlicingThis element introduces a set of slices on Patient.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                      • value @ url
                                                                                                      • 330. Patient.identifier:SSNIdentifier.type.coding
                                                                                                        Definition

                                                                                                        A reference to a code defined by a terminology system.

                                                                                                        ShortCode defined by a terminology system
                                                                                                        Comments

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

                                                                                                        Control1..1
                                                                                                        TypeCoding
                                                                                                        Is Modifierfalse
                                                                                                        Must Supporttrue
                                                                                                        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()))
                                                                                                        332. Patient.identifier:SSNIdentifier.type.coding.id
                                                                                                        Definition

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

                                                                                                        ShortUnique id for inter-element referencing
                                                                                                        Control0..1
                                                                                                        Typestring
                                                                                                        Is Modifierfalse
                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                        Summaryfalse
                                                                                                        334. Patient.identifier:SSNIdentifier.type.coding.extension
                                                                                                        Definition

                                                                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                        ShortAdditional content defined by implementations
                                                                                                        Comments

                                                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                        Control0..*
                                                                                                        TypeExtension
                                                                                                        Is Modifierfalse
                                                                                                        Summaryfalse
                                                                                                        Alternate Namesextensions, user content
                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                        SlicingThis element introduces a set of slices on Patient.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                        • value @ url
                                                                                                        • 336. Patient.identifier:SSNIdentifier.type.coding.system
                                                                                                          Definition

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

                                                                                                          ShortIdentity of the terminology system
                                                                                                          Comments

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

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

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

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

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

                                                                                                          ShortVersion of the system - if relevant
                                                                                                          Comments

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

                                                                                                          NoteThis is a business 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()))
                                                                                                          340. Patient.identifier:SSNIdentifier.type.coding.code
                                                                                                          Definition

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

                                                                                                          ShortSymbol in syntax defined by the system
                                                                                                          Control1..1
                                                                                                          Typecode
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supporttrue
                                                                                                          Summarytrue
                                                                                                          Requirements

                                                                                                          Need to refer to a particular code in the system.

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

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

                                                                                                          ShortRepresentation defined by the system
                                                                                                          Control0..1
                                                                                                          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()))
                                                                                                          344. Patient.identifier:SSNIdentifier.type.coding.userSelected
                                                                                                          Definition

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

                                                                                                          ShortIf this coding was chosen directly by the user
                                                                                                          Comments

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

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

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

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

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

                                                                                                          ShortPlain text representation of the concept
                                                                                                          Comments

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

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

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

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

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

                                                                                                          ShortThe namespace for the identifier value
                                                                                                          Comments

                                                                                                          Identifier.system is always case sensitive.

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

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

                                                                                                          ExampleGeneral: http://www.acme.com/identifiers/patient
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          350. Patient.identifier:SSNIdentifier.value
                                                                                                          Definition

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

                                                                                                          ShortThe value that is unique within the system.
                                                                                                          Comments

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

                                                                                                          Control1..1
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                          Must Supporttrue
                                                                                                          Summarytrue
                                                                                                          ExampleGeneral: 123456
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          352. Patient.identifier:SSNIdentifier.period
                                                                                                          Definition

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

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

                                                                                                          Organization that issued/manages the identifier.

                                                                                                          ShortOrganization that issued id (may be just text)
                                                                                                          Comments

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

                                                                                                          Control0..1
                                                                                                          TypeReference(Organization)
                                                                                                          Is Modifierfalse
                                                                                                          Summarytrue
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          356. 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
                                                                                                          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()))
                                                                                                          358. 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.

                                                                                                          Control1..*
                                                                                                          TypeHumanName
                                                                                                          Is Modifierfalse
                                                                                                          Must Supporttrue
                                                                                                          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()))
                                                                                                          360. 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
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                          Summaryfalse
                                                                                                          362. Patient.name.extension
                                                                                                          Definition

                                                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                          ShortAdditional content defined by implementations
                                                                                                          Comments

                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                          Control0..*
                                                                                                          TypeExtension
                                                                                                          Is Modifierfalse
                                                                                                          Summaryfalse
                                                                                                          Alternate Namesextensions, user content
                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                          SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                          • value @ url
                                                                                                          • 364. Patient.name.extension:dataAbsentReason
                                                                                                            Slice NamedataAbsentReason
                                                                                                            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
                                                                                                            Control0..1
                                                                                                            TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                            Is Modifierfalse
                                                                                                            Must Supporttrue
                                                                                                            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())
                                                                                                            366. Patient.name.extension:dataAbsentReason.id
                                                                                                            Definition

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

                                                                                                            ShortUnique id for inter-element referencing
                                                                                                            Control0..1
                                                                                                            Typestring
                                                                                                            Is Modifierfalse
                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                            Summaryfalse
                                                                                                            368. Patient.name.extension:dataAbsentReason.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
                                                                                                            • 370. Patient.name.extension:dataAbsentReason.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
                                                                                                              372. Patient.name.extension:dataAbsentReason.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
                                                                                                              BindingThe codes SHALL be taken from DataAbsentReason
                                                                                                              (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                                                              Used to specify why the normally expected content of the data element is missing.

                                                                                                              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
                                                                                                              Must Supporttrue
                                                                                                              Summaryfalse
                                                                                                              Fixed Valuemasked
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              374. 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|4.0.1)

                                                                                                              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()))
                                                                                                              376. 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()))
                                                                                                              378. 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).

                                                                                                              Control1..1
                                                                                                              This element is affected by the following invariants: us-core-6
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                              Must Supporttrue
                                                                                                              Summarytrue
                                                                                                              Alternate Namessurname
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              380. Patient.name.family.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
                                                                                                              382. Patient.name.family.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.name.family.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                              • value @ url
                                                                                                              • 384. Patient.name.family.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
                                                                                                                Control0..1
                                                                                                                TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                Is Modifierfalse
                                                                                                                Must Supporttrue
                                                                                                                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())
                                                                                                                386. Patient.name.family.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
                                                                                                                388. 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.

                                                                                                                Control1..*
                                                                                                                This element is affected by the following invariants: us-core-6
                                                                                                                Typestring
                                                                                                                Is Modifierfalse
                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                Must Supporttrue
                                                                                                                Summarytrue
                                                                                                                Alternate Namesfirst name, middle name
                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                390. Patient.name.given.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
                                                                                                                392. Patient.name.given.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.name.given.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                • value @ url
                                                                                                                • 394. Patient.name.given.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
                                                                                                                  Control0..1
                                                                                                                  TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                  Is Modifierfalse
                                                                                                                  Must Supporttrue
                                                                                                                  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())
                                                                                                                  396. Patient.name.given.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
                                                                                                                  398. 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()))
                                                                                                                  400. 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
                                                                                                                  Must Supportfalse
                                                                                                                  Summarytrue
                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  402. 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
                                                                                                                  Must Supportfalse
                                                                                                                  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()))
                                                                                                                  404. 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).

                                                                                                                  Control1..*
                                                                                                                  TypeContactPoint
                                                                                                                  Is Modifierfalse
                                                                                                                  Must Supporttrue
                                                                                                                  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()))
                                                                                                                  SlicingThis element introduces a set of slices on Patient.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                  • value @ system
                                                                                                                  • 406. Patient.telecom.id
                                                                                                                    Definition

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

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

                                                                                                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                    ShortAdditional content defined by implementations
                                                                                                                    Comments

                                                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                    Control0..*
                                                                                                                    TypeExtension
                                                                                                                    Is Modifierfalse
                                                                                                                    Summaryfalse
                                                                                                                    Alternate Namesextensions, user content
                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                    SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                    • value @ url
                                                                                                                    • 410. Patient.telecom.extension:dataAbsentReason
                                                                                                                      Slice NamedataAbsentReason
                                                                                                                      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
                                                                                                                      Control0..1
                                                                                                                      TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                      Is Modifierfalse
                                                                                                                      Must Supporttrue
                                                                                                                      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())
                                                                                                                      412. Patient.telecom.extension:dataAbsentReason.id
                                                                                                                      Definition

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

                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                      Control0..1
                                                                                                                      Typestring
                                                                                                                      Is Modifierfalse
                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                      Summaryfalse
                                                                                                                      414. Patient.telecom.extension:dataAbsentReason.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.telecom.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                      • value @ url
                                                                                                                      • 416. Patient.telecom.extension:dataAbsentReason.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
                                                                                                                        418. Patient.telecom.extension:dataAbsentReason.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
                                                                                                                        BindingThe codes SHALL be taken from DataAbsentReason
                                                                                                                        (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                                                                        Used to specify why the normally expected content of the data element is missing.

                                                                                                                        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
                                                                                                                        Must Supporttrue
                                                                                                                        Summaryfalse
                                                                                                                        Fixed Valuemasked
                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                        420. Patient.telecom.system
                                                                                                                        Definition

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

                                                                                                                        Shortphone | fax | email | pager | url | sms | other
                                                                                                                        Control1..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)

                                                                                                                        Telecommunications form for contact point.

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

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

                                                                                                                        ShortThe actual contact point details
                                                                                                                        Comments

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

                                                                                                                        Control1..1
                                                                                                                        Typestring
                                                                                                                        Is Modifierfalse
                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                        Must Supporttrue
                                                                                                                        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()))
                                                                                                                        424. Patient.telecom.use
                                                                                                                        Definition

                                                                                                                        Identifies the purpose for the contact point.

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

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

                                                                                                                        Control0..1
                                                                                                                        BindingThe codes SHALL be taken from ContactPointUse
                                                                                                                        (required to http://hl7.org/fhir/ValueSet/contact-point-use)
                                                                                                                        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
                                                                                                                        Must Supporttrue
                                                                                                                        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()))
                                                                                                                        426. Patient.telecom.rank
                                                                                                                        Definition

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

                                                                                                                        ShortSpecify preferred order of use (1 = highest)
                                                                                                                        Comments

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

                                                                                                                        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()))
                                                                                                                        428. Patient.telecom.period
                                                                                                                        Definition

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

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

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

                                                                                                                        ShortA contact detail for the individual
                                                                                                                        Comments

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

                                                                                                                        Control0..*
                                                                                                                        TypeContactPoint
                                                                                                                        Is Modifierfalse
                                                                                                                        Must Supporttrue
                                                                                                                        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()))
                                                                                                                        432. Patient.telecom:phone.id
                                                                                                                        Definition

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

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

                                                                                                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                        ShortAdditional content defined by implementations
                                                                                                                        Comments

                                                                                                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                        Control0..*
                                                                                                                        TypeExtension
                                                                                                                        Is Modifierfalse
                                                                                                                        Summaryfalse
                                                                                                                        Alternate Namesextensions, user content
                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                        SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                        • value @ url
                                                                                                                        • 436. Patient.telecom:phone.extension:dataAbsentReason
                                                                                                                          Slice NamedataAbsentReason
                                                                                                                          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
                                                                                                                          Control0..1
                                                                                                                          TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                          Is Modifierfalse
                                                                                                                          Must Supporttrue
                                                                                                                          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())
                                                                                                                          438. Patient.telecom:phone.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
                                                                                                                          Control1..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)

                                                                                                                          Telecommunications form for contact point.

                                                                                                                          Typecode
                                                                                                                          Is Modifierfalse
                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                          Must Supporttrue
                                                                                                                          Summarytrue
                                                                                                                          Fixed Valuephone
                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                          440. Patient.telecom:phone.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.

                                                                                                                          Control1..1
                                                                                                                          Typestring
                                                                                                                          Is Modifierfalse
                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                          Must Supporttrue
                                                                                                                          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()))
                                                                                                                          442. Patient.telecom:phone.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)
                                                                                                                          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
                                                                                                                          Must Supporttrue
                                                                                                                          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()))
                                                                                                                          444. Patient.telecom:phone.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.

                                                                                                                          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()))
                                                                                                                          446. Patient.telecom:phone.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()))
                                                                                                                          448. Patient.telecom:email
                                                                                                                          Slice Nameemail
                                                                                                                          Definition

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

                                                                                                                          ShortA contact detail for the individual
                                                                                                                          Comments

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

                                                                                                                          Control0..*
                                                                                                                          TypeContactPoint
                                                                                                                          Is Modifierfalse
                                                                                                                          Must Supporttrue
                                                                                                                          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()))
                                                                                                                          450. Patient.telecom:email.id
                                                                                                                          Definition

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

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

                                                                                                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                          ShortAdditional content defined by implementations
                                                                                                                          Comments

                                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                          Control0..*
                                                                                                                          TypeExtension
                                                                                                                          Is Modifierfalse
                                                                                                                          Summaryfalse
                                                                                                                          Alternate Namesextensions, user content
                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                          SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                          • value @ url
                                                                                                                          • 454. Patient.telecom:email.extension:dataAbsentReason
                                                                                                                            Slice NamedataAbsentReason
                                                                                                                            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
                                                                                                                            Control0..1
                                                                                                                            TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                            Is Modifierfalse
                                                                                                                            Must Supporttrue
                                                                                                                            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())
                                                                                                                            456. Patient.telecom:email.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
                                                                                                                            Control1..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)

                                                                                                                            Telecommunications form for contact point.

                                                                                                                            Typecode
                                                                                                                            Is Modifierfalse
                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                            Must Supporttrue
                                                                                                                            Summarytrue
                                                                                                                            Fixed Valueemail
                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            458. Patient.telecom:email.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.

                                                                                                                            Control1..1
                                                                                                                            Typestring
                                                                                                                            Is Modifierfalse
                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                            Must Supporttrue
                                                                                                                            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()))
                                                                                                                            460. Patient.telecom:email.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)
                                                                                                                            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
                                                                                                                            Must Supporttrue
                                                                                                                            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()))
                                                                                                                            462. Patient.telecom:email.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.

                                                                                                                            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()))
                                                                                                                            464. Patient.telecom:email.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()))
                                                                                                                            466. 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)
                                                                                                                            Typecode
                                                                                                                            Is Modifierfalse
                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                            Must Supporttrue
                                                                                                                            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()))
                                                                                                                            468. 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
                                                                                                                            470. 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
                                                                                                                            • 472. Patient.gender.extension:dataAbsentReason
                                                                                                                              Slice NamedataAbsentReason
                                                                                                                              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
                                                                                                                              Control0..1
                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                              TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                              Is Modifierfalse
                                                                                                                              Must Supporttrue
                                                                                                                              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())
                                                                                                                              474. Patient.gender.extension:dataAbsentReason.id
                                                                                                                              Definition

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

                                                                                                                              ShortUnique id for inter-element referencing
                                                                                                                              Control0..1
                                                                                                                              Typestring
                                                                                                                              Is Modifierfalse
                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                              Summaryfalse
                                                                                                                              476. Patient.gender.extension:dataAbsentReason.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.gender.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                              • value @ url
                                                                                                                              • 478. Patient.gender.extension:dataAbsentReason.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
                                                                                                                                480. Patient.gender.extension:dataAbsentReason.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
                                                                                                                                BindingThe codes SHALL be taken from DataAbsentReason
                                                                                                                                (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                                                                                Used to specify why the normally expected content of the data element is missing.

                                                                                                                                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
                                                                                                                                Must Supporttrue
                                                                                                                                Summaryfalse
                                                                                                                                Fixed Valuemasked
                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                482. Patient.gender.value
                                                                                                                                Definition

                                                                                                                                Primitive value for code

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

                                                                                                                                The date of birth for the individual.

                                                                                                                                ShortThe date of birth for the individual
                                                                                                                                Comments

                                                                                                                                At least an estimated year should be provided as a guess if the real DOB 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).

                                                                                                                                Control1..1
                                                                                                                                Typedate
                                                                                                                                Is Modifierfalse
                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                Must Supporttrue
                                                                                                                                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
                                                                                                                                486. Patient.birthDate.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
                                                                                                                                488. Patient.birthDate.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.birthDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                • value @ url
                                                                                                                                • 490. Patient.birthDate.extension:dataAbsentReason
                                                                                                                                  Slice NamedataAbsentReason
                                                                                                                                  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
                                                                                                                                  Control0..1
                                                                                                                                  This element is affected by the following invariants: ele-1
                                                                                                                                  TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                                  Is Modifierfalse
                                                                                                                                  Must Supporttrue
                                                                                                                                  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())
                                                                                                                                  492. Patient.birthDate.extension:dataAbsentReason.id
                                                                                                                                  Definition

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

                                                                                                                                  ShortUnique id for inter-element referencing
                                                                                                                                  Control0..1
                                                                                                                                  Typestring
                                                                                                                                  Is Modifierfalse
                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                  Summaryfalse
                                                                                                                                  494. Patient.birthDate.extension:dataAbsentReason.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.birthDate.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                  • value @ url
                                                                                                                                  • 496. Patient.birthDate.extension:dataAbsentReason.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
                                                                                                                                    498. Patient.birthDate.extension:dataAbsentReason.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
                                                                                                                                    BindingThe codes SHALL be taken from DataAbsentReason
                                                                                                                                    (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                                                                                    Used to specify why the normally expected content of the data element is missing.

                                                                                                                                    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
                                                                                                                                    Must Supporttrue
                                                                                                                                    Summaryfalse
                                                                                                                                    Fixed Valuemasked
                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                    500. Patient.birthDate.value
                                                                                                                                    Definition

                                                                                                                                    The actual value

                                                                                                                                    ShortPrimitive value for date
                                                                                                                                    Control0..1
                                                                                                                                    Typedate
                                                                                                                                    Is Modifierfalse
                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                    Summaryfalse
                                                                                                                                    502. Patient.deceased[x]
                                                                                                                                    Definition

                                                                                                                                    Indicates if the individual is deceased or not.

                                                                                                                                    ShortIf patient is deceased, use type dateTime and set to deceased date.
                                                                                                                                    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.

                                                                                                                                    Control1..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 Supporttrue
                                                                                                                                    Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                                                                    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()))
                                                                                                                                    504. Patient.address
                                                                                                                                    Definition

                                                                                                                                    If the patient is homeless, complete as much address information as possible (city, zip, county, etc.) and use the Characteristics of Home Environment profile in the Social History Section of the eICR Composition to indicate that the patient is homeless.

                                                                                                                                    ShortAn address for the individual
                                                                                                                                    Comments

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

                                                                                                                                    Control1..*
                                                                                                                                    TypeAddress
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Must Supporttrue
                                                                                                                                    Summarytrue
                                                                                                                                    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()))
                                                                                                                                    506. 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
                                                                                                                                    Typestring
                                                                                                                                    Is Modifierfalse
                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                    Summaryfalse
                                                                                                                                    508. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                    ShortAdditional content defined by implementations
                                                                                                                                    Comments

                                                                                                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                    Control0..*
                                                                                                                                    TypeExtension
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Summaryfalse
                                                                                                                                    Alternate Namesextensions, user content
                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                    SlicingThis element introduces a set of slices on Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                    • value @ url
                                                                                                                                    • 510. Patient.address.extension:dataAbsentReason
                                                                                                                                      Slice NamedataAbsentReason
                                                                                                                                      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
                                                                                                                                      Control0..1
                                                                                                                                      TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Must Supporttrue
                                                                                                                                      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())
                                                                                                                                      512. Patient.address.extension:dataAbsentReason.id
                                                                                                                                      Definition

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

                                                                                                                                      ShortUnique id for inter-element referencing
                                                                                                                                      Control0..1
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                      Summaryfalse
                                                                                                                                      514. Patient.address.extension:dataAbsentReason.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.address.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                      • value @ url
                                                                                                                                      • 516. Patient.address.extension:dataAbsentReason.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
                                                                                                                                        518. Patient.address.extension:dataAbsentReason.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
                                                                                                                                        BindingThe codes SHALL be taken from DataAbsentReason
                                                                                                                                        (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                                                                                        Used to specify why the normally expected content of the data element is missing.

                                                                                                                                        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
                                                                                                                                        Must Supporttrue
                                                                                                                                        Summaryfalse
                                                                                                                                        Fixed Valuemasked
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        520. 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|4.0.1)

                                                                                                                                        The use of an address.

                                                                                                                                        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.

                                                                                                                                        ExampleGeneral: home
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        522. 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|4.0.1)

                                                                                                                                        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
                                                                                                                                        ExampleGeneral: both
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        524. Patient.address.text
                                                                                                                                        Definition

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

                                                                                                                                        ShortText representation of the address
                                                                                                                                        Comments

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

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

                                                                                                                                        A renderable, unencoded form.

                                                                                                                                        ExampleGeneral: 137 Nowhere Street, Erewhon 9132
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        526. Patient.address.line
                                                                                                                                        Definition

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

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

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

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

                                                                                                                                        The name of the administrative area (county).

                                                                                                                                        ShortCounty
                                                                                                                                        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..1
                                                                                                                                        Typestring
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                        Must Supporttrue
                                                                                                                                        Summarytrue
                                                                                                                                        Alternate NamesCounty
                                                                                                                                        ExampleGeneral: Madison
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        532. 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)
                                                                                                                                        Control1..1
                                                                                                                                        BindingUnless not suitable, these codes SHALL be taken from USPS Two Letter Alphabetic Codes
                                                                                                                                        (extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state)

                                                                                                                                        Two Letter USPS alphabetic codes.

                                                                                                                                        Typestring
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                        Must Supporttrue
                                                                                                                                        Summarytrue
                                                                                                                                        Alternate NamesProvince, Territory
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        534. Patient.address.state.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
                                                                                                                                        536. Patient.address.state.extension
                                                                                                                                        Definition

                                                                                                                                        An Extension

                                                                                                                                        ShortExtension
                                                                                                                                        Control0..*
                                                                                                                                        TypeExtension
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Summaryfalse
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                        SlicingThis element introduces a set of slices on Patient.address.state.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                        • value @ url
                                                                                                                                        • 538. Patient.address.state.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
                                                                                                                                          Control0..1
                                                                                                                                          TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                                          Is Modifierfalse
                                                                                                                                          Must Supporttrue
                                                                                                                                          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())
                                                                                                                                          540. Patient.address.state.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
                                                                                                                                          542. Patient.address.postalCode
                                                                                                                                          Definition

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

                                                                                                                                          ShortUS Zip Codes
                                                                                                                                          Control0..1
                                                                                                                                          Typestring
                                                                                                                                          Is Modifierfalse
                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                          Must Supporttrue
                                                                                                                                          Summarytrue
                                                                                                                                          Alternate NamesZip, Zip Code
                                                                                                                                          ExampleGeneral: 9132
                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                          544. Patient.address.country
                                                                                                                                          Definition

                                                                                                                                          Country - a nation as commonly understood or generally accepted.

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

                                                                                                                                          ISO 3166 3 letter codes can 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()))
                                                                                                                                          546. Patient.address.period
                                                                                                                                          Definition

                                                                                                                                          Time period when address was/is in use.

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

                                                                                                                                          Allows addresses to be placed in historical context.

                                                                                                                                          ExampleGeneral: { "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()))
                                                                                                                                          548. 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 Marital Status Codes
                                                                                                                                          (extensible to http://hl7.org/fhir/ValueSet/marital-status)

                                                                                                                                          The domestic partnership status of a person.

                                                                                                                                          TypeCodeableConcept
                                                                                                                                          Is Modifierfalse
                                                                                                                                          Must Supporttrue
                                                                                                                                          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()))
                                                                                                                                          550. 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
                                                                                                                                          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()))
                                                                                                                                          552. 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
                                                                                                                                          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()))
                                                                                                                                          554. 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 Supporttrue
                                                                                                                                          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())
                                                                                                                                          556. 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
                                                                                                                                          Typestring
                                                                                                                                          Is Modifierfalse
                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                          Summaryfalse
                                                                                                                                          558. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                          ShortAdditional content defined by implementations
                                                                                                                                          Comments

                                                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                          Control0..*
                                                                                                                                          TypeExtension
                                                                                                                                          Is Modifierfalse
                                                                                                                                          Summaryfalse
                                                                                                                                          Alternate Namesextensions, user content
                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                          560. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                          Comments

                                                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                          Control0..*
                                                                                                                                          TypeExtension
                                                                                                                                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                          Summarytrue
                                                                                                                                          Requirements

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

                                                                                                                                          Alternate Namesextensions, user content, modifiers
                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                          562. Patient.contact.relationship
                                                                                                                                          Definition

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

                                                                                                                                          ShortThe kind of relationship
                                                                                                                                          Control1..1
                                                                                                                                          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 Supporttrue
                                                                                                                                          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()))
                                                                                                                                          564. Patient.contact.name
                                                                                                                                          Definition

                                                                                                                                          A name associated with the contact person.

                                                                                                                                          ShortA name associated with the contact person
                                                                                                                                          Control1..1
                                                                                                                                          TypeHumanName
                                                                                                                                          Is Modifierfalse
                                                                                                                                          Must Supporttrue
                                                                                                                                          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()))
                                                                                                                                          566. 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
                                                                                                                                          Typestring
                                                                                                                                          Is Modifierfalse
                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                          Summaryfalse
                                                                                                                                          568. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                          ShortAdditional content defined by implementations
                                                                                                                                          Comments

                                                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                          Control0..*
                                                                                                                                          TypeExtension
                                                                                                                                          Is Modifierfalse
                                                                                                                                          Summaryfalse
                                                                                                                                          Alternate Namesextensions, user content
                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                          SlicingThis element introduces a set of slices on Patient.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                          • value @ url
                                                                                                                                          • 570. Patient.contact.name.extension:dataAbsentReason
                                                                                                                                            Slice NamedataAbsentReason
                                                                                                                                            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
                                                                                                                                            Control0..1
                                                                                                                                            TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                                            Is Modifierfalse
                                                                                                                                            Must Supporttrue
                                                                                                                                            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())
                                                                                                                                            572. Patient.contact.name.extension:dataAbsentReason.id
                                                                                                                                            Definition

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

                                                                                                                                            ShortUnique id for inter-element referencing
                                                                                                                                            Control0..1
                                                                                                                                            Typestring
                                                                                                                                            Is Modifierfalse
                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                            Summaryfalse
                                                                                                                                            574. Patient.contact.name.extension:dataAbsentReason.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.contact.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                            • value @ url
                                                                                                                                            • 576. Patient.contact.name.extension:dataAbsentReason.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
                                                                                                                                              578. Patient.contact.name.extension:dataAbsentReason.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
                                                                                                                                              BindingThe codes SHALL be taken from DataAbsentReason
                                                                                                                                              (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                                                                                              Used to specify why the normally expected content of the data element is missing.

                                                                                                                                              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
                                                                                                                                              Must Supporttrue
                                                                                                                                              Summaryfalse
                                                                                                                                              Fixed Valuemasked
                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                              580. 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|4.0.1)

                                                                                                                                              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()))
                                                                                                                                              582. 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()))
                                                                                                                                              584. 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()))
                                                                                                                                              586. 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()))
                                                                                                                                              588. 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()))
                                                                                                                                              590. 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()))
                                                                                                                                              592. 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()))
                                                                                                                                              594. 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.

                                                                                                                                              Control1..*
                                                                                                                                              TypeContactPoint
                                                                                                                                              Is Modifierfalse
                                                                                                                                              Must Supporttrue
                                                                                                                                              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()))
                                                                                                                                              596. 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
                                                                                                                                              Typestring
                                                                                                                                              Is Modifierfalse
                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                              Summaryfalse
                                                                                                                                              598. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                              ShortAdditional content defined by implementations
                                                                                                                                              Comments

                                                                                                                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                              Control0..*
                                                                                                                                              TypeExtension
                                                                                                                                              Is Modifierfalse
                                                                                                                                              Summaryfalse
                                                                                                                                              Alternate Namesextensions, user content
                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                              SlicingThis element introduces a set of slices on Patient.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                              • value @ url
                                                                                                                                              • 600. Patient.contact.telecom.extension:dataAbsentReason
                                                                                                                                                Slice NamedataAbsentReason
                                                                                                                                                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
                                                                                                                                                Control0..1
                                                                                                                                                TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                                                Is Modifierfalse
                                                                                                                                                Must Supporttrue
                                                                                                                                                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())
                                                                                                                                                602. Patient.contact.telecom.extension:dataAbsentReason.id
                                                                                                                                                Definition

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

                                                                                                                                                ShortUnique id for inter-element referencing
                                                                                                                                                Control0..1
                                                                                                                                                Typestring
                                                                                                                                                Is Modifierfalse
                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                Summaryfalse
                                                                                                                                                604. Patient.contact.telecom.extension:dataAbsentReason.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.contact.telecom.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                • value @ url
                                                                                                                                                • 606. Patient.contact.telecom.extension:dataAbsentReason.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
                                                                                                                                                  608. Patient.contact.telecom.extension:dataAbsentReason.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
                                                                                                                                                  BindingThe codes SHALL be taken from DataAbsentReason
                                                                                                                                                  (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                                                                                                  Used to specify why the normally expected content of the data element is missing.

                                                                                                                                                  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
                                                                                                                                                  Must Supporttrue
                                                                                                                                                  Summaryfalse
                                                                                                                                                  Fixed Valuemasked
                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                  610. 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|4.0.1)

                                                                                                                                                  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()))
                                                                                                                                                  612. 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
                                                                                                                                                  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()))
                                                                                                                                                  614. 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|4.0.1)

                                                                                                                                                  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()))
                                                                                                                                                  616. 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.

                                                                                                                                                  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()))
                                                                                                                                                  618. 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()))
                                                                                                                                                  620. Patient.contact.address
                                                                                                                                                  Definition

                                                                                                                                                  Address for the contact person.

                                                                                                                                                  ShortAddress for the contact person
                                                                                                                                                  Control1..1
                                                                                                                                                  TypeAddress
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  Must Supporttrue
                                                                                                                                                  Summaryfalse
                                                                                                                                                  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()))
                                                                                                                                                  622. 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
                                                                                                                                                  Typestring
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                  Summaryfalse
                                                                                                                                                  624. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                  ShortAdditional content defined by implementations
                                                                                                                                                  Comments

                                                                                                                                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                  Control0..*
                                                                                                                                                  TypeExtension
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  Summaryfalse
                                                                                                                                                  Alternate Namesextensions, user content
                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                  SlicingThis element introduces a set of slices on Patient.contact.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                  • value @ url
                                                                                                                                                  • 626. Patient.contact.address.extension:dataAbsentReason
                                                                                                                                                    Slice NamedataAbsentReason
                                                                                                                                                    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
                                                                                                                                                    Control0..1
                                                                                                                                                    TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                                                    Is Modifierfalse
                                                                                                                                                    Must Supporttrue
                                                                                                                                                    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())
                                                                                                                                                    628. Patient.contact.address.extension:dataAbsentReason.id
                                                                                                                                                    Definition

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

                                                                                                                                                    ShortUnique id for inter-element referencing
                                                                                                                                                    Control0..1
                                                                                                                                                    Typestring
                                                                                                                                                    Is Modifierfalse
                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                    Summaryfalse
                                                                                                                                                    630. Patient.contact.address.extension:dataAbsentReason.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.contact.address.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                    • value @ url
                                                                                                                                                    • 632. Patient.contact.address.extension:dataAbsentReason.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
                                                                                                                                                      634. Patient.contact.address.extension:dataAbsentReason.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
                                                                                                                                                      BindingThe codes SHALL be taken from DataAbsentReason
                                                                                                                                                      (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                                                                                                      Used to specify why the normally expected content of the data element is missing.

                                                                                                                                                      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
                                                                                                                                                      Must Supporttrue
                                                                                                                                                      Summaryfalse
                                                                                                                                                      Fixed Valuemasked
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      636. 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|4.0.1)

                                                                                                                                                      The use of an address.

                                                                                                                                                      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.

                                                                                                                                                      ExampleGeneral: home
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      638. 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|4.0.1)

                                                                                                                                                      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
                                                                                                                                                      ExampleGeneral: both
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      640. 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.

                                                                                                                                                      ExampleGeneral: 137 Nowhere Street, Erewhon 9132
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      642. Patient.contact.address.line
                                                                                                                                                      Definition

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

                                                                                                                                                      ShortStreet name, number, direction & P.O. Box etc.
                                                                                                                                                      Control0..*
                                                                                                                                                      Typestring
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                      Summarytrue
                                                                                                                                                      ExampleGeneral: 137 Nowhere Street
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      644. 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
                                                                                                                                                      ExampleGeneral: Erewhon
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      646. 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..1
                                                                                                                                                      Typestring
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                      Summarytrue
                                                                                                                                                      Alternate NamesCounty
                                                                                                                                                      ExampleGeneral: Madison
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      648. 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()))
                                                                                                                                                      650. 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
                                                                                                                                                      ExampleGeneral: 9132
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      652. Patient.contact.address.country
                                                                                                                                                      Definition

                                                                                                                                                      Country - a nation as commonly understood or generally accepted.

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

                                                                                                                                                      ISO 3166 3 letter codes can 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()))
                                                                                                                                                      654. Patient.contact.address.period
                                                                                                                                                      Definition

                                                                                                                                                      Time period when address was/is in use.

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

                                                                                                                                                      Allows addresses to be placed in historical context.

                                                                                                                                                      ExampleGeneral: { "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()))
                                                                                                                                                      656. 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|4.0.1)

                                                                                                                                                      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
                                                                                                                                                      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()))
                                                                                                                                                      658. 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
                                                                                                                                                      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()))
                                                                                                                                                      660. 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
                                                                                                                                                      Summaryfalse
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      662. 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.

                                                                                                                                                      Control1..*
                                                                                                                                                      TypeBackboneElement
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Must Supporttrue
                                                                                                                                                      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()))
                                                                                                                                                      664. 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
                                                                                                                                                      Typestring
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                      Summaryfalse
                                                                                                                                                      666. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                      ShortAdditional content defined by implementations
                                                                                                                                                      Comments

                                                                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                      Control0..*
                                                                                                                                                      TypeExtension
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Summaryfalse
                                                                                                                                                      Alternate Namesextensions, user content
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                      668. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                                                                      ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                      Comments

                                                                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                      Control0..*
                                                                                                                                                      TypeExtension
                                                                                                                                                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                      Summarytrue
                                                                                                                                                      Requirements

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

                                                                                                                                                      Alternate Namesextensions, user content, modifiers
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                      670. 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-EN" for England 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
                                                                                                                                                      BindingUnless not suitable, these codes SHALL be taken from Language codes with language and optionally a region modifier
                                                                                                                                                      (extensible to http://hl7.org/fhir/us/core/ValueSet/simple-language)
                                                                                                                                                      TypeCodeableConcept
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Must Supporttrue
                                                                                                                                                      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()))
                                                                                                                                                      672. Patient.communication.language.id
                                                                                                                                                      Definition

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

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

                                                                                                                                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                      ShortAdditional content defined by implementations
                                                                                                                                                      Comments

                                                                                                                                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                      Control0..*
                                                                                                                                                      TypeExtension
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Summaryfalse
                                                                                                                                                      Alternate Namesextensions, user content
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                      SlicingThis element introduces a set of slices on Patient.communication.language.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                      • value @ url
                                                                                                                                                      • 676. Patient.communication.language.extension:dataAbsentReason
                                                                                                                                                        Slice NamedataAbsentReason
                                                                                                                                                        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
                                                                                                                                                        Control0..1
                                                                                                                                                        TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                                                        Is Modifierfalse
                                                                                                                                                        Must Supporttrue
                                                                                                                                                        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())
                                                                                                                                                        678. Patient.communication.language.extension:dataAbsentReason.id
                                                                                                                                                        Definition

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

                                                                                                                                                        ShortUnique id for inter-element referencing
                                                                                                                                                        Control0..1
                                                                                                                                                        Typestring
                                                                                                                                                        Is Modifierfalse
                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                        Summaryfalse
                                                                                                                                                        680. Patient.communication.language.extension:dataAbsentReason.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.communication.language.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                        • value @ url
                                                                                                                                                        • 682. Patient.communication.language.extension:dataAbsentReason.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
                                                                                                                                                          684. Patient.communication.language.extension:dataAbsentReason.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
                                                                                                                                                          BindingThe codes SHALL be taken from DataAbsentReason
                                                                                                                                                          (required to http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1)

                                                                                                                                                          Used to specify why the normally expected content of the data element is missing.

                                                                                                                                                          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
                                                                                                                                                          Must Supporttrue
                                                                                                                                                          Summaryfalse
                                                                                                                                                          Fixed Valuemasked
                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                          686. Patient.communication.language.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()))
                                                                                                                                                          688. Patient.communication.language.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()))
                                                                                                                                                          690. 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
                                                                                                                                                          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()))
                                                                                                                                                          692. 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..1
                                                                                                                                                          TypeReference(US Core Practitioner Profile)
                                                                                                                                                          Is Modifierfalse
                                                                                                                                                          Must Supporttrue
                                                                                                                                                          Summaryfalse
                                                                                                                                                          Alternate NamescareProvider
                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                          694. 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(Central Cancer Registry Reporting Organization)
                                                                                                                                                          Is Modifierfalse
                                                                                                                                                          Must Supporttrue
                                                                                                                                                          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()))
                                                                                                                                                          696. Patient.link
                                                                                                                                                          Definition

                                                                                                                                                          Link to another patient resource that concerns the same actual patient.

                                                                                                                                                          ShortLink to another patient resource that concerns the same actual person
                                                                                                                                                          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'
                                                                                                                                                          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()))
                                                                                                                                                          698. 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
                                                                                                                                                          Typestring
                                                                                                                                                          Is Modifierfalse
                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                          Summaryfalse
                                                                                                                                                          700. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                                                                                                                          ShortAdditional content defined by implementations
                                                                                                                                                          Comments

                                                                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                          Control0..*
                                                                                                                                                          TypeExtension
                                                                                                                                                          Is Modifierfalse
                                                                                                                                                          Summaryfalse
                                                                                                                                                          Alternate Namesextensions, user content
                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                          702. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                                                                                                                                                          ShortExtensions that cannot be ignored even if unrecognized
                                                                                                                                                          Comments

                                                                                                                                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                                                                                                                          Control0..*
                                                                                                                                                          TypeExtension
                                                                                                                                                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                                                                                                          Summarytrue
                                                                                                                                                          Requirements

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

                                                                                                                                                          Alternate Namesextensions, user content, modifiers
                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                                                                                          704. Patient.link.other
                                                                                                                                                          Definition

                                                                                                                                                          The other patient resource that the link refers to.

                                                                                                                                                          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
                                                                                                                                                          Summarytrue
                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                          706. 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|4.0.1)

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

                                                                                                                                                          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()))