Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: DHOPatientUpdate - Detailed Descriptions

Active as of 2026-02-16

Definitions for the DHOPatientUpdate resource profile.

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

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)
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..01
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.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..01
BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
(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()))
6. 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..0*
TypeResource
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..0
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:nzCitizen
Slice NamenzCitizen
Definition

New Zealand citizenship

ShortIs this person a New Zealand citizen
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())
12. 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())
14. Patient.extension:domicile-code
Slice Namedomicile-code
Definition

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

ShortNZ Domicile Code
Control0..1
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())
16. 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..1
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())
18. 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..1
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())
20. Patient.extension:iwi
Slice Nameiwi
Definition

Persons Iwi affiliation

ShortExtension
Control0..*
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())
22. Patient.extension:acc-patient-occupation
Slice Nameacc-patient-occupation
Definition

Codes to describe a patient's occupation, using ACC's patient occupation codeset.

Note that the current ValueSet binding contains codes from NZSC099. ACC are planning to update this ValueSet to base the codes on ANZSCO at the request of Stats NZ (Timing TBC), so the binding strength has been left as 'example'.

ShortExtension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(AccPatientOccupation) (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())
24. Patient.extension:messaging-address
Slice Namemessaging-address
Definition

The address to where electronic communications might be sent. For historical reasons, there is an overlap with edi-address.

ShortMessaging Address
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Messaging Address) (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())
26. Patient.extension:nz-residency
Slice Namenz-residency
Definition

NZ Residency status

ShortExtension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(NZResidency) (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())
28. Patient.extension:interpreter-required
Slice Nameinterpreter-required
Definition

Indicates whether an interpreter is required to facilitate communication in a healthcare setting. While this extension is named patient-interpreterRequired for backwards compatibility, it may also be used on RelatedPerson, Practitioner, and Encounter.

ShortWhether an interpreter is required
Comments

The individual does not speak the default language of the organization, and hence requires an interpreter. If other languages are in the Communications list, then that would be the type of interpreter required.

While this extension is named patient-interpreterRequired for backwards compatibility, it may also be used on RelatedPerson, Practitioner, and Encounter.

When used on Patient, RelatedPerson, or Practitioner, it indicates a default or assumed need for an interpreter. When used on Encounter, it indicates that an interpreter is needed to facilitate communication between some participants in that Encounter. The encounter-level evaluation of whether an interpreter is needed might involve evaluating the language proficiencies of the participants.

Control0..1
TypeExtension(Interpreter Required) (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())
30. 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())
32. 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 Open, and can be differentiated using the following discriminators:
  • value @ system
  • 34. 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()))
    36. 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()))
    38. 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
    ExampleGeneral: http://www.acme.com/identifiers/patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Patient.active
    Definition

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

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

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

    ShortWhether this patient's record is in active use
    Comments

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

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

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

    Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. 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..0*
    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()))
    46. 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.

    ShortDetails of a Technology mediated contact point (phone, fax, email, etc.)A contact detail for the individual
    Comments

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

    Control10..*
    This element is affected by the following invariants: ele-1
    TypeContactPoint(Common NZ ContactPoint datatype)
    Is Modifierfalse
    Must Supporttrue
    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()))
    48. 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..01
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    50. Patient.telecom.extension
    Definition

    An Extension


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

    ShortExtensionAdditional content defined by implementations
    Comments

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

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

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

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

      Telecommunications form for contact point.

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

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

      ShortThe actual contact point details
      Comments

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

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

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

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

      Identifies the purpose for the contact point.

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

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

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

      Use of contact point.

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

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

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      60. 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()))
      62. 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..01
      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
      65. 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()))
      SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
      • type @ $this
      • 67. Patient.deceased[x]:deceasedBoolean
        Slice NamedeceasedBoolean
        Definition

        Indicates if the individual is deceased or not.

        ShortIndicates if the individual is deceased or not
        Comments

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

        Control0..01
        Typeboolean, dateTime
        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()))
        69. Patient.deceased[x]:deceasedDateTime
        Slice NamedeceasedDateTime
        Definition

        Indicates if the individual is deceased or not.

        ShortIndicates if the individual is deceased or not
        Comments

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

        Control0..1
        TypedateTime, boolean
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        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()))
        71. Patient.deceased[x]:deceasedDateTime.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())
        73. 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..0*
        This element is affected by the following invariants: ele-1
        TypeAddress(Common NZ Address datatype)
        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()))
        75. 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()))
        77. Patient.multipleBirth[x]
        Definition

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

        ShortWhether patient is part of a multiple birth
        Comments

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

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

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

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

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

          ShortWhether patient is part of a multiple birth
          Comments

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

          Control0..01
          Typeboolean, 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()))
          81. 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()))
          83. 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())
          86. 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()))
          90. Patient.generalPractitioner
          Definition

          Patient's nominated care provider.

          ShortPatient's nominated primary care provider
          Comments

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

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

          Control0..0*
          TypeReference(Organization, Practitioner, PractitionerRole)
          Is Modifierfalse
          Summaryfalse
          Alternate NamescareProvider
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          92. 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()))
          94. 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 foundhere

          0. Patient
          2. Patient.meta
          4. Patient.meta.source
          Definition

          Captures the source of the record. This must contain the HPIFacilityID e.g. https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A

          ShortHPI Facility ID from where the record is sourced
          Control1..?
          6. Patient.meta.tag
          ShortCorrelation-id where the record is sourced
          Control1..?
          SlicingThis element introduces a set of slices on Patient.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ system
          • 8. Patient.meta.tag:correlationId
            Slice NamecorrelationId
            Control1..1
            10. Patient.meta.tag:correlationId.system
            Control1..?
            Fixed Valuehttps://hub.services.digital.health.nz/ns/correlation-id
            12. Patient.meta.tag:correlationId.code
            Control1..?
            14. Patient.implicitRules
            Control0..0
            16. Patient.language
            Control0..0
            18. Patient.contained
            Control0..0
            20. Patient.extension:ethnicity
            Slice Nameethnicity
            Control0..0
            22. Patient.extension:interpreter-required
            Slice Nameinterpreter-required
            Control0..1
            TypeExtension(Interpreter Required) (Extension Type: boolean)
            24. Patient.name
            Control0..0
            26. Patient.telecom
            Control1..?
            Must Supporttrue
            28. Patient.telecom.id
            Control0..0
            30. Patient.telecom.extension
            Control0..0
            32. Patient.telecom.extension:cp-purpose
            Slice Namecp-purpose
            Control0..0
            34. Patient.telecom.system
            Control1..?
            Must Supporttrue
            36. Patient.telecom.value
            Control1..?
            Must Supporttrue
            38. Patient.telecom.use
            Control1..?
            Must Supporttrue
            40. Patient.telecom.period
            Control0..0
            42. Patient.birthDate
            Control0..0
            LOINC Code
            44. Patient.deceased[x]:deceasedBoolean
            Slice NamedeceasedBoolean
            Control0..0
            Typeboolean
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            46. Patient.address
            Control0..0
            48. Patient.maritalStatus
            Control0..0
            50. Patient.multipleBirth[x]
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            SlicingThis element introduces a set of slices on Patient.multipleBirth[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • type @ $this
            • 52. Patient.multipleBirth[x]:multipleBirthBoolean
              Slice NamemultipleBirthBoolean
              Control0..0
              Typeboolean
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              54. Patient.photo
              Control0..0
              56. Patient.contact
              Control0..0
              58. Patient.communication
              Control0..0
              60. Patient.generalPractitioner
              Control0..0
              62. Patient.managingOrganization
              Control0..0
              64. Patient.link
              Control0..0

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

              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)
              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.meta.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
              8. Patient.meta.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.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 10. Patient.meta.versionId
                Definition

                The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

                ShortVersion specific identifier
                Comments

                The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

                Control0..1
                Typeid
                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()))
                12. Patient.meta.lastUpdated
                Definition

                When the resource last changed - e.g. when the version changed.

                ShortWhen the resource version last changed
                Comments

                This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                Control0..1
                Typeinstant
                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()))
                14. Patient.meta.source
                Definition

                Captures the source of the record. This must contain the HPIFacilityID e.g. https://standards.digital.health.nz/ns/hpi-facility-id/FZZ111-A

                ShortHPI Facility ID from where the record is sourced
                Comments

                In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

                This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

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

                A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                ShortProfiles this resource claims to conform to
                Comments

                It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                Control0..*
                Typecanonical(StructureDefinition)
                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()))
                18. Patient.meta.security
                Definition

                Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                ShortSecurity Labels applied to this resource
                Comments

                The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                Control0..*
                BindingUnless not suitable, these codes SHALL be taken from All Security Labels
                (extensible to http://hl7.org/fhir/ValueSet/security-labels)

                Security Labels from the Healthcare Privacy and Security Classification System.

                TypeCoding
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                20. Patient.meta.tag
                Definition

                Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                ShortCorrelation-id where the record is sourced
                Comments

                The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                Control1..*
                BindingFor example codes, see CommonTags
                (example to http://hl7.org/fhir/ValueSet/common-tags)

                Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

                TypeCoding
                Is Modifierfalse
                Summarytrue
                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.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ system
                • 22. Patient.meta.tag:correlationId
                  Slice NamecorrelationId
                  Definition

                  Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                  ShortTags applied to this resource
                  Comments

                  The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                  Control1..1
                  BindingFor example codes, see CommonTags
                  (example to http://hl7.org/fhir/ValueSet/common-tags)

                  Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

                  TypeCoding
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  24. Patient.meta.tag:correlationId.id
                  Definition

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

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

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

                    ShortIdentity of the terminology system
                    Comments

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

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

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

                    Fixed Valuehttps://hub.services.digital.health.nz/ns/correlation-id
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    30. Patient.meta.tag:correlationId.version
                    Definition

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

                    ShortVersion of the system - if relevant
                    Comments

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

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

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

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

                    Need to refer to a particular code in the system.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    34. Patient.meta.tag:correlationId.display
                    Definition

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

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

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

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    36. Patient.meta.tag:correlationId.userSelected
                    Definition

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

                    ShortIf this coding was chosen directly by the user
                    Comments

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

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

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

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    38. 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..0
                    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()))
                    40. 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..0
                    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()))
                    42. 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()))
                    44. 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..0
                    TypeResource
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesinline resources, anonymous resources, contained resources
                    46. 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
                    • 48. 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..0
                      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())
                      50. Patient.extension:nzCitizen
                      Slice NamenzCitizen
                      Definition

                      New Zealand citizenship

                      ShortIs this person a New Zealand citizen
                      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())
                      52. 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())
                      54. Patient.extension:domicile-code
                      Slice Namedomicile-code
                      Definition

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

                      ShortNZ Domicile Code
                      Control0..1
                      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())
                      56. 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..1
                      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())
                      58. 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..1
                      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())
                      60. Patient.extension:iwi
                      Slice Nameiwi
                      Definition

                      Persons Iwi affiliation

                      ShortExtension
                      Control0..*
                      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())
                      62. Patient.extension:acc-patient-occupation
                      Slice Nameacc-patient-occupation
                      Definition

                      Codes to describe a patient's occupation, using ACC's patient occupation codeset.

                      Note that the current ValueSet binding contains codes from NZSC099. ACC are planning to update this ValueSet to base the codes on ANZSCO at the request of Stats NZ (Timing TBC), so the binding strength has been left as 'example'.

                      ShortExtension
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeExtension(AccPatientOccupation) (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())
                      64. Patient.extension:messaging-address
                      Slice Namemessaging-address
                      Definition

                      The address to where electronic communications might be sent. For historical reasons, there is an overlap with edi-address.

                      ShortMessaging Address
                      Control0..*
                      This element is affected by the following invariants: ele-1
                      TypeExtension(Messaging Address) (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())
                      66. Patient.extension:nz-residency
                      Slice Namenz-residency
                      Definition

                      NZ Residency status

                      ShortExtension
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      TypeExtension(NZResidency) (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())
                      68. Patient.extension:interpreter-required
                      Slice Nameinterpreter-required
                      Definition

                      Indicates whether an interpreter is required to facilitate communication in a healthcare setting. While this extension is named patient-interpreterRequired for backwards compatibility, it may also be used on RelatedPerson, Practitioner, and Encounter.

                      ShortWhether an interpreter is required
                      Comments

                      The individual does not speak the default language of the organization, and hence requires an interpreter. If other languages are in the Communications list, then that would be the type of interpreter required.

                      While this extension is named patient-interpreterRequired for backwards compatibility, it may also be used on RelatedPerson, Practitioner, and Encounter.

                      When used on Patient, RelatedPerson, or Practitioner, it indicates a default or assumed need for an interpreter. When used on Encounter, it indicates that an interpreter is needed to facilitate communication between some participants in that Encounter. The encounter-level evaluation of whether an interpreter is needed might involve evaluating the language proficiencies of the participants.

                      Control0..1
                      TypeExtension(Interpreter Required) (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())
                      70. 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())
                      72. 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 Open, and can be differentiated using the following discriminators:
                      • value @ system
                      • 74. 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()))
                        76. 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
                        78. 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
                        • 80. 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()))
                          82. 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..1
                          BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                          (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

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

                          TypeCodeableConcept
                          Is Modifierfalse
                          Summarytrue
                          Requirements

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

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          84. 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
                          ExampleGeneral: http://www.acme.com/identifiers/patient
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          86. 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
                          ExampleGeneral: 123456
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          88. 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..1
                          TypePeriod
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          90. 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()))
                          92. Patient.active
                          Definition

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

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

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

                          ShortWhether this patient's record is in active use
                          Comments

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

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

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

                          Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          94. 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..0
                          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()))
                          106. Patient.telecom
                          Definition

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

                          ShortDetails of a Technology mediated contact point (phone, fax, email, etc.)
                          Comments

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

                          Control1..*
                          This element is affected by the following invariants: ele-1
                          TypeContactPoint(Common NZ ContactPoint datatype)
                          Is Modifierfalse
                          Must Supporttrue
                          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()))
                          108. 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..0
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          110. Patient.telecom.extension
                          Definition

                          An Extension

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

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

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

                            Telecommunications form for contact point.

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

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

                            ShortThe actual contact point details
                            Comments

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

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

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

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

                            Identifies the purpose for the contact point.

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

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

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

                            Use of contact point.

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

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

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

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

                            ShortSpecify preferred order of use (1 = highest)
                            Comments

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

                            Control0..1
                            TypepositiveInt
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            122. 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()))
                            124. 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()))
                            126. 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
                            128. 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
                            • 130. Patient.gender.extension:genderOriginalText
                              Slice NamegenderOriginalText
                              Definition

                              Text provided by the person with the choice of 'Another gender' (The FHIR AdministrativeGender CodeSystem codes this as 'other').

                              ShortExtension
                              Control0..1
                              This element is affected by the following invariants: ele-1
                              TypeExtension(GenderOriginalText) (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())
                              132. 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
                              134. 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..0
                              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
                              140. 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()))
                              SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                              • type @ $this
                              • 142. Patient.deceased[x]:deceasedBoolean
                                Slice NamedeceasedBoolean
                                Definition

                                Indicates if the individual is deceased or not.

                                ShortIndicates if the individual is deceased or not
                                Comments

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

                                Control0..0
                                Typeboolean
                                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()))
                                144. Patient.deceased[x]:deceasedDateTime
                                Slice NamedeceasedDateTime
                                Definition

                                Indicates if the individual is deceased or not.

                                ShortIndicates if the individual is deceased or not
                                Comments

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

                                Control0..1
                                TypedateTime
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                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()))
                                146. Patient.deceased[x]:deceasedDateTime.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
                                148. Patient.deceased[x]:deceasedDateTime.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
                                • 150. Patient.deceased[x]:deceasedDateTime.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())
                                  152. Patient.deceased[x]:deceasedDateTime.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
                                  154. 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..0
                                  This element is affected by the following invariants: ele-1
                                  TypeAddress(Common NZ Address datatype)
                                  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()))
                                  156. 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()))
                                  158. Patient.multipleBirth[x]
                                  Definition

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

                                  ShortWhether patient is part of a multiple birth
                                  Comments

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

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

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

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

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

                                    ShortWhether patient is part of a multiple birth
                                    Comments

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

                                    Control0..0
                                    Typeboolean
                                    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()))
                                    162. 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()))
                                    164. 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())
                                    176. 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()))
                                    183. Patient.generalPractitioner
                                    Definition

                                    Patient's nominated care provider.

                                    ShortPatient's nominated primary care provider
                                    Comments

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

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

                                    Control0..0
                                    TypeReference(Organization, Practitioner, PractitionerRole)
                                    Is Modifierfalse
                                    Summaryfalse
                                    Alternate NamescareProvider
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    185. 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()))
                                    187. 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()))