CanShare models
0.1.0 - ci-build

CanShare models, published by David hay. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/davidhay25/models/ and changes regularly. See the Directory of published versions

Logical Model: Dhtest1 - Detailed Descriptions

Draft as of 2024-03-04

Definitions for the Dhtest1 logical model.

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

0. Dhtest1
ShortDhtest1
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Dhtest1.Demographics
Definition

Demographics

ShortDemographics
Control0..1
TypeBackboneElement
4. Dhtest1.Demographics.Nhi
Definition

A unique identifier assigned to a person by the NHI system.

ShortA unique identifier assigned to a person by the NHI system.
Control1..1
TypeIdentifier
6. Dhtest1.Demographics.NZName
Definition

A person’s name details

ShortA person’s name details
Control0..1
TypeBackboneElement
8. Dhtest1.Demographics.NZName.Title
Definition

The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
10. Dhtest1.Demographics.NZName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. Dhtest1.Demographics.NZName.OtherGivenName
Definition

The person’s other given names or middle name and initials, but not the family name at birth

ShortThe person’s other given names or middle name and initials, but not the family name at birth
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. Dhtest1.Demographics.NZName.FamilyName
Definition

The family name (surname) of a person as distinct from their given, second and subsequent name(s)

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Dhtest1.Demographics.NZName.NameProtectionFlag
Definition

This indicator denotes that the person’s name information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
TypeCodeableConcept
18. Dhtest1.Demographics.BirthdatePlace
Definition

A person’s birth details

ShortA person’s birth details
Control0..1
TypeBackboneElement
20. Dhtest1.Demographics.BirthdatePlace.DOB
Definition

The date on which the person was born

ShortThe date on which the person was born
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. Dhtest1.Demographics.Age
Definition

The age of the patient at the time the data was recorded.

ShortThe age of the patient at the time the data was recorded.
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. Dhtest1.Demographics.Gender
Definition

A classification of the person's gender as self-identified by the person

ShortA classification of the person's gender as self-identified by the person
Control0..1
TypeCodeableConcept
26. Dhtest1.Demographics.Sex
Definition

A classification of the person's sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).

ShortA classification of the person's sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).
Control0..1
TypeCodeableConcept
28. Dhtest1.Demographics.Ethnicity
Definition

A classification of the ethnicity of an individual person as self-identified by the person

ShortA classification of the ethnicity of an individual person as self-identified by the person
Control0..*
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
TypeCodeableConcept
30. Dhtest1.Demographics.Address
Definition

The person's current address or location details if known (in NZ CIQ address profile format.

ShortThe person's current address or location details if known (in NZ CIQ address profile format.
Control0..*
TypeBackboneElement
32. Dhtest1.Demographics.Address.Type
Definition

The type of address, e.g. residential (physical), mailing (postal)

ShortThe type of address, e.g. residential (physical), mailing (postal)
Control0..1
TypeCodeableConcept
34. Dhtest1.Demographics.Address.BuildingName
Definition

The name of the building or institution.

ShortThe name of the building or institution.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. Dhtest1.Demographics.Address.StreetAddress1
Definition

The floor, unit and/or street address details.

ShortThe floor, unit and/or street address details.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. Dhtest1.Demographics.Address.StreetAddress2
Definition

Other geographic information related to the address

ShortOther geographic information related to the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. Dhtest1.Demographics.Address.Suburb
Definition

The name of the suburb or district within a city/town.

ShortThe name of the suburb or district within a city/town.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. Dhtest1.Demographics.Address.City
Definition

PatientSummary.Address.City

ShortPatientSummary.Address.City
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/Thenameofthecityoftown.
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/Thenameofthecityoftown.
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. Dhtest1.Demographics.Address.Postcode
Definition

The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.

ShortThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. Dhtest1.Demographics.Address.CountryCode
Definition

The two character ISO code that forms part of the address.

ShortThe two character ISO code that forms part of the address.
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. Dhtest1.Demographics.Address.AddressProtectedFlag
Definition

This indicator denotes that the person’s address information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s address information is to be held ‘in confidence’
Control0..1
TypeCodeableConcept

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

0. Dhtest1
ShortDhtest1
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Dhtest1.Demographics
Definition

Demographics

ShortDemographics
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Dhtest1.Demographics.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

A unique identifier assigned to a person by the NHI system.

ShortA unique identifier assigned to a person by the NHI system.
Control1..1
TypeIdentifier
8. Dhtest1.Demographics.NZName
Definition

A person’s name details

ShortA person’s name details
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Dhtest1.Demographics.NZName.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
14. Dhtest1.Demographics.NZName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Dhtest1.Demographics.NZName.OtherGivenName
Definition

The person’s other given names or middle name and initials, but not the family name at birth

ShortThe person’s other given names or middle name and initials, but not the family name at birth
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Dhtest1.Demographics.NZName.FamilyName
Definition

The family name (surname) of a person as distinct from their given, second and subsequent name(s)

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. Dhtest1.Demographics.NZName.NameProtectionFlag
Definition

This indicator denotes that the person’s name information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
TypeCodeableConcept
22. Dhtest1.Demographics.BirthdatePlace
Definition

A person’s birth details

ShortA person’s birth details
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Dhtest1.Demographics.BirthdatePlace.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The date on which the person was born

ShortThe date on which the person was born
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. Dhtest1.Demographics.Age
Definition

The age of the patient at the time the data was recorded.

ShortThe age of the patient at the time the data was recorded.
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. Dhtest1.Demographics.Gender
Definition

A classification of the person's gender as self-identified by the person

ShortA classification of the person's gender as self-identified by the person
Control0..1
TypeCodeableConcept
32. Dhtest1.Demographics.Sex
Definition

A classification of the person's sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).

ShortA classification of the person's sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).
Control0..1
TypeCodeableConcept
34. Dhtest1.Demographics.Ethnicity
Definition

A classification of the ethnicity of an individual person as self-identified by the person

ShortA classification of the ethnicity of an individual person as self-identified by the person
Control0..*
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
TypeCodeableConcept
36. Dhtest1.Demographics.Address
Definition

The person's current address or location details if known (in NZ CIQ address profile format.

ShortThe person's current address or location details if known (in NZ CIQ address profile format.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Dhtest1.Demographics.Address.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The type of address, e.g. residential (physical), mailing (postal)

ShortThe type of address, e.g. residential (physical), mailing (postal)
Control0..1
TypeCodeableConcept
42. Dhtest1.Demographics.Address.BuildingName
Definition

The name of the building or institution.

ShortThe name of the building or institution.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. Dhtest1.Demographics.Address.StreetAddress1
Definition

The floor, unit and/or street address details.

ShortThe floor, unit and/or street address details.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. Dhtest1.Demographics.Address.StreetAddress2
Definition

Other geographic information related to the address

ShortOther geographic information related to the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. Dhtest1.Demographics.Address.Suburb
Definition

The name of the suburb or district within a city/town.

ShortThe name of the suburb or district within a city/town.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
50. Dhtest1.Demographics.Address.City
Definition

PatientSummary.Address.City

ShortPatientSummary.Address.City
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/Thenameofthecityoftown.
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/Thenameofthecityoftown.
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. Dhtest1.Demographics.Address.Postcode
Definition

The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.

ShortThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. Dhtest1.Demographics.Address.CountryCode
Definition

The two character ISO code that forms part of the address.

ShortThe two character ISO code that forms part of the address.
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
56. Dhtest1.Demographics.Address.AddressProtectedFlag
Definition

This indicator denotes that the person’s address information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s address information is to be held ‘in confidence’
Control0..1
TypeCodeableConcept

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

0. Dhtest1
ShortDhtest1
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Dhtest1.Demographics
Definition

Demographics

ShortDemographics
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Dhtest1.Demographics.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
6. Dhtest1.Demographics.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 Dhtest1.Demographics.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
8. Dhtest1.Demographics.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

A unique identifier assigned to a person by the NHI system.

ShortA unique identifier assigned to a person by the NHI system.
Control1..1
TypeIdentifier
12. Dhtest1.Demographics.NZName
Definition

A person’s name details

ShortA person’s name details
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Dhtest1.Demographics.NZName.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
16. Dhtest1.Demographics.NZName.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 Dhtest1.Demographics.NZName.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
18. Dhtest1.Demographics.NZName.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
22. Dhtest1.Demographics.NZName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. Dhtest1.Demographics.NZName.OtherGivenName
Definition

The person’s other given names or middle name and initials, but not the family name at birth

ShortThe person’s other given names or middle name and initials, but not the family name at birth
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. Dhtest1.Demographics.NZName.FamilyName
Definition

The family name (surname) of a person as distinct from their given, second and subsequent name(s)

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. Dhtest1.Demographics.NZName.NameProtectionFlag
Definition

This indicator denotes that the person’s name information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
TypeCodeableConcept
30. Dhtest1.Demographics.BirthdatePlace
Definition

A person’s birth details

ShortA person’s birth details
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Dhtest1.Demographics.BirthdatePlace.id
Definition

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

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

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The date on which the person was born

ShortThe date on which the person was born
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. Dhtest1.Demographics.Age
Definition

The age of the patient at the time the data was recorded.

ShortThe age of the patient at the time the data was recorded.
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. Dhtest1.Demographics.Gender
Definition

A classification of the person's gender as self-identified by the person

ShortA classification of the person's gender as self-identified by the person
Control0..1
TypeCodeableConcept
44. Dhtest1.Demographics.Sex
Definition

A classification of the person's sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).

ShortA classification of the person's sex characteristics such as chromosomes, hormones and reproductive organs (Stats NZ Statistical standard for gender, sex, and variations of sex characteristics).
Control0..1
TypeCodeableConcept
46. Dhtest1.Demographics.Ethnicity
Definition

A classification of the ethnicity of an individual person as self-identified by the person

ShortA classification of the ethnicity of an individual person as self-identified by the person
Control0..*
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/ethnic-group-level-4-code
TypeCodeableConcept
48. Dhtest1.Demographics.Address
Definition

The person's current address or location details if known (in NZ CIQ address profile format.

ShortThe person's current address or location details if known (in NZ CIQ address profile format.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Dhtest1.Demographics.Address.id
Definition

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

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

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

ShortAdditional content defined by implementations
Comments

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

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

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The type of address, e.g. residential (physical), mailing (postal)

ShortThe type of address, e.g. residential (physical), mailing (postal)
Control0..1
TypeCodeableConcept
58. Dhtest1.Demographics.Address.BuildingName
Definition

The name of the building or institution.

ShortThe name of the building or institution.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
60. Dhtest1.Demographics.Address.StreetAddress1
Definition

The floor, unit and/or street address details.

ShortThe floor, unit and/or street address details.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
62. Dhtest1.Demographics.Address.StreetAddress2
Definition

Other geographic information related to the address

ShortOther geographic information related to the address
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
64. Dhtest1.Demographics.Address.Suburb
Definition

The name of the suburb or district within a city/town.

ShortThe name of the suburb or district within a city/town.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
66. Dhtest1.Demographics.Address.City
Definition

PatientSummary.Address.City

ShortPatientSummary.Address.City
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/Thenameofthecityoftown.
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/Thenameofthecityoftown.
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
68. Dhtest1.Demographics.Address.Postcode
Definition

The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.

ShortThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
70. Dhtest1.Demographics.Address.CountryCode
Definition

The two character ISO code that forms part of the address.

ShortThe two character ISO code that forms part of the address.
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
72. Dhtest1.Demographics.Address.AddressProtectedFlag
Definition

This indicator denotes that the person’s address information is to be held ‘in confidence’

ShortThis indicator denotes that the person’s address information is to be held ‘in confidence’
Control0..1
TypeCodeableConcept