Create NHI Patient - Definitions - New Zealand NHI IG v1.6.1

Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-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.

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

Control 0..01

The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-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.

Short Contained, 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.

Control 0..*

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

This element introduces a set of slices on Patient.contained. The slices areUnordered and Closed, and can be differentiated using the following discriminators:

type @ $this

8. Patient.contained:GP

Slice Name GP

Definition

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

Short Contained resource for the Patient's enrolled general PractitionerContained, inline Resources

Comments

Control 0..0*

PractitionerRoleResource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

10. Patient.extension

Definition

An Extension

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

Short ExtensionAdditional 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.

Control 20..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

12. Patient.extension:ethnicity

Slice Name ethnicity

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.

Short NZ Ethnicity

Control 1..6
This element is affected by the following invariants: ele-1

Type Extension(NZ Ethnicity) (Extension Type: CodeableConcept)

Is Modifier false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

14. Patient.extension:ethnicity.extension

Definition

An Extension

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

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. Patient.extension:ethnicity.url

Definition

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

Short identifies the meaning of the extension

Comments

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

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity

18. Patient.extension:ethnicity.value[x]

Definition

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

Short Value of extension

Control 10..1

Type CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Patient.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:

type @ $this

20. Patient.extension:ethnicity.value[x]:valueCodeableConcept

Slice Name valueCodeableConcept

Definition

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

Short Value of extension

Control 10..1

Binding The codes SHALL be taken from For codes, see Hip_ethnicity_lvl_4 (2.0)
(required to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code|2.0)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

22. Patient.extension:nzCitizen

Slice Name nzCitizen

Definition

New Zealand citizenship

Short NZ Citizenship

Control 1..1
This element is affected by the following invariants: ele-1

Type Extension(NZ Citizenship) (Complex Extension)

Is Modifier false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

24. Patient.extension:nzCitizen.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 20..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

26. Patient.extension:nzCitizen.extension:status

Slice Name status

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Control 10..1*

Is Modifier false

Summary false

28. Patient.extension:nzCitizen.extension:status.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

30. Patient.extension:nzCitizen.extension:status.url

Definition

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

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value status

32. Patient.extension:nzCitizen.extension:status.value[x]

Definition

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

Short Value of extension

Control 10..1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Patient.extension.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:

type @ $this

34. Patient.extension:nzCitizen.extension:status.value[x]:valueCodeableConcept

Slice Name valueCodeableConcept

Definition

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

Short Value of extension

Control 10..1

Binding The codes SHOULD be taken from For codes, see NZ Citizenship status
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-status-code)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

36. Patient.extension:nzCitizen.extension:source

Slice Name source

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Control 10..1*

Is Modifier false

Summary false

38. Patient.extension:nzCitizen.extension:source.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

40. Patient.extension:nzCitizen.extension:source.url

Definition

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

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value source

42. Patient.extension:nzCitizen.extension:source.value[x]

Definition

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

Short Value of extension

Control 10..1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Patient.extension.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:

type @ $this

44. Patient.extension:nzCitizen.extension:source.value[x]:valueCodeableConcept

Slice Name valueCodeableConcept

Definition

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

Short Value of extension

Control 10..1

Binding The codes SHALL be taken from For codes, see NZ Citizenship Information Source
(required to https://nzhts.digital.health.nz/fhir/ValueSet/nz-citizenship-source-code)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

46. Patient.extension:nzCitizen.url

Definition

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

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship

48. Patient.extension:nzCitizen.value[x]

Definition

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

Short Value of extension

Control 0..01

Type Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

50. Patient.extension:dhb

Slice Name dhb

Definition

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

Short District Health Board linked to a NZ Healthcare Service, Location or Patient

Control 0..0
This element is affected by the following invariants: ele-1

Type Extension(District Health Board linked to a NZ Healthcare Service, Location or Patient) (Extension Type: CodeableConcept)

Is Modifier false

52. Patient.extension:domicile-code

Slice Name domicile-code

Definition

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

Short NZ Domicile Code

Control 0..0
This element is affected by the following invariants: ele-1

Type Extension(NZ Domicile Code) (Extension Type: CodeableConcept)

Is Modifier false

54. Patient.extension:pho

Slice Name pho

Definition

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

Short Primary Healthcare Organisation

Control 0..0
This element is affected by the following invariants: ele-1

Type Extension(Primary Healthcare Organisation) (Extension Type: CodeableConcept)

Is Modifier false

56. Patient.extension:sex-at-birth

Slice Name sex-at-birth

Definition

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

Short Sex At Birth

Control 0..0
This element is affected by the following invariants: ele-1

Type Extension(Sex At Birth) (Extension Type: CodeableConcept)

Is Modifier false

58. Patient.extension:iwi

Slice Name iwi

Definition

Persons Iwi affiliation

Short Extension

Control 0..0
This element is affected by the following invariants: ele-1

Type Extension(Nz_iwi) (Extension Type: CodeableConcept)

Is Modifier false

60. Patient.extension:birthPlace

Slice Name birthPlace

Definition

The country where the person was born

Short Extension

Control 0..1

Type Extension(BirthPlace) (Complex Extension)

Is Modifier false

62. Patient.extension:birthPlace.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 20..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

64. Patient.extension:birthPlace.extension:country

Slice Name country

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Control 10..1*

Is Modifier false

Summary false

66. Patient.extension:birthPlace.extension:country.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

68. Patient.extension:birthPlace.extension:country.url

Definition

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

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value country

70. Patient.extension:birthPlace.extension:place-of-birth

Slice Name place-of-birth

Definition

No description

Short ExtensionAdditional content defined by implementations

Control 0..1*

Is Modifier false

Summary false

72. Patient.extension:birthPlace.extension:place-of-birth.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

74. Patient.extension:birthPlace.extension:place-of-birth.url

Definition

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

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value place-of-birth

76. Patient.extension:birthPlace.extension:source

Slice Name source

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Control 10..1*

Is Modifier false

Summary false

78. Patient.extension:birthPlace.extension:source.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

80. Patient.extension:birthPlace.extension:source.url

Definition

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

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value source

82. Patient.extension:birthPlace.extension:source.value[x]

Definition

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

Short Value of extension

Control 10..1

Binding The codes SHALL be taken from For codes, see Country of Birth Information Source
(required to https://nzhts.digital.health.nz/fhir/ValueSet/country-of-birth-source-code)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

84. Patient.extension:birthPlace.url

Definition

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

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org.nz/fhir/StructureDefinition/birth-place

86. Patient.extension:birthPlace.value[x]

Definition

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

Short Value of extension

Control 0..01

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

Short Extensions that cannot be ignored

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

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 Names extensions, user content

90. Patient.identifier

Definition

An identifier for this patient.

Short An identifier for this patient

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Identifier

Is Modifier false

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Patient.identifier. The slices areUnordered and Closed, and can be differentiated using the following discriminators:

value @ system

92. Patient.identifier:NHI

Slice Name NHI

Definition

An identifier for this patient.

Short An identifier for this patient

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..0*

Identifier

Is Modifier false

Summary true

Requirements

Patients are almost always assigned specific numerical identifiers.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

Short Whether 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.

Control 0..01

boolean

Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Meaning if Missing This resource is generally assumed to be active if no value is provided for the active element

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

100. Patient.name

Definition

A name associated with the individual.

Short A 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.

Control 10..1*

HumanName

Is Modifier false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF (name.where(use='temp').exists() implies (extension.where((url='http://hl7.org.nz/fhir/StructureDefinition/information-source') and (valueCodeableConcept.coding.code ='NPRF')).exists()))

102. Patient.name.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 20..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

104. Patient.name.extension:information-source

Slice Name information-source

Definition

The official source of information held about a patient.

Short Information Source

Control 1..1

Type Extension(Information Source) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

106. Patient.name.extension:information-source.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

108. Patient.name.extension:information-source.url

Definition

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

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org.nz/fhir/StructureDefinition/information-source

110. Patient.name.extension:information-source.value[x]

Definition

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

Short Value of extension

Control 10..1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Patient.name.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:

type @ $this

112. Patient.name.extension:information-source.value[x]:valueCodeableConcept

Slice Name valueCodeableConcept

Definition

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

Short Value of extension

Control 10..1

Binding The codes SHALL be taken from For codes, see Name Information Source
(required to https://nzhts.digital.health.nz/fhir/ValueSet/name-source-code)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

114. Patient.name.extension:preferred

Slice Name preferred

Definition

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

Short Preferred

Control 1..1

Type Extension(Preferred) (Extension Type: boolean)

Is Modifier false

Summary false

116. Patient.name.extension:nhi-name-use-extra

Slice Name nhi-name-use-extra

Definition

Additional name use codes for NHI names

Short Extension

Control 0..1

Type Extension(NameUseExtra) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

118. Patient.name.use

Definition

Identifies the purpose for this name.

Comments

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

Control 0..1

The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

The use of a human name.

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

120. Patient.name.text

Definition

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

Short Text representation of the full name

Comments

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

Control 0..01

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

A renderable, unencoded form.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

122. Patient.name.given

Definition

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

Given name.

Short Given name and other given name(s)Given names (not always 'first'). Includes middle names

Comments

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

Control 0..2*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names first name, middle name

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

124. Patient.name.prefix

Definition

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

Short Parts that come before the name

Control 0..1*

Binding The codes SHALL be taken from For codes, see Name Prefix Codes
(required to https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

126. Patient.name.suffix

Definition

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

Short Parts that come after the name

Control 0..0*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

128. Patient.name.period

Definition

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

Short Time period when name was/is in use

Control 0..01

Period

Is Modifier false

Summary true

Requirements

Allows names to be placed in historical context.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

Short The Paient's contact detailsA contact detail for the individual

Comments

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

Control 0..0*
This element is affected by the following invariants: ele-1

Type ContactPoint(Common NZ ContactPoint datatype)

Is Modifier false

Requirements

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

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

136. Patient.gender

Definition

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

Short male | 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.

Control 10..1

The codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
(required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)

The gender of a person used for administrative purposes.

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

138. Patient.gender.extension:originalText

Slice Name originalText

Definition

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

Short Extension

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(OriginalText) (Extension Type: string)

Is Modifier false

140. Patient.birthDate

Definition

The date of birth for the individual.

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

Control 10..1

date

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Age of the individual drives many clinical processes.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

LOINC Code 21112-8

142. Patient.birthDate.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 10..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.birthDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

144. Patient.birthDate.extension:information-source

Slice Name information-source

Definition

The official source of information held about a patient.

Short Information Source

Control 1..1
This element is affected by the following invariants: ele-1

Type Extension(Information Source) (Extension Type: CodeableConcept)

Is Modifier false

146. Patient.birthDate.extension:information-source.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.birthDate.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

148. Patient.birthDate.extension:information-source.url

Definition

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

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org.nz/fhir/StructureDefinition/information-source

150. Patient.birthDate.extension:information-source.value[x]

Definition

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

Short Value of extension

Control 10..1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Patient.birthDate.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:

type @ $this

152. Patient.birthDate.extension:information-source.value[x]:valueCodeableConcept

Slice Name valueCodeableConcept

Definition

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

Short Value of extension

Control 10..1

Binding The codes SHALL be taken from For codes, see Date of Birth Information Source
(required to https://nzhts.digital.health.nz/fhir/ValueSet/date-of-birth-source-code)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

154. Patient.deceased[x]

Definition

Indicates if the individual is deceased or not.

Short Indicates if the individual is deceased or not

Comments

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

Control 0..1

Type dateTime, boolean

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension

Summary true

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.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

156. Patient.deceased[x].extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 10..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This 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

158. Patient.deceased[x].extension:information-source

Slice Name information-source

Definition

The official source of information held about a patient.

Short Information Source

Control 1..1
This element is affected by the following invariants: ele-1

Type Extension(Information Source) (Extension Type: CodeableConcept)

Is Modifier false

160. Patient.deceased[x].extension:information-source.extension

Definition

An Extension

Short ExtensionAdditional content defined by implementations

Comments

Control 0..0*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Patient.deceased[x].extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

162. Patient.deceased[x].extension:information-source.url

Definition

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

Short identifies the meaning of the extension

Comments

Control 1..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value http://hl7.org.nz/fhir/StructureDefinition/information-source

164. Patient.deceased[x].extension:information-source.value[x]

Definition

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

Short Value of extension

Control 10..1

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

This element introduces a set of slices on Patient.deceased[x].extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:

type @ $this

166. Patient.deceased[x].extension:information-source.value[x]:valueCodeableConcept

Slice Name valueCodeableConcept

Definition

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

Short Value of extension

Control 10..1

Binding The codes SHALL be taken from For codes, see Date of Death Information Source
(required to https://nzhts.digital.health.nz/fhir/ValueSet/dod-information-source-code)

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

Short An 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.

Control 10..1*
This element is affected by the following invariants: ele-1

Type Address(NHI Address)

Is Modifier false

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

170. Patient.address.extension:nz-geocode

Slice Name nz-geocode

Definition

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

Short A geocode using the NZ specific datum (reference point)

Control 0..1

Type Extension(NZ Geocode) (Complex Extension)

Is Modifier false

172. Patient.address.extension:suburb

Slice Name suburb

Definition

Suburb element of a NZ Address.

Short The suburb part of the address

Control 0..1

Type Extension(NZ Suburb) (Extension Type: string)

Is Modifier false

Summary false

174. Patient.address.extension:building-name

Slice Name building-name

Definition

The name of a building cited in an address.

Short The name of the building

Control 0..1

Type Extension(Building Name) (Extension Type: string)

Is Modifier false

Summary false

176. Patient.address.extension:domicile-code

Slice Name domicile-code

Definition

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

Short The domicile code associated with this address

Control 0..1

Type Extension(NZ Domicile Code) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

178. Patient.address.extension:notValidatedAddressReason

Slice Name notValidatedAddressReason

Definition

The reason why the address has not been validated

Short The reason an address was not validated

Control 0..1

Type Extension(NotValidatedAddressReason) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

180. Patient.address.extension:nz-address-id

Slice Name nz-address-id

Definition

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

Short Extension

Control 0..1

Type Extension(NzAddressId) (Extension Type: string)

Is Modifier false

Summary false

182. Patient.address.extension:nz-address-derived

Slice Name nz-address-derived

Definition

Address elements that are directly derived from the address validation service

Short Extension

Control 0..1

Type Extension(NhiAddressDerived) (Complex Extension)

Is Modifier false

184. Patient.address.use

Definition

The purpose of this address.

Short home | work | temp | old | billing - purpose of this address

Comments

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

Control 10..1

Binding The codes SHALL be taken from NHI Address Use Codeshttp://hl7.org/fhir/ValueSet/address-use|4.0.1
(required to https://nzhts.digital.health.nz/fhir/ValueSet/nhiaddressUse)

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Example General:home

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

186. Patient.address.type

Definition

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

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

Short postal | physicalpostal | physical | both

Comments

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

Control 10..1

Binding The codes SHALL be taken from NHI Address Type Codeshttp://hl7.org/fhir/ValueSet/address-type|4.0.1
(required to https://nzhts.digital.health.nz/fhir/ValueSet/addressType)

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General:both

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

188. Patient.address.line

Definition

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

Short Street name, number, direction & P.O. Box etc.

Control 10..2*

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Example General:137 Nowhere Street

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

190. Patient.address.district

Definition

The name of the administrative area (county).

Short District name (aka county)

Comments

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

Control 0..01

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names County

Example General:Madison

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

192. Patient.address.state

Definition

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

Short Sub-unit of country (abbreviations ok)

Control 0..01

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Alternate Names Province, Territory

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

194. Patient.address.period

Definition

Time period when address was/is in use.

Short Time period when address was/is in use

Control 0..01

Period

Is Modifier false

Summary true

Requirements

Allows addresses to be placed in historical context.

Example General:{ "start" : "2010-03-23", "end" : "2010-07-01" }

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

196. Patient.maritalStatus

Definition

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

Short Marital (civil) status of a patient

Control 0..01

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

CodeableConcept

Is Modifier false

Summary false

Requirements

Most, if not all systems capture it.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

198. Patient.multipleBirth[x]

Definition

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

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

Control 0..01

Type Choice of: boolean, integer

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

200. Patient.photo

Definition

Image of the patient.

Short Image of the patient

Comments

Guidelines:

Use id photos, not clinical photos.
Limit dimensions to thumbnail.
Keep byte count low to ease resource updates.

Control 0..0*

Attachment

Is Modifier false

Summary false

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

202. Patient.contact

Definition

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

Short A 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.

Control 0..0*

BackboneElement

Is Modifier false

Summary false

Requirements

Need to track people you can contact about the patient.

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

205. Patient.communication

Definition

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

Short A 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.

Control 0..0*

BackboneElement

Is Modifier false

Summary false

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.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

209. Patient.generalPractitioner

Definition

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

Patient's nominated care provider.

Short Reference for the Patient's enrolled general PractitionerPatient's nominated primary care provider

Comments

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

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

Control 0..0*

Type Reference(PractitionerRole, Organization, Practitioner)

Is Modifier false

Summary false

Alternate Names careProvider

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

211. Patient.managingOrganization

Definition

Organization that is the custodian of the patient record.

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

Control 0..01

Type Reference(Organization)

Is Modifier false

Summary true

Requirements

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

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

213. Patient.link

Definition

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

Short Link to another patient resource that concerns the same actual person

Comments

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

Control 0..0*

BackboneElement

Is Modifier true 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'

Summary true

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.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. Patient

Definition

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

Short Information about an individual or animal receiving health care services

Control 0..*

Is Modifier false

Summary false

Alternate Names SubjectOfCare Client Resident

Invariants dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
nz-pat-1: only a single official NHI (Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2)
nhi-nz-pat-1: only allows certain name name use values (Patient.name.where( (use.empty()) or (use='nickname') or (use = 'maiden') or (use = 'temp') ))
EM02106: A Patient must have an active Preferred Name (Patient.name.extension.where((url = 'http://hl7.org/fhir/StructureDefinition/iso21090-preferred') and (valueBoolean=true)).count()=1)
EM02201: A Patient must have a primary residential address (Patient.address.where( (use = 'home') and (type = 'physical')).count()=1)
EM02101: A Patient name must contain either a given or family name (Patient.name.all(given.exists() and family.exists()))
EM07225: If name-use-extra is supplied name-use must be temp, and source NPRF (name.where(use='temp').exists() implies (extension.where((url='http://hl7.org.nz/fhir/StructureDefinition/information-source') and (valueCodeableConcept.coding.code ='NPRF')).exists()))
EM07212: birthdate must be after 1 January 1900, and not a future date ((birthDate > @1900-01-01) and (birthDate < now()))
EM07212-1: Date of Death cannot be a future date (deceasedDateTime < now())
EM07215: Date of Death must be greater than, or equal to Date of Birth (deceasedDateTime >= birthDate)

2. Patient.id

Definition

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

Short Logical 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.

Control 0..1

Is Modifier false

Summary true

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.

Short Metadata about the resource

Control 0..1