New Zealand NHI IG
1.6.1 - Release

New Zealand NHI IG - Local Development build (v1.6.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NhiPatient - Detailed Descriptions

Active as of 2024-09-04

Definitions for the NhiPatient resource profile.

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

0. Patient
Invariantsnhi-nz-pat-1: only allows certain name name use values (Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') ))
2. Patient.contained
SlicingThis element introduces a set of slices on Patient.contained. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
  • 4. Patient.contained:GP
    Slice NameGP
    Definition

    Contained resource for the General Practice that the patient is enrolled with

    ShortContained resource for the Patient's enrolled general Practitioner
    Control0..1
    TypePractitionerRole
    6. Patient.extension:ethnicity
    Slice Nameethnicity
    Control0..6
    8. Patient.extension:ethnicity.value[x]:valueCodeableConcept
    Slice NamevalueCodeableConcept
    BindingThe codes SHALL be taken from Hip_ethnicity_lvl_4 (2.0)
    (required to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0)
    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    10. Patient.extension:nzCitizen
    Slice NamenzCitizen
    Definition

    This field is used to indicate the New Zealand citizenship status of the patient

    ShortThis field indicates New Zealand citizenship status of the patient
    12. Patient.extension:nzCitizen.extension:source
    Slice Namesource
    14. Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept
    Slice NamevalueCodeableConcept
    BindingThe codes SHALL be taken from NZ Citizenship Information Source
    (required to https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code)
    TypeCodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    16. Patient.extension:domicile-code
    Slice Namedomicile-code
    Control0..0
    18. Patient.extension:pho
    Slice Namepho
    Control0..0
    20. Patient.extension:sex-at-birth
    Slice Namesex-at-birth
    Control0..0
    22. Patient.extension:iwi
    Slice Nameiwi
    Control0..0
    24. Patient.extension:birthPlace
    Slice NamebirthPlace
    Control0..1
    TypeExtension(BirthPlace) (Complex Extension)
    26. Patient.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
    • value @ system
    • 28. Patient.identifier.type
      Control0..0
      30. Patient.identifier.period
      Control0..0
      32. Patient.identifier:NHI
      Slice NameNHI
      NoteThis is a business identifier, not a resource identifier (see discussion)
      34. Patient.identifier:NHI.type
      Control0..0
      36. Patient.identifier:NHI.period
      Control0..0
      38. Patient.active
      Control0..0
      40. Patient.name
      42. Patient.name.extension
      Control1..?
      44. Patient.name.extension:information-source
      Slice Nameinformation-source
      Control0..1
      TypeExtension(Information Source) (Extension Type: CodeableConcept)
      46. Patient.name.extension:information-source.value[x]:valueCodeableConcept
      Slice NamevalueCodeableConcept
      BindingThe codes SHALL be taken from Name Information Source
      (required to https://nzhts.digital.health.nz/fhir/ValueSet/name-source-code)
      TypeCodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      48. Patient.name.extension:preferred
      Slice Namepreferred
      Control1..1
      TypeExtension(Preferred) (Extension Type: boolean)
      50. Patient.name.extension:nhi-name-use-extra
      Slice Namenhi-name-use-extra
      Control0..1
      TypeExtension(NameUseExtra) (Extension Type: CodeableConcept)
      52. Patient.name.use
      Shorttemp | nickname | maiden
      54. Patient.name.text
      Control0..0
      56. Patient.name.given
      Definition

      The given name and other given name(s) for the patient

      ShortGiven name and other given name(s)
      Control0..2
      58. Patient.name.prefix
      BindingThe codes SHALL be taken from Name Prefix Codes
      (required to https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code)
      60. Patient.name.suffix
      Control0..0
      62. Patient.name.period
      Control0..0
      64. Patient.telecom
      ShortThe Paient's contact details
      Control0..3
      66. Patient.telecom.extension:cp-purpose
      Slice Namecp-purpose
      Control0..0
      68. Patient.telecom.system
      Definition

      The system for this contact point - constrained to phone | email

      Shortphone | email
      BindingThe codes SHALL be taken from NHI ContactPoint System Codes
      (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhi-contact-point-system-code)
      70. Patient.telecom.use
      Definition

      The purpose of this contact point - constrained to home | mobile

      Shorthome | mobile
      BindingThe codes SHALL be taken from NHI ContactPoint Use Codes
      (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhiContactUseType)
      72. Patient.telecom.rank
      Control0..0
      74. Patient.telecom.period
      Control0..0
      76. Patient.gender
      78. Patient.gender.extension
      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
      • 80. Patient.gender.extension:originalText
        Slice NameoriginalText
        Control0..1
        TypeExtension(OriginalText) (Extension Type: string)
        82. Patient.birthDate
        84. Patient.birthDate.extension
        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
        • 86. Patient.birthDate.extension:information-source
          Slice Nameinformation-source
          Control0..1
          TypeExtension(Information Source) (Extension Type: CodeableConcept)
          88. Patient.birthDate.extension:information-source.value[x]:valueCodeableConcept
          Slice NamevalueCodeableConcept
          BindingThe codes SHALL be taken from Date of Birth Information Source
          (required to https://nzhts.digital.health.nz/fhir/ValueSet/date-of-birth-source-code)
          TypeCodeableConcept
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          90. Patient.deceased[x]
          TypedateTime, boolean
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          92. Patient.deceased[x].extension
          SlicingThis element introduces a set of slices on Patient.deceased[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 94. Patient.deceased[x].extension:information-source
            Slice Nameinformation-source
            Control0..1
            TypeExtension(Information Source) (Extension Type: CodeableConcept)
            96. Patient.deceased[x].extension:information-source.value[x]:valueCodeableConcept
            Slice NamevalueCodeableConcept
            BindingThe codes SHALL be taken from Date of Death Information Source
            (required to https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code)
            TypeCodeableConcept
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            98. Patient.address
            TypeAddress(NHI Address)
            100. Patient.address.line
            Control1..?
            102. Patient.maritalStatus
            Control0..0
            104. Patient.multipleBirth[x]
            Control0..0
            106. Patient.photo
            Control0..0
            108. Patient.contact
            Control0..0
            110. Patient.communication
            Control0..0
            112. Patient.generalPractitioner
            Definition

            The reference for the General Practice that the patient is enrolled with

            ShortReference for the Patient's enrolled general Practitioner
            Control0..1
            TypeReference(PractitionerRole)
            114. Patient.managingOrganization
            Control0..0
            116. Patient.link
            Control0..0

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

            0. Patient
            Definition

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

            ShortInformation about an individual or animal receiving health care services
            Control0..*
            Is Modifierfalse
            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())
            nz-pat-1: only a single official NHI (Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2)
            nhi-nz-pat-1: only allows certain name name use values (Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') ))
            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.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
            SlicingThis element introduces a set of slices on Patient.contained. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
            • type @ $this
            • 6. Patient.contained:GP
              Slice NameGP
              Definition

              Contained resource for the General Practice that the patient is enrolled with


              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 resource for the Patient's enrolled general PractitionerContained, 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..1*
              TypePractitionerRoleResource
              Is Modifierfalse
              Summaryfalse
              Alternate Namesinline resources, anonymous resources, contained resources
              8. Patient.extension:ethnicity
              Slice Nameethnicity
              Definition

              The ethnic group or groups that a person identifies with or feels they belong to. Ethnicity is a measure of cultural affiliation as opposed to race, ancestry, nationality or citizen. Ethnicity is self-perceived and a person can belong to more than one group.

              The Stats New Zealand standard can be found here.

              ShortNZ Ethnicity
              Control0..6
              This element is affected by the following invariants: ele-1
              TypeExtension(NZ Ethnicity) (Extension Type: CodeableConcept)
              Is Modifierfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              10. 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.

              Control0..0*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 12. 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.nz/fhir/StructureDefinition/nz-ethnicity
                14. 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
                Control10..1
                TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, 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()))
                SlicingThis element introduces a set of slices on Patient.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                • type @ $this
                • 16. Patient.extension:ethnicity.value[x]:valueCodeableConcept
                  Slice NamevalueCodeableConcept
                  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 Hip_ethnicity_lvl_4 (2.0)
                  (required to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0)
                  TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, 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()))
                  18. Patient.extension:nzCitizen
                  Slice NamenzCitizen
                  Definition

                  This field is used to indicate the New Zealand citizenship status of the patient

                  ShortThis field indicates New Zealand citizenship status of the patient
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypeExtension(NZ Citizenship) (Complex Extension)
                  Is Modifierfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  20. Patient.extension:nzCitizen.extension:status
                  Slice Namestatus
                  Definition

                  No description

                  ShortExtensionAdditional content defined by implementations
                  Control0..1*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  22. Patient.extension:nzCitizen.extension:status.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
                  • 24. Patient.extension:nzCitizen.extension:status.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 Valuestatus
                    26. Patient.extension:nzCitizen.extension:status.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..1
                    TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, 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()))
                    SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                    • type @ $this
                    • 28. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept
                      Slice NamevalueCodeableConcept
                      Definition

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

                      ShortValue of extension
                      Control0..1
                      BindingThe codes SHOULD be taken from For codes, see NZ Citizenship status
                      (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code)
                      TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, 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()))
                      30. Patient.extension:nzCitizen.extension:source
                      Slice Namesource
                      Definition

                      An Extension

                      ShortExtensionAdditional content defined by implementations
                      Control0..1*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      32. Patient.extension:nzCitizen.extension:source.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
                      • 34. Patient.extension:nzCitizen.extension:source.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 Valuesource
                        36. Patient.extension:nzCitizen.extension:source.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..1
                        TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, 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()))
                        SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                        • type @ $this
                        • 38. Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept
                          Slice NamevalueCodeableConcept
                          Definition

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

                          ShortValue of extension
                          Control0..1
                          BindingThe codes SHALL be taken from For codes, see NZ Citizenship Information Source
                          (required to https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code)
                          TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, 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()))
                          40. Patient.extension:nzCitizen.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.nz/fhir/StructureDefinition/nz-citizenship
                          42. Patient.extension:nzCitizen.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()))
                          44. Patient.extension:dhb
                          Slice Namedhb
                          Definition

                          District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).

                          ShortDistrict Health Board linked to a NZ Healthcare Service, Location or Patient
                          Control0..1
                          This element is affected by the following invariants: ele-1
                          TypeExtension(District Health Board linked to a NZ Healthcare Service, Location or Patient) (Extension Type: CodeableConcept)
                          Is Modifierfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          46. Patient.extension:domicile-code
                          Slice Namedomicile-code
                          Definition

                          NZ Domicile Code. Derived from a patient's primary physical, home address.

                          ShortNZ Domicile Code
                          Control0..0
                          This element is affected by the following invariants: ele-1
                          TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
                          Is Modifierfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          48. Patient.extension:pho
                          Slice Namepho
                          Definition

                          Primary Healthcare Organisation associated with a General Practice linked to a NZ Healthcare Service, Location (Facility) or Patient (GP).

                          ShortPrimary Healthcare Organisation
                          Control0..0
                          This element is affected by the following invariants: ele-1
                          TypeExtension(Primary Healthcare Organisation) (Extension Type: CodeableConcept)
                          Is Modifierfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          50. Patient.extension:sex-at-birth
                          Slice Namesex-at-birth
                          Definition

                          A person’s sex at the time of their birth (considered to be immutable).

                          ShortSex At Birth
                          Control0..0
                          This element is affected by the following invariants: ele-1
                          TypeExtension(Sex At Birth) (Extension Type: CodeableConcept)
                          Is Modifierfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          52. Patient.extension:iwi
                          Slice Nameiwi
                          Definition

                          Persons Iwi affiliation

                          ShortExtension
                          Control0..0
                          This element is affected by the following invariants: ele-1
                          TypeExtension(Nz_iwi) (Extension Type: CodeableConcept)
                          Is Modifierfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          54. Patient.extension:birthPlace
                          Slice NamebirthPlace
                          Definition

                          The country where the person was born

                          ShortExtension
                          Control0..1
                          TypeExtension(BirthPlace) (Complex Extension)
                          Is Modifierfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          56. 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())
                          58. Patient.identifier
                          Definition

                          An identifier for this patient.

                          ShortAn identifier for this patient
                          NoteThis is a business identifier, not a resource identifier (see discussion)
                          Control0..*
                          TypeIdentifier
                          Is Modifierfalse
                          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 Closed, and can be differentiated using the following discriminators:
                          • value @ system
                          • 60. 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()))
                            62. 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..01
                            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
                            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()))
                            64. Patient.identifier.period
                            Definition

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

                            ShortTime period when id is/was valid for use
                            Control0..01
                            TypePeriod
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            66. Patient.identifier:NHI
                            Slice NameNHI
                            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
                            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()))
                            68. Patient.identifier:NHI.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 Valid use values for NHIhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                            (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code)
                            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()))
                            70. Patient.identifier:NHI.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..01
                            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
                            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()))
                            72. Patient.identifier:NHI.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
                            Summarytrue
                            Requirements

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

                            Fixed Valuehttps://standards.digital.health.nz/ns/nhi-id
                            Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            74. Patient.identifier:NHI.period
                            Definition

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

                            ShortTime period when id is/was valid for use
                            Control0..01
                            TypePeriod
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            76. 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..01
                            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()))
                            78. Patient.telecom
                            Definition

                            Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.


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

                            ShortThe Paient's contact detailsA 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..3*
                            This element is affected by the following invariants: ele-1
                            TypeContactPoint(Common NZ ContactPoint datatype)
                            Is Modifierfalse
                            Requirements

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

                            Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            80. Patient.telecom.extension:cp-purpose
                            Slice Namecp-purpose
                            Definition

                            A specific purpose for which this ContactPoint dataType would be used. An example would be to indicate that this ContactPoint is used for video conferencing.

                            ShortA specific purpose for which this ContactPoint dataType would be used
                            Control0..0
                            TypeExtension(A specific purpose for which this ContactPoint dataType would be used) (Extension Type: CodeableConcept)
                            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())
                            82. Patient.telecom.system
                            Definition

                            The system for this contact point - constrained to phone | email


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

                            Shortphone | emailphone | fax | email | pager | url | sms | other
                            Control0..1
                            This element is affected by the following invariants: cpt-2
                            BindingThe codes SHALL be taken from NHI ContactPoint System Codeshttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
                            (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhi-contact-point-system-code)
                            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()))
                            84. Patient.telecom.use
                            Definition

                            The purpose of this contact point - constrained to home | mobile


                            Identifies the purpose for the contact point.

                            Shorthome | mobilehome | 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 NHI ContactPoint Use Codeshttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
                            (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhiContactUseType)
                            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()))
                            86. 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..01
                            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()))
                            88. 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..01
                            TypePeriod
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            90. Patient.deceased[x]
                            Definition

                            Indicates if the individual is deceased or not.

                            ShortIndicates if the individual is deceased or not
                            Comments

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

                            Control0..1
                            TypedateTime, boolean
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            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()))
                            92. Patient.deceased[x].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..*
                            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())
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on Patient.deceased[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 94. Patient.deceased[x].extension:information-source
                              Slice Nameinformation-source
                              Definition

                              The official source of information held about a patient.

                              ShortInformation Source
                              Control0..1
                              This element is affected by the following invariants: ele-1
                              TypeExtension(Information Source) (Extension Type: CodeableConcept)
                              Is Modifierfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              96. Patient.deceased[x].extension:information-source.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.deceased[x].extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 98. Patient.deceased[x].extension:information-source.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.nz/fhir/StructureDefinition/information-source
                                100. Patient.deceased[x].extension:information-source.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..1
                                TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, 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()))
                                SlicingThis element introduces a set of slices on Patient.deceased[x].extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                • type @ $this
                                • 102. Patient.deceased[x].extension:information-source.value[x]:valueCodeableConcept
                                  Slice NamevalueCodeableConcept
                                  Definition

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

                                  ShortValue of extension
                                  Control0..1
                                  BindingThe codes SHALL be taken from For codes, see Date of Death Information Source
                                  (required to https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code)
                                  TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, 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()))
                                  104. Patient.address
                                  Definition

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


                                  An address for the individual.

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

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


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

                                  Control0..*
                                  This element is affected by the following invariants: ele-1
                                  TypeAddress(NHI Address)
                                  Is Modifierfalse
                                  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()))
                                  106. Patient.address.extension:nz-geocode
                                  Slice Namenz-geocode
                                  Definition

                                  New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode.

                                  ShortA geocode using the NZ specific datum (reference point)
                                  Control0..1
                                  TypeExtension(NZ Geocode) (Complex Extension)
                                  Is Modifierfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  108. Patient.address.extension:suburb
                                  Slice Namesuburb
                                  Definition

                                  Suburb element of a NZ Address.

                                  ShortThe suburb part of the address
                                  Control0..1
                                  TypeExtension(NZ Suburb) (Extension Type: string)
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  110. Patient.address.extension:building-name
                                  Slice Namebuilding-name
                                  Definition

                                  The name of a building cited in an address.

                                  ShortThe name of the building
                                  Control0..1
                                  TypeExtension(Building Name) (Extension Type: string)
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  112. Patient.address.extension:domicile-code
                                  Slice Namedomicile-code
                                  Definition

                                  NZ Domicile Code. Derived from a patient's primary physical, home address.

                                  ShortThe domicile code associated with this address
                                  Control0..1
                                  TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
                                  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())
                                  114. Patient.address.extension:notValidatedAddressReason
                                  Slice NamenotValidatedAddressReason
                                  Definition

                                  The reason why the address has not been validated

                                  ShortThe reason an address was not validated
                                  Control0..1
                                  TypeExtension(NotValidatedAddressReason) (Extension Type: CodeableConcept)
                                  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())
                                  116. Patient.address.extension:nz-address-id
                                  Slice Namenz-address-id
                                  Definition

                                  Uniquely identifies this address as a physical entity. Will remain constant over time even if address administrative data such as DPID change

                                  ShortExtension
                                  Control0..1
                                  TypeExtension(NzAddressId) (Extension Type: string)
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  118. Patient.address.extension:nz-address-derived
                                  Slice Namenz-address-derived
                                  Definition

                                  Address elements that are directly derived from the address validation service

                                  ShortExtension
                                  Control0..1
                                  TypeExtension(NhiAddressDerived) (Complex Extension)
                                  Is Modifierfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  120. 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 NHI Address Use Codeshttp://hl7.org/fhir/ValueSet/address-use|4.0.1
                                  (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse)
                                  Typecode
                                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

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

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

                                  Distinguishes between Residential (physical) and Postal (mailing) addresses


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

                                  Shortpostal | physicalpostal | 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).


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

                                  Control10..1
                                  BindingThe codes SHALL be taken from NHI Address Type Codeshttp://hl7.org/fhir/ValueSet/address-type|4.0.1
                                  (required to https://nzhts.digital.health.nz/fhir/ValueSet/addressType)
                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Example<br/><b>General</b>:both
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  124. 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.
                                  Control10..*
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Example<br/><b>General</b>:137 Nowhere Street
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  126. Patient.address.district
                                  Definition

                                  The name of the administrative area (county).

                                  ShortDistrict name (aka county)
                                  Comments

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

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

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

                                  ShortSub-unit of country (abbreviations ok)
                                  Control0..01
                                  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()))
                                  130. Patient.address.period
                                  Definition

                                  Time period when address was/is in use.

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

                                  Allows addresses to be placed in historical context.

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

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

                                  ShortMarital (civil) status of a patient
                                  Control0..01
                                  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
                                  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()))
                                  134. 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..01
                                  TypeChoice of: boolean, integer
                                  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()))
                                  136. 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..0*
                                  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()))
                                  138. 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..0*
                                  TypeBackboneElement
                                  Is Modifierfalse
                                  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())
                                  141. Patient.communication
                                  Definition

                                  A language which may be used to communicate with the patient about his or her health.

                                  ShortA language which may be used to communicate with the patient about his or her health
                                  Comments

                                  If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                  Control0..0*
                                  TypeBackboneElement
                                  Is Modifierfalse
                                  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()))
                                  145. Patient.generalPractitioner
                                  Definition

                                  The reference for the General Practice that the patient is enrolled with


                                  Patient's nominated care provider.

                                  ShortReference for the Patient's enrolled general PractitionerPatient'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(PractitionerRole, Organization, Practitioner)
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate NamescareProvider
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  147. 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..01
                                  TypeReference(Organization)
                                  Is Modifierfalse
                                  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()))
                                  149. 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..0*
                                  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()))

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

                                  0. Patient
                                  Definition

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

                                  ShortInformation about an individual or animal receiving health care services
                                  Control0..*
                                  Is Modifierfalse
                                  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())
                                  nz-pat-1: only a single official NHI (Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2)
                                  nhi-nz-pat-1: only allows certain name name use values (Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') ))
                                  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
                                  SlicingThis element introduces a set of slices on Patient.contained. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                  • type @ $this
                                  • 14. Patient.contained:GP
                                    Slice NameGP
                                    Definition

                                    Contained resource for the General Practice that the patient is enrolled with

                                    ShortContained resource for the Patient's enrolled general Practitioner
                                    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..1
                                    TypePractitionerRole
                                    Is Modifierfalse
                                    Summaryfalse
                                    Alternate Namesinline resources, anonymous resources, contained resources
                                    16. Patient.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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 18. Patient.extension:ethnicity
                                      Slice Nameethnicity
                                      Definition

                                      The ethnic group or groups that a person identifies with or feels they belong to. Ethnicity is a measure of cultural affiliation as opposed to race, ancestry, nationality or citizen. Ethnicity is self-perceived and a person can belong to more than one group.

                                      The Stats New Zealand standard can be found here.

                                      ShortNZ Ethnicity
                                      Control0..6
                                      This element is affected by the following invariants: ele-1
                                      TypeExtension(NZ Ethnicity) (Extension Type: CodeableConcept)
                                      Is Modifierfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      20. 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
                                      22. Patient.extension:ethnicity.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..0
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 24. 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.nz/fhir/StructureDefinition/nz-ethnicity
                                        26. 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
                                        Control1..1
                                        TypeCodeableConcept
                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                        Is Modifierfalse
                                        Summaryfalse
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        SlicingThis element introduces a set of slices on Patient.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                        • type @ $this
                                        • 28. Patient.extension:ethnicity.value[x]:valueCodeableConcept
                                          Slice NamevalueCodeableConcept
                                          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 Hip_ethnicity_lvl_4 (2.0)
                                          (required to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0)
                                          TypeCodeableConcept
                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          30. Patient.extension:nzCitizen
                                          Slice NamenzCitizen
                                          Definition

                                          This field is used to indicate the New Zealand citizenship status of the patient

                                          ShortThis field indicates New Zealand citizenship status of the patient
                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeExtension(NZ Citizenship) (Complex Extension)
                                          Is Modifierfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          32. Patient.extension:nzCitizen.id
                                          Definition

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

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

                                            No description

                                            ShortExtension
                                            Control0..1
                                            TypeExtension
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            38. Patient.extension:nzCitizen.extension:status.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
                                            40. Patient.extension:nzCitizen.extension:status.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
                                            • 42. Patient.extension:nzCitizen.extension:status.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 Valuestatus
                                              44. Patient.extension:nzCitizen.extension:status.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..1
                                              TypeCodeableConcept
                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                              • type @ $this
                                              • 46. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept
                                                Slice NamevalueCodeableConcept
                                                Definition

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

                                                ShortValue of extension
                                                Control0..1
                                                BindingThe codes SHOULD be taken from NZ Citizenship status
                                                (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code)
                                                TypeCodeableConcept
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                48. Patient.extension:nzCitizen.extension:source
                                                Slice Namesource
                                                Definition

                                                An Extension

                                                ShortExtension
                                                Control0..1
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                50. Patient.extension:nzCitizen.extension:source.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
                                                52. Patient.extension:nzCitizen.extension:source.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
                                                • 54. Patient.extension:nzCitizen.extension:source.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 Valuesource
                                                  56. Patient.extension:nzCitizen.extension:source.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..1
                                                  TypeCodeableConcept
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                  • type @ $this
                                                  • 58. Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept
                                                    Slice NamevalueCodeableConcept
                                                    Definition

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

                                                    ShortValue of extension
                                                    Control0..1
                                                    BindingThe codes SHALL be taken from NZ Citizenship Information Source
                                                    (required to https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code)
                                                    TypeCodeableConcept
                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    60. Patient.extension:nzCitizen.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.nz/fhir/StructureDefinition/nz-citizenship
                                                    62. Patient.extension:nzCitizen.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()))
                                                    64. Patient.extension:dhb
                                                    Slice Namedhb
                                                    Definition

                                                    District Health Board relating to a NZ Healthcare Service, Location (Facility) or Patient (primary, physical home address).

                                                    ShortDistrict Health Board linked to a NZ Healthcare Service, Location or Patient
                                                    Control0..1
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(District Health Board linked to a NZ Healthcare Service, Location or Patient) (Extension Type: CodeableConcept)
                                                    Is Modifierfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    66. Patient.extension:domicile-code
                                                    Slice Namedomicile-code
                                                    Definition

                                                    NZ Domicile Code. Derived from a patient's primary physical, home address.

                                                    ShortNZ Domicile Code
                                                    Control0..0
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
                                                    Is Modifierfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    68. Patient.extension:pho
                                                    Slice Namepho
                                                    Definition

                                                    Primary Healthcare Organisation associated with a General Practice linked to a NZ Healthcare Service, Location (Facility) or Patient (GP).

                                                    ShortPrimary Healthcare Organisation
                                                    Control0..0
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(Primary Healthcare Organisation) (Extension Type: CodeableConcept)
                                                    Is Modifierfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    70. Patient.extension:sex-at-birth
                                                    Slice Namesex-at-birth
                                                    Definition

                                                    A person’s sex at the time of their birth (considered to be immutable).

                                                    ShortSex At Birth
                                                    Control0..0
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(Sex At Birth) (Extension Type: CodeableConcept)
                                                    Is Modifierfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    72. Patient.extension:iwi
                                                    Slice Nameiwi
                                                    Definition

                                                    Persons Iwi affiliation

                                                    ShortExtension
                                                    Control0..0
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(Nz_iwi) (Extension Type: CodeableConcept)
                                                    Is Modifierfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    74. Patient.extension:birthPlace
                                                    Slice NamebirthPlace
                                                    Definition

                                                    The country where the person was born

                                                    ShortExtension
                                                    Control0..1
                                                    TypeExtension(BirthPlace) (Complex Extension)
                                                    Is Modifierfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    76. 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())
                                                    78. Patient.identifier
                                                    Definition

                                                    An identifier for this patient.

                                                    ShortAn identifier for this patient
                                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                                    Control0..*
                                                    TypeIdentifier
                                                    Is Modifierfalse
                                                    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 Closed, and can be differentiated using the following discriminators:
                                                    • value @ system
                                                    • 80. 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
                                                      82. 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
                                                      • 84. 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()))
                                                        86. 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..0
                                                        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()))
                                                        88. 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.

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

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

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

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

                                                        ShortThe value that is unique
                                                        Comments

                                                        If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the 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.

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

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

                                                        ShortTime period when id is/was valid for use
                                                        Control0..0
                                                        TypePeriod
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        94. 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()))
                                                        96. Patient.identifier:NHI
                                                        Slice NameNHI
                                                        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
                                                        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()))
                                                        98. Patient.identifier:NHI.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
                                                        100. Patient.identifier:NHI.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
                                                        • 102. Patient.identifier:NHI.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 Valid use values for NHI
                                                          (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code)
                                                          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()))
                                                          104. Patient.identifier:NHI.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..0
                                                          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()))
                                                          106. Patient.identifier:NHI.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
                                                          Summarytrue
                                                          Requirements

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

                                                          Fixed Valuehttps://standards.digital.health.nz/ns/nhi-id
                                                          Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          108. Patient.identifier:NHI.value
                                                          Definition

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

                                                          ShortThe value that is unique
                                                          Comments

                                                          If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the 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.

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

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

                                                          ShortTime period when id is/was valid for use
                                                          Control0..0
                                                          TypePeriod
                                                          Is Modifierfalse
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          112. Patient.identifier:NHI.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()))
                                                          114. 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..0
                                                          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()))
                                                          116. 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.

                                                          Control0..*
                                                          TypeHumanName
                                                          Is Modifierfalse
                                                          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()))
                                                          118. 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
                                                          120. Patient.name.extension
                                                          Definition

                                                          An Extension

                                                          ShortExtension
                                                          Control1..*
                                                          TypeExtension
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 122. Patient.name.extension:information-source
                                                            Slice Nameinformation-source
                                                            Definition

                                                            The official source of information held about a patient.

                                                            ShortInformation Source
                                                            Control0..1
                                                            TypeExtension(Information Source) (Extension Type: CodeableConcept)
                                                            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())
                                                            124. Patient.name.extension:information-source.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
                                                            126. Patient.name.extension:information-source.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
                                                            • 128. Patient.name.extension:information-source.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.nz/fhir/StructureDefinition/information-source
                                                              130. Patient.name.extension:information-source.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..1
                                                              TypeCodeableConcept
                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                              Is Modifierfalse
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              SlicingThis element introduces a set of slices on Patient.name.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                              • type @ $this
                                                              • 132. Patient.name.extension:information-source.value[x]:valueCodeableConcept
                                                                Slice NamevalueCodeableConcept
                                                                Definition

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

                                                                ShortValue of extension
                                                                Control0..1
                                                                BindingThe codes SHALL be taken from Name Information Source
                                                                (required to https://nzhts.digital.health.nz/fhir/ValueSet/name-source-code)
                                                                TypeCodeableConcept
                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                Is Modifierfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                134. Patient.name.extension:preferred
                                                                Slice Namepreferred
                                                                Definition

                                                                Flag denoting whether parent item is preferred - e.g., a preferred address or telephone number.

                                                                ShortPreferred
                                                                Control1..1
                                                                TypeExtension(Preferred) (Extension Type: boolean)
                                                                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.name.extension:nhi-name-use-extra
                                                                Slice Namenhi-name-use-extra
                                                                Definition

                                                                Additional name use codes for NHI names

                                                                ShortExtension
                                                                Control0..1
                                                                TypeExtension(NameUseExtra) (Extension Type: CodeableConcept)
                                                                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())
                                                                138. Patient.name.use
                                                                Definition

                                                                Identifies the purpose for this name.

                                                                Shorttemp | nickname | 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()))
                                                                140. 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..0
                                                                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()))
                                                                142. Patient.name.family
                                                                Definition

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

                                                                ShortFamily name (often called 'Surname')
                                                                Comments

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

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

                                                                The given name and other given name(s) for the patient

                                                                ShortGiven name and other given name(s)
                                                                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..2
                                                                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()))
                                                                146. 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..*
                                                                BindingThe codes SHALL be taken from Name Prefix Codes
                                                                (required to https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code)
                                                                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()))
                                                                148. 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..0
                                                                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()))
                                                                150. 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..0
                                                                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()))
                                                                152. Patient.telecom
                                                                Definition

                                                                Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

                                                                ShortThe Paient's contact details
                                                                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..3
                                                                This element is affected by the following invariants: ele-1
                                                                TypeContactPoint(Common NZ ContactPoint datatype)
                                                                Is Modifierfalse
                                                                Requirements

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

                                                                Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                                                                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                154. 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
                                                                156. 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
                                                                • 158. Patient.telecom.extension:cp-purpose
                                                                  Slice Namecp-purpose
                                                                  Definition

                                                                  A specific purpose for which this ContactPoint dataType would be used. An example would be to indicate that this ContactPoint is used for video conferencing.

                                                                  ShortA specific purpose for which this ContactPoint dataType would be used
                                                                  Control0..0
                                                                  TypeExtension(A specific purpose for which this ContactPoint dataType would be used) (Extension Type: CodeableConcept)
                                                                  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())
                                                                  160. Patient.telecom.system
                                                                  Definition

                                                                  The system for this contact point - constrained to phone | email

                                                                  Shortphone | email
                                                                  Control0..1
                                                                  This element is affected by the following invariants: cpt-2
                                                                  BindingThe codes SHALL be taken from NHI ContactPoint System Codes
                                                                  (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhi-contact-point-system-code)
                                                                  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()))
                                                                  162. Patient.telecom.value
                                                                  Definition

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

                                                                  ShortThe actual contact point details
                                                                  Comments

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

                                                                  Control0..1
                                                                  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()))
                                                                  164. Patient.telecom.use
                                                                  Definition

                                                                  The purpose of this contact point - constrained to home | mobile

                                                                  Shorthome | mobile
                                                                  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 NHI ContactPoint Use Codes
                                                                  (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhiContactUseType)
                                                                  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()))
                                                                  166. 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..0
                                                                  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()))
                                                                  168. 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..0
                                                                  TypePeriod
                                                                  Is Modifierfalse
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  170. 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.

                                                                  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
                                                                  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()))
                                                                  172. 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
                                                                  174. 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
                                                                  • 176. Patient.gender.extension:originalText
                                                                    Slice NameoriginalText
                                                                    Definition

                                                                    The uncoded original text that was provided by the patient as their Gender

                                                                    ShortExtension
                                                                    Control0..1
                                                                    This element is affected by the following invariants: ele-1
                                                                    TypeExtension(OriginalText) (Extension Type: string)
                                                                    Is Modifierfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    178. 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
                                                                    180. 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).

                                                                    Control0..1
                                                                    Typedate
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    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
                                                                    182. 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
                                                                    184. 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
                                                                    • 186. Patient.birthDate.extension:information-source
                                                                      Slice Nameinformation-source
                                                                      Definition

                                                                      The official source of information held about a patient.

                                                                      ShortInformation Source
                                                                      Control0..1
                                                                      This element is affected by the following invariants: ele-1
                                                                      TypeExtension(Information Source) (Extension Type: CodeableConcept)
                                                                      Is Modifierfalse
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      188. Patient.birthDate.extension:information-source.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
                                                                      190. Patient.birthDate.extension:information-source.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
                                                                      • 192. Patient.birthDate.extension:information-source.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.nz/fhir/StructureDefinition/information-source
                                                                        194. Patient.birthDate.extension:information-source.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..1
                                                                        TypeCodeableConcept
                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        SlicingThis element introduces a set of slices on Patient.birthDate.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                        • type @ $this
                                                                        • 196. Patient.birthDate.extension:information-source.value[x]:valueCodeableConcept
                                                                          Slice NamevalueCodeableConcept
                                                                          Definition

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

                                                                          ShortValue of extension
                                                                          Control0..1
                                                                          BindingThe codes SHALL be taken from Date of Birth Information Source
                                                                          (required to https://nzhts.digital.health.nz/fhir/ValueSet/date-of-birth-source-code)
                                                                          TypeCodeableConcept
                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          198. 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
                                                                          200. Patient.deceased[x]
                                                                          Definition

                                                                          Indicates if the individual is deceased or not.

                                                                          ShortIndicates if the individual is deceased or not
                                                                          Comments

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

                                                                          Control0..1
                                                                          TypedateTime
                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                          Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          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()))
                                                                          202. Patient.deceased[x].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
                                                                          204. Patient.deceased[x].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.deceased[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 206. Patient.deceased[x].extension:information-source
                                                                            Slice Nameinformation-source
                                                                            Definition

                                                                            The official source of information held about a patient.

                                                                            ShortInformation Source
                                                                            Control0..1
                                                                            This element is affected by the following invariants: ele-1
                                                                            TypeExtension(Information Source) (Extension Type: CodeableConcept)
                                                                            Is Modifierfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            208. Patient.deceased[x].extension:information-source.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.deceased[x].extension:information-source.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.deceased[x].extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 212. Patient.deceased[x].extension:information-source.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.nz/fhir/StructureDefinition/information-source
                                                                              214. Patient.deceased[x].extension:information-source.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..1
                                                                              TypeCodeableConcept
                                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              SlicingThis element introduces a set of slices on Patient.deceased[x].extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                              • type @ $this
                                                                              • 216. Patient.deceased[x].extension:information-source.value[x]:valueCodeableConcept
                                                                                Slice NamevalueCodeableConcept
                                                                                Definition

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

                                                                                ShortValue of extension
                                                                                Control0..1
                                                                                BindingThe codes SHALL be taken from Date of Death Information Source
                                                                                (required to https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code)
                                                                                TypeCodeableConcept
                                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                218. Patient.deceased[x].value
                                                                                Definition

                                                                                The actual value

                                                                                ShortPrimitive value for dateTime
                                                                                Control0..1
                                                                                TypedateTime
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                220. Patient.address
                                                                                Definition

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

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

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

                                                                                Control0..*
                                                                                This element is affected by the following invariants: ele-1
                                                                                TypeAddress(NHI Address)
                                                                                Is Modifierfalse
                                                                                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()))
                                                                                222. 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
                                                                                224. 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
                                                                                • 226. Patient.address.extension:nz-geocode
                                                                                  Slice Namenz-geocode
                                                                                  Definition

                                                                                  New Zealand Geocode. This uses a different datum from that defined in the HL7 FHIR specification for a Geocode.

                                                                                  ShortA geocode using the NZ specific datum (reference point)
                                                                                  Control0..1
                                                                                  TypeExtension(NZ Geocode) (Complex Extension)
                                                                                  Is Modifierfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  228. Patient.address.extension:suburb
                                                                                  Slice Namesuburb
                                                                                  Definition

                                                                                  Suburb element of a NZ Address.

                                                                                  ShortThe suburb part of the address
                                                                                  Control0..1
                                                                                  TypeExtension(NZ Suburb) (Extension Type: string)
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  230. Patient.address.extension:building-name
                                                                                  Slice Namebuilding-name
                                                                                  Definition

                                                                                  The name of a building cited in an address.

                                                                                  ShortThe name of the building
                                                                                  Control0..1
                                                                                  TypeExtension(Building Name) (Extension Type: string)
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  232. Patient.address.extension:domicile-code
                                                                                  Slice Namedomicile-code
                                                                                  Definition

                                                                                  NZ Domicile Code. Derived from a patient's primary physical, home address.

                                                                                  ShortThe domicile code associated with this address
                                                                                  Control0..1
                                                                                  TypeExtension(NZ Domicile Code) (Extension Type: CodeableConcept)
                                                                                  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())
                                                                                  234. Patient.address.extension:notValidatedAddressReason
                                                                                  Slice NamenotValidatedAddressReason
                                                                                  Definition

                                                                                  The reason why the address has not been validated

                                                                                  ShortThe reason an address was not validated
                                                                                  Control0..1
                                                                                  TypeExtension(NotValidatedAddressReason) (Extension Type: CodeableConcept)
                                                                                  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())
                                                                                  236. Patient.address.extension:nz-address-id
                                                                                  Slice Namenz-address-id
                                                                                  Definition

                                                                                  Uniquely identifies this address as a physical entity. Will remain constant over time even if address administrative data such as DPID change

                                                                                  ShortExtension
                                                                                  Control0..1
                                                                                  TypeExtension(NzAddressId) (Extension Type: string)
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  238. Patient.address.extension:nz-address-derived
                                                                                  Slice Namenz-address-derived
                                                                                  Definition

                                                                                  Address elements that are directly derived from the address validation service

                                                                                  ShortExtension
                                                                                  Control0..1
                                                                                  TypeExtension(NhiAddressDerived) (Complex Extension)
                                                                                  Is Modifierfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  240. 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 NHI Address Use Codes
                                                                                  (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse)
                                                                                  Typecode
                                                                                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Requirements

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

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

                                                                                  Distinguishes between Residential (physical) and Postal (mailing) addresses

                                                                                  Shortpostal | physical
                                                                                  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).

                                                                                  Control1..1
                                                                                  BindingThe codes SHALL be taken from NHI Address Type Codes
                                                                                  (required to https://nzhts.digital.health.nz/fhir/ValueSet/addressType)
                                                                                  Typecode
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Example<br/><b>General</b>:both
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  244. Patient.address.text
                                                                                  Definition

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

                                                                                  ShortText representation of the address
                                                                                  Comments

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

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

                                                                                  A renderable, unencoded form.

                                                                                  Example<br/><b>General</b>:137 Nowhere Street, Erewhon 9132
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  246. 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.
                                                                                  Control1..*
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Example<br/><b>General</b>:137 Nowhere Street
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  248. Patient.address.city
                                                                                  Definition

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

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

                                                                                  The name of the administrative area (county).

                                                                                  ShortDistrict name (aka county)
                                                                                  Comments

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

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

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

                                                                                  ShortSub-unit of country (abbreviations ok)
                                                                                  Control0..0
                                                                                  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()))
                                                                                  254. Patient.address.postalCode
                                                                                  Definition

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

                                                                                  ShortPostal code for area
                                                                                  Control0..1
                                                                                  Typestring
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Alternate NamesZip
                                                                                  Example<br/><b>General</b>:9132
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  256. 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
                                                                                  BindingThe codes SHALL be taken from ISO 3166-1:2013 (2-alpha country code)
                                                                                  (required to https://nzhts.digital.health.nz/fhir/ValueSet/country-code)
                                                                                  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()))
                                                                                  258. Patient.address.period
                                                                                  Definition

                                                                                  Time period when address was/is in use.

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

                                                                                  Allows addresses to be placed in historical context.

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

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

                                                                                  ShortMarital (civil) status of a patient
                                                                                  Control0..0
                                                                                  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
                                                                                  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()))
                                                                                  262. 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..0
                                                                                  TypeChoice of: boolean, integer
                                                                                  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()))
                                                                                  264. 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..0
                                                                                  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()))
                                                                                  266. 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..0
                                                                                  TypeBackboneElement
                                                                                  Is Modifierfalse
                                                                                  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())
                                                                                  278. Patient.communication
                                                                                  Definition

                                                                                  A language which may be used to communicate with the patient about his or her health.

                                                                                  ShortA language which may be used to communicate with the patient about his or her health
                                                                                  Comments

                                                                                  If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                                                                  Control0..0
                                                                                  TypeBackboneElement
                                                                                  Is Modifierfalse
                                                                                  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()))
                                                                                  285. Patient.generalPractitioner
                                                                                  Definition

                                                                                  The reference for the General Practice that the patient is enrolled with

                                                                                  ShortReference for the Patient's enrolled general Practitioner
                                                                                  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(PractitionerRole)
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Alternate NamescareProvider
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  287. 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..0
                                                                                  TypeReference(Organization)
                                                                                  Is Modifierfalse
                                                                                  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()))
                                                                                  289. 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..0
                                                                                  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()))