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: Patient

Official URL: http://example.org/StructureDefinition/Patient-cs Version: 0.1.0
Draft as of 2024-03-04 Computable Name: Patient_cs

Identifying and demographic details about the patient.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient-cs 0..*BasePatient
Instances of this logical model are not marked to be the target of a Reference
... Nhi 1..1IdentifierA unique identifier assigned to a person by the NHI system.
... NZName 1..1BackboneElementA person’s name details
.... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
.... GivenName 0..1stringThe person’s forename or given name at birth
.... OtherGivenName 0..*stringThe person’s other given names or middle name and initials, but not the family name at birth
.... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
.... NameSuffix 0..*stringThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
.... PreferredNameIndicator 0..1CodeableConceptAn indicator used to denote that a particular person name is the person’s preferred name
.... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
.... age 0..1stringPatient.NZName.age
.... NameInfoSource 0..1CodeableConceptA code indicating the name source
.... NameEffectivePeriod 0..1PeriodThe date(s) the name is effective from and/or to
... BirthdatePlace 0..1BackboneElementA person’s birth details
.... DOB 0..1dateThe date on which the person was born
.... DOBInfoSource 0..1CodeableConceptA code indicating the origin of date of birth information
.... PlaceBirth 0..1stringThe town, suburb, city etc where the person was born
.... CountryBirthCode 0..1CodeableConceptCountry where the person was born
.... CountryBirthInfoSource 0..1CodeableConceptA code indicating the source of information supporting the code for country of birth
... Gender 0..1codeA classification of the person's gender as self-identified by the person
... Sex 0..1CodeableConceptA 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).
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred)
... Ethnicity 1..*CodeableConceptA classification of the ethnicity of an individual person as self-identified by the person
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity (preferred)
... MotherBirthName 0..1stringThe full name of the person’s mother at the time of the mother’s birth
... NZResidencyCitizenship 0..1BackboneElementNew Zealand residency and citizenship details
.... NZResidencyStatus 0..1CodeableConceptCode indicating whether the person holds a New Zealand residence class visa (either a resident visa or a permanent resident visa)
.... NZResidencyStatusInfoSource 0..1CodeableConceptA code indicating the source of information of the person’s New Zealand residency status
.... NZCitizenshipStatus 0..1CodeableConceptThis field indicates if the person holds New Zealand citizenship
.... NZCitizenshipStatusInformationSource 0..1CodeableConceptA code indicating the source of information of the person’s New Zealand citizenship status
... DeathInformation 0..1BackboneElementInformation on patient death
.... DateDeath 0..1dateThe date the person died
.... DateDeathInfoSource 0..1CodeableConceptA code indicating the valid date of death information source
... Address 0..*BackboneElementThe person's current address or location details if known (in NZ CIQ address profile format.
.... Type 0..1CodeableConceptThe type of address, e.g. residential (physical), mailing (postal)
.... BuildingName 0..1stringThe name of the building or institution.
.... StreetAddress1 0..1stringThe floor, unit and/or street address details.
.... StreetAddress2 0..1stringOther geographic information related to the address
.... Suburb 0..1stringThe name of the suburb or district within a city/town.
.... City 0..1CodeableConceptPatient.Address.City
.... Postcode 0..1stringThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
.... CountryCode 0..1codeThe two character ISO code that forms part of the address.
.... AddressProtectedFlag 0..1booleanThis indicator denotes that the person’s address information is to be held ‘in confidence’
.... PermanentAddressFlag 0..1CodeableConceptAn indicator used to denote an address is a permanent address
.... DateAddressPeriod 0..1PeriodDate(s) that an address is effective from and/or to
.... DomicileCode 0..1CodeableConceptNew Zealand health domicile code representing a person’s usual residential address
.... PrimaryAddressFlag 0..1CodeableConceptAn indicator used to denote that the address is the primary address for the person
... Language 0..*codeA code representing a language spoken or understood by the person
... ContactInformation 0..1BackboneElementThe method of electronic communication to be used to contact the patient
.... ContactUsage 0..1CodeableConceptThe classification that specifies the way in which the contact medium is intended to be used
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal (preferred)
.... ContactType 0..1CodeableConceptThe code representing the type of electronic contact medium to be used
.... ContactDetail 0..1stringThe contact details may comprise an electronic address or a number
.... ContactProtectedFlag 0..1booleanThis indicates that the contact information is confidential
.... ContactDetailsPeriod 0..1PeriodDate contact details effective from and/or to
.... PerferredContactFlag 0..1booleanThis flag denotes that the contact details provided are the person’s preference
... Title 0..1stringPatient.Title

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient-cs.Sexpreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
Patient-cs.Ethnicitypreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Patient-cs.ContactInformation.ContactUsagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient-cs 0..*BasePatient
Instances of this logical model are not marked to be the target of a Reference
... Nhi 1..1IdentifierA unique identifier assigned to a person by the NHI system.
... NZName 1..1BackboneElementA person’s name details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
.... GivenName 0..1stringThe person’s forename or given name at birth
.... OtherGivenName 0..*stringThe person’s other given names or middle name and initials, but not the family name at birth
.... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
.... NameSuffix 0..*stringThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
.... PreferredNameIndicator 0..1CodeableConceptAn indicator used to denote that a particular person name is the person’s preferred name
.... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
.... age 0..1stringPatient.NZName.age
.... NameInfoSource 0..1CodeableConceptA code indicating the name source
.... NameEffectivePeriod 0..1PeriodThe date(s) the name is effective from and/or to
... BirthdatePlace 0..1BackboneElementA person’s birth details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... DOB 0..1dateThe date on which the person was born
.... DOBInfoSource 0..1CodeableConceptA code indicating the origin of date of birth information
.... PlaceBirth 0..1stringThe town, suburb, city etc where the person was born
.... CountryBirthCode 0..1CodeableConceptCountry where the person was born
.... CountryBirthInfoSource 0..1CodeableConceptA code indicating the source of information supporting the code for country of birth
... Gender 0..1codeA classification of the person's gender as self-identified by the person
... Sex 0..1CodeableConceptA 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).
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred)
... Ethnicity 1..*CodeableConceptA classification of the ethnicity of an individual person as self-identified by the person
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity (preferred)
... MotherBirthName 0..1stringThe full name of the person’s mother at the time of the mother’s birth
... NZResidencyCitizenship 0..1BackboneElementNew Zealand residency and citizenship details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... NZResidencyStatus 0..1CodeableConceptCode indicating whether the person holds a New Zealand residence class visa (either a resident visa or a permanent resident visa)
.... NZResidencyStatusInfoSource 0..1CodeableConceptA code indicating the source of information of the person’s New Zealand residency status
.... NZCitizenshipStatus 0..1CodeableConceptThis field indicates if the person holds New Zealand citizenship
.... NZCitizenshipStatusInformationSource 0..1CodeableConceptA code indicating the source of information of the person’s New Zealand citizenship status
... DeathInformation 0..1BackboneElementInformation on patient death
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... DateDeath 0..1dateThe date the person died
.... DateDeathInfoSource 0..1CodeableConceptA code indicating the valid date of death information source
... Address 0..*BackboneElementThe person's current address or location details if known (in NZ CIQ address profile format.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Type 0..1CodeableConceptThe type of address, e.g. residential (physical), mailing (postal)
.... BuildingName 0..1stringThe name of the building or institution.
.... StreetAddress1 0..1stringThe floor, unit and/or street address details.
.... StreetAddress2 0..1stringOther geographic information related to the address
.... Suburb 0..1stringThe name of the suburb or district within a city/town.
.... City 0..1CodeableConceptPatient.Address.City
.... Postcode 0..1stringThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
.... CountryCode 0..1codeThe two character ISO code that forms part of the address.
.... AddressProtectedFlag 0..1booleanThis indicator denotes that the person’s address information is to be held ‘in confidence’
.... PermanentAddressFlag 0..1CodeableConceptAn indicator used to denote an address is a permanent address
.... DateAddressPeriod 0..1PeriodDate(s) that an address is effective from and/or to
.... DomicileCode 0..1CodeableConceptNew Zealand health domicile code representing a person’s usual residential address
.... PrimaryAddressFlag 0..1CodeableConceptAn indicator used to denote that the address is the primary address for the person
... Language 0..*codeA code representing a language spoken or understood by the person
... ContactInformation 0..1BackboneElementThe method of electronic communication to be used to contact the patient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContactUsage 0..1CodeableConceptThe classification that specifies the way in which the contact medium is intended to be used
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal (preferred)
.... ContactType 0..1CodeableConceptThe code representing the type of electronic contact medium to be used
.... ContactDetail 0..1stringThe contact details may comprise an electronic address or a number
.... ContactProtectedFlag 0..1booleanThis indicates that the contact information is confidential
.... ContactDetailsPeriod 0..1PeriodDate contact details effective from and/or to
.... PerferredContactFlag 0..1booleanThis flag denotes that the contact details provided are the person’s preference
... Title 0..1stringPatient.Title

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient-cs.Sexpreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
Patient-cs.Ethnicitypreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Patient-cs.ContactInformation.ContactUsagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient-cs 0..*BasePatient
Instances of this logical model are not marked to be the target of a Reference
... Nhi 1..1IdentifierA unique identifier assigned to a person by the NHI system.
... NZName 1..1BackboneElementA person’s name details
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
.... GivenName 0..1stringThe person’s forename or given name at birth
.... OtherGivenName 0..*stringThe person’s other given names or middle name and initials, but not the family name at birth
.... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
.... NameSuffix 0..*stringThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
.... PreferredNameIndicator 0..1CodeableConceptAn indicator used to denote that a particular person name is the person’s preferred name
.... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
.... age 0..1stringPatient.NZName.age
.... NameInfoSource 0..1CodeableConceptA code indicating the name source
.... NameEffectivePeriod 0..1PeriodThe date(s) the name is effective from and/or to
... BirthdatePlace 0..1BackboneElementA person’s birth details
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... DOB 0..1dateThe date on which the person was born
.... DOBInfoSource 0..1CodeableConceptA code indicating the origin of date of birth information
.... PlaceBirth 0..1stringThe town, suburb, city etc where the person was born
.... CountryBirthCode 0..1CodeableConceptCountry where the person was born
.... CountryBirthInfoSource 0..1CodeableConceptA code indicating the source of information supporting the code for country of birth
... Gender 0..1codeA classification of the person's gender as self-identified by the person
... Sex 0..1CodeableConceptA 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).
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred)
... Ethnicity 1..*CodeableConceptA classification of the ethnicity of an individual person as self-identified by the person
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity (preferred)
... MotherBirthName 0..1stringThe full name of the person’s mother at the time of the mother’s birth
... NZResidencyCitizenship 0..1BackboneElementNew Zealand residency and citizenship details
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... NZResidencyStatus 0..1CodeableConceptCode indicating whether the person holds a New Zealand residence class visa (either a resident visa or a permanent resident visa)
.... NZResidencyStatusInfoSource 0..1CodeableConceptA code indicating the source of information of the person’s New Zealand residency status
.... NZCitizenshipStatus 0..1CodeableConceptThis field indicates if the person holds New Zealand citizenship
.... NZCitizenshipStatusInformationSource 0..1CodeableConceptA code indicating the source of information of the person’s New Zealand citizenship status
... DeathInformation 0..1BackboneElementInformation on patient death
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... DateDeath 0..1dateThe date the person died
.... DateDeathInfoSource 0..1CodeableConceptA code indicating the valid date of death information source
... Address 0..*BackboneElementThe person's current address or location details if known (in NZ CIQ address profile format.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Type 0..1CodeableConceptThe type of address, e.g. residential (physical), mailing (postal)
.... BuildingName 0..1stringThe name of the building or institution.
.... StreetAddress1 0..1stringThe floor, unit and/or street address details.
.... StreetAddress2 0..1stringOther geographic information related to the address
.... Suburb 0..1stringThe name of the suburb or district within a city/town.
.... City 0..1CodeableConceptPatient.Address.City
.... Postcode 0..1stringThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
.... CountryCode 0..1codeThe two character ISO code that forms part of the address.
.... AddressProtectedFlag 0..1booleanThis indicator denotes that the person’s address information is to be held ‘in confidence’
.... PermanentAddressFlag 0..1CodeableConceptAn indicator used to denote an address is a permanent address
.... DateAddressPeriod 0..1PeriodDate(s) that an address is effective from and/or to
.... DomicileCode 0..1CodeableConceptNew Zealand health domicile code representing a person’s usual residential address
.... PrimaryAddressFlag 0..1CodeableConceptAn indicator used to denote that the address is the primary address for the person
... Language 0..*codeA code representing a language spoken or understood by the person
... ContactInformation 0..1BackboneElementThe method of electronic communication to be used to contact the patient
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContactUsage 0..1CodeableConceptThe classification that specifies the way in which the contact medium is intended to be used
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal (preferred)
.... ContactType 0..1CodeableConceptThe code representing the type of electronic contact medium to be used
.... ContactDetail 0..1stringThe contact details may comprise an electronic address or a number
.... ContactProtectedFlag 0..1booleanThis indicates that the contact information is confidential
.... ContactDetailsPeriod 0..1PeriodDate contact details effective from and/or to
.... PerferredContactFlag 0..1booleanThis flag denotes that the contact details provided are the person’s preference
... Title 0..1stringPatient.Title

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient-cs.Sexpreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
Patient-cs.Ethnicitypreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Patient-cs.ContactInformation.ContactUsagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (3 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient-cs 0..*BasePatient
Instances of this logical model are not marked to be the target of a Reference
... Nhi 1..1IdentifierA unique identifier assigned to a person by the NHI system.
... NZName 1..1BackboneElementA person’s name details
.... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
.... GivenName 0..1stringThe person’s forename or given name at birth
.... OtherGivenName 0..*stringThe person’s other given names or middle name and initials, but not the family name at birth
.... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
.... NameSuffix 0..*stringThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
.... PreferredNameIndicator 0..1CodeableConceptAn indicator used to denote that a particular person name is the person’s preferred name
.... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
.... age 0..1stringPatient.NZName.age
.... NameInfoSource 0..1CodeableConceptA code indicating the name source
.... NameEffectivePeriod 0..1PeriodThe date(s) the name is effective from and/or to
... BirthdatePlace 0..1BackboneElementA person’s birth details
.... DOB 0..1dateThe date on which the person was born
.... DOBInfoSource 0..1CodeableConceptA code indicating the origin of date of birth information
.... PlaceBirth 0..1stringThe town, suburb, city etc where the person was born
.... CountryBirthCode 0..1CodeableConceptCountry where the person was born
.... CountryBirthInfoSource 0..1CodeableConceptA code indicating the source of information supporting the code for country of birth
... Gender 0..1codeA classification of the person's gender as self-identified by the person
... Sex 0..1CodeableConceptA 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).
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred)
... Ethnicity 1..*CodeableConceptA classification of the ethnicity of an individual person as self-identified by the person
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity (preferred)
... MotherBirthName 0..1stringThe full name of the person’s mother at the time of the mother’s birth
... NZResidencyCitizenship 0..1BackboneElementNew Zealand residency and citizenship details
.... NZResidencyStatus 0..1CodeableConceptCode indicating whether the person holds a New Zealand residence class visa (either a resident visa or a permanent resident visa)
.... NZResidencyStatusInfoSource 0..1CodeableConceptA code indicating the source of information of the person’s New Zealand residency status
.... NZCitizenshipStatus 0..1CodeableConceptThis field indicates if the person holds New Zealand citizenship
.... NZCitizenshipStatusInformationSource 0..1CodeableConceptA code indicating the source of information of the person’s New Zealand citizenship status
... DeathInformation 0..1BackboneElementInformation on patient death
.... DateDeath 0..1dateThe date the person died
.... DateDeathInfoSource 0..1CodeableConceptA code indicating the valid date of death information source
... Address 0..*BackboneElementThe person's current address or location details if known (in NZ CIQ address profile format.
.... Type 0..1CodeableConceptThe type of address, e.g. residential (physical), mailing (postal)
.... BuildingName 0..1stringThe name of the building or institution.
.... StreetAddress1 0..1stringThe floor, unit and/or street address details.
.... StreetAddress2 0..1stringOther geographic information related to the address
.... Suburb 0..1stringThe name of the suburb or district within a city/town.
.... City 0..1CodeableConceptPatient.Address.City
.... Postcode 0..1stringThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
.... CountryCode 0..1codeThe two character ISO code that forms part of the address.
.... AddressProtectedFlag 0..1booleanThis indicator denotes that the person’s address information is to be held ‘in confidence’
.... PermanentAddressFlag 0..1CodeableConceptAn indicator used to denote an address is a permanent address
.... DateAddressPeriod 0..1PeriodDate(s) that an address is effective from and/or to
.... DomicileCode 0..1CodeableConceptNew Zealand health domicile code representing a person’s usual residential address
.... PrimaryAddressFlag 0..1CodeableConceptAn indicator used to denote that the address is the primary address for the person
... Language 0..*codeA code representing a language spoken or understood by the person
... ContactInformation 0..1BackboneElementThe method of electronic communication to be used to contact the patient
.... ContactUsage 0..1CodeableConceptThe classification that specifies the way in which the contact medium is intended to be used
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal (preferred)
.... ContactType 0..1CodeableConceptThe code representing the type of electronic contact medium to be used
.... ContactDetail 0..1stringThe contact details may comprise an electronic address or a number
.... ContactProtectedFlag 0..1booleanThis indicates that the contact information is confidential
.... ContactDetailsPeriod 0..1PeriodDate contact details effective from and/or to
.... PerferredContactFlag 0..1booleanThis flag denotes that the contact details provided are the person’s preference
... Title 0..1stringPatient.Title

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient-cs.Sexpreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
Patient-cs.Ethnicitypreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Patient-cs.ContactInformation.ContactUsagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient-cs 0..*BasePatient
Instances of this logical model are not marked to be the target of a Reference
... Nhi 1..1IdentifierA unique identifier assigned to a person by the NHI system.
... NZName 1..1BackboneElementA person’s name details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
.... GivenName 0..1stringThe person’s forename or given name at birth
.... OtherGivenName 0..*stringThe person’s other given names or middle name and initials, but not the family name at birth
.... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
.... NameSuffix 0..*stringThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
.... PreferredNameIndicator 0..1CodeableConceptAn indicator used to denote that a particular person name is the person’s preferred name
.... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
.... age 0..1stringPatient.NZName.age
.... NameInfoSource 0..1CodeableConceptA code indicating the name source
.... NameEffectivePeriod 0..1PeriodThe date(s) the name is effective from and/or to
... BirthdatePlace 0..1BackboneElementA person’s birth details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... DOB 0..1dateThe date on which the person was born
.... DOBInfoSource 0..1CodeableConceptA code indicating the origin of date of birth information
.... PlaceBirth 0..1stringThe town, suburb, city etc where the person was born
.... CountryBirthCode 0..1CodeableConceptCountry where the person was born
.... CountryBirthInfoSource 0..1CodeableConceptA code indicating the source of information supporting the code for country of birth
... Gender 0..1codeA classification of the person's gender as self-identified by the person
... Sex 0..1CodeableConceptA 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).
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred)
... Ethnicity 1..*CodeableConceptA classification of the ethnicity of an individual person as self-identified by the person
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity (preferred)
... MotherBirthName 0..1stringThe full name of the person’s mother at the time of the mother’s birth
... NZResidencyCitizenship 0..1BackboneElementNew Zealand residency and citizenship details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... NZResidencyStatus 0..1CodeableConceptCode indicating whether the person holds a New Zealand residence class visa (either a resident visa or a permanent resident visa)
.... NZResidencyStatusInfoSource 0..1CodeableConceptA code indicating the source of information of the person’s New Zealand residency status
.... NZCitizenshipStatus 0..1CodeableConceptThis field indicates if the person holds New Zealand citizenship
.... NZCitizenshipStatusInformationSource 0..1CodeableConceptA code indicating the source of information of the person’s New Zealand citizenship status
... DeathInformation 0..1BackboneElementInformation on patient death
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... DateDeath 0..1dateThe date the person died
.... DateDeathInfoSource 0..1CodeableConceptA code indicating the valid date of death information source
... Address 0..*BackboneElementThe person's current address or location details if known (in NZ CIQ address profile format.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Type 0..1CodeableConceptThe type of address, e.g. residential (physical), mailing (postal)
.... BuildingName 0..1stringThe name of the building or institution.
.... StreetAddress1 0..1stringThe floor, unit and/or street address details.
.... StreetAddress2 0..1stringOther geographic information related to the address
.... Suburb 0..1stringThe name of the suburb or district within a city/town.
.... City 0..1CodeableConceptPatient.Address.City
.... Postcode 0..1stringThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
.... CountryCode 0..1codeThe two character ISO code that forms part of the address.
.... AddressProtectedFlag 0..1booleanThis indicator denotes that the person’s address information is to be held ‘in confidence’
.... PermanentAddressFlag 0..1CodeableConceptAn indicator used to denote an address is a permanent address
.... DateAddressPeriod 0..1PeriodDate(s) that an address is effective from and/or to
.... DomicileCode 0..1CodeableConceptNew Zealand health domicile code representing a person’s usual residential address
.... PrimaryAddressFlag 0..1CodeableConceptAn indicator used to denote that the address is the primary address for the person
... Language 0..*codeA code representing a language spoken or understood by the person
... ContactInformation 0..1BackboneElementThe method of electronic communication to be used to contact the patient
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContactUsage 0..1CodeableConceptThe classification that specifies the way in which the contact medium is intended to be used
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal (preferred)
.... ContactType 0..1CodeableConceptThe code representing the type of electronic contact medium to be used
.... ContactDetail 0..1stringThe contact details may comprise an electronic address or a number
.... ContactProtectedFlag 0..1booleanThis indicates that the contact information is confidential
.... ContactDetailsPeriod 0..1PeriodDate contact details effective from and/or to
.... PerferredContactFlag 0..1booleanThis flag denotes that the contact details provided are the person’s preference
... Title 0..1stringPatient.Title

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient-cs.Sexpreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
Patient-cs.Ethnicitypreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Patient-cs.ContactInformation.ContactUsagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient-cs 0..*BasePatient
Instances of this logical model are not marked to be the target of a Reference
... Nhi 1..1IdentifierA unique identifier assigned to a person by the NHI system.
... NZName 1..1BackboneElementA person’s name details
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
.... GivenName 0..1stringThe person’s forename or given name at birth
.... OtherGivenName 0..*stringThe person’s other given names or middle name and initials, but not the family name at birth
.... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
.... NameSuffix 0..*stringThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
.... PreferredNameIndicator 0..1CodeableConceptAn indicator used to denote that a particular person name is the person’s preferred name
.... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
.... age 0..1stringPatient.NZName.age
.... NameInfoSource 0..1CodeableConceptA code indicating the name source
.... NameEffectivePeriod 0..1PeriodThe date(s) the name is effective from and/or to
... BirthdatePlace 0..1BackboneElementA person’s birth details
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... DOB 0..1dateThe date on which the person was born
.... DOBInfoSource 0..1CodeableConceptA code indicating the origin of date of birth information
.... PlaceBirth 0..1stringThe town, suburb, city etc where the person was born
.... CountryBirthCode 0..1CodeableConceptCountry where the person was born
.... CountryBirthInfoSource 0..1CodeableConceptA code indicating the source of information supporting the code for country of birth
... Gender 0..1codeA classification of the person's gender as self-identified by the person
... Sex 0..1CodeableConceptA 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).
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred)
... Ethnicity 1..*CodeableConceptA classification of the ethnicity of an individual person as self-identified by the person
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity (preferred)
... MotherBirthName 0..1stringThe full name of the person’s mother at the time of the mother’s birth
... NZResidencyCitizenship 0..1BackboneElementNew Zealand residency and citizenship details
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... NZResidencyStatus 0..1CodeableConceptCode indicating whether the person holds a New Zealand residence class visa (either a resident visa or a permanent resident visa)
.... NZResidencyStatusInfoSource 0..1CodeableConceptA code indicating the source of information of the person’s New Zealand residency status
.... NZCitizenshipStatus 0..1CodeableConceptThis field indicates if the person holds New Zealand citizenship
.... NZCitizenshipStatusInformationSource 0..1CodeableConceptA code indicating the source of information of the person’s New Zealand citizenship status
... DeathInformation 0..1BackboneElementInformation on patient death
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... DateDeath 0..1dateThe date the person died
.... DateDeathInfoSource 0..1CodeableConceptA code indicating the valid date of death information source
... Address 0..*BackboneElementThe person's current address or location details if known (in NZ CIQ address profile format.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Type 0..1CodeableConceptThe type of address, e.g. residential (physical), mailing (postal)
.... BuildingName 0..1stringThe name of the building or institution.
.... StreetAddress1 0..1stringThe floor, unit and/or street address details.
.... StreetAddress2 0..1stringOther geographic information related to the address
.... Suburb 0..1stringThe name of the suburb or district within a city/town.
.... City 0..1CodeableConceptPatient.Address.City
.... Postcode 0..1stringThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
.... CountryCode 0..1codeThe two character ISO code that forms part of the address.
.... AddressProtectedFlag 0..1booleanThis indicator denotes that the person’s address information is to be held ‘in confidence’
.... PermanentAddressFlag 0..1CodeableConceptAn indicator used to denote an address is a permanent address
.... DateAddressPeriod 0..1PeriodDate(s) that an address is effective from and/or to
.... DomicileCode 0..1CodeableConceptNew Zealand health domicile code representing a person’s usual residential address
.... PrimaryAddressFlag 0..1CodeableConceptAn indicator used to denote that the address is the primary address for the person
... Language 0..*codeA code representing a language spoken or understood by the person
... ContactInformation 0..1BackboneElementThe method of electronic communication to be used to contact the patient
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContactUsage 0..1CodeableConceptThe classification that specifies the way in which the contact medium is intended to be used
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal (preferred)
.... ContactType 0..1CodeableConceptThe code representing the type of electronic contact medium to be used
.... ContactDetail 0..1stringThe contact details may comprise an electronic address or a number
.... ContactProtectedFlag 0..1booleanThis indicates that the contact information is confidential
.... ContactDetailsPeriod 0..1PeriodDate contact details effective from and/or to
.... PerferredContactFlag 0..1booleanThis flag denotes that the contact details provided are the person’s preference
... Title 0..1stringPatient.Title

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient-cs.Sexpreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex
Patient-cs.Ethnicitypreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Patient-cs.ContactInformation.ContactUsagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (3 nested mandatory elements)

 

Other representations of profile: CSV, Excel