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
Official URL: http://example.org/StructureDefinition/PatientGeneralCopy-cs | Version: 0.1.0 | |||
Draft as of 2024-03-04 | Computable Name: PatientGeneralCopy_cs |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Base | patient general copy Instances of this logical model are not marked to be the target of a Reference | |
![]() ![]() ![]() | 0..1 | BackboneElement | A short summary of the main identifying details for a patient.. | |
![]() ![]() ![]() ![]() | 1..1 | Identifier | A unique identifier assigned to a person by the NHI system. | |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | A person’s name details | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The person’s forename or given name at birth | |
![]() ![]() ![]() ![]() ![]() | 0..* | string | The person’s other given names or middle name and initials, but not the family name at birth | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
![]() ![]() ![]() ![]() ![]() | 0..* | string | The 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 | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote that a particular person name is the person’s preferred name | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | patientGeneralCopy.Patient.NZName.age | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the name source | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | The date(s) the name is effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | BackboneElement | A person’s birth details | |
![]() ![]() ![]() ![]() ![]() | 0..1 | date | The date on which the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the origin of date of birth information | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The town, suburb, city etc where the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Country where the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the source of information supporting the code for country of birth | |
![]() ![]() ![]() ![]() | 0..1 | integer | The age of the patient at the time the data was recorded. | |
![]() ![]() ![]() ![]() | 0..1 | code | A classification of the person's gender as self-identified by the person | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | 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). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred) | |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | A 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) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | The person's current address or location details if known (in NZ CIQ address profile format. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The type of address, e.g. residential (physical), mailing (postal) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The name of the building or institution. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The floor, unit and/or street address details. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Other geographic information related to the address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The name of the suburb or district within a city/town. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | patientGeneralCopy.Patient.Address.City | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | code | The two character ISO code that forms part of the address. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | This indicator denotes that the person’s address information is to be held ‘in confidence’ | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote an address is a permanent address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Date(s) that an address is effective from and/or to | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | New Zealand health domicile code representing a person’s usual residential address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote that the address is the primary address for the person | |
![]() ![]() ![]() ![]() | 0..1 | string | patientGeneralCopy.Patient.Title | |
![]() |
Path | Conformance | ValueSet | URI |
PatientGeneralCopy-cs.Patient.Sex | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sexhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex | |
PatientGeneralCopy-cs.Patient.Ethnicity | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicityhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Base | patient general copy Instances of this logical model are not marked to be the target of a Reference | |
![]() ![]() ![]() | 0..1 | BackboneElement | A short summary of the main identifying details for a patient.. | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | Identifier | A unique identifier assigned to a person by the NHI system. | |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | A person’s name details | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The person’s forename or given name at birth | |
![]() ![]() ![]() ![]() ![]() | 0..* | string | The person’s other given names or middle name and initials, but not the family name at birth | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
![]() ![]() ![]() ![]() ![]() | 0..* | string | The 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 | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote that a particular person name is the person’s preferred name | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | patientGeneralCopy.Patient.NZName.age | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the name source | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | The date(s) the name is effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | BackboneElement | A person’s birth details | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | 0..1 | date | The date on which the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the origin of date of birth information | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The town, suburb, city etc where the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Country where the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the source of information supporting the code for country of birth | |
![]() ![]() ![]() ![]() | 0..1 | integer | The age of the patient at the time the data was recorded. | |
![]() ![]() ![]() ![]() | 0..1 | code | A classification of the person's gender as self-identified by the person | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | 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). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred) | |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | A 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) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | The person's current address or location details if known (in NZ CIQ address profile format. | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The type of address, e.g. residential (physical), mailing (postal) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The name of the building or institution. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The floor, unit and/or street address details. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Other geographic information related to the address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The name of the suburb or district within a city/town. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | patientGeneralCopy.Patient.Address.City | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | code | The two character ISO code that forms part of the address. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | This indicator denotes that the person’s address information is to be held ‘in confidence’ | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote an address is a permanent address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Date(s) that an address is effective from and/or to | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | New Zealand health domicile code representing a person’s usual residential address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote that the address is the primary address for the person | |
![]() ![]() ![]() ![]() | 0..1 | string | patientGeneralCopy.Patient.Title | |
![]() |
Path | Conformance | ValueSet | URI |
PatientGeneralCopy-cs.Patient.Sex | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sexhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex | |
PatientGeneralCopy-cs.Patient.Ethnicity | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicityhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Base | patient general copy Instances of this logical model are not marked to be the target of a Reference | |
![]() ![]() ![]() | 0..1 | BackboneElement | A short summary of the main identifying details for a patient.. | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | Identifier | A unique identifier assigned to a person by the NHI system. | |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | A person’s name details | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The person’s forename or given name at birth | |
![]() ![]() ![]() ![]() ![]() | 0..* | string | The person’s other given names or middle name and initials, but not the family name at birth | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
![]() ![]() ![]() ![]() ![]() | 0..* | string | The 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 | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote that a particular person name is the person’s preferred name | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | patientGeneralCopy.Patient.NZName.age | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the name source | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | The date(s) the name is effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | BackboneElement | A person’s birth details | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | 0..1 | date | The date on which the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the origin of date of birth information | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The town, suburb, city etc where the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Country where the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the source of information supporting the code for country of birth | |
![]() ![]() ![]() ![]() | 0..1 | integer | The age of the patient at the time the data was recorded. | |
![]() ![]() ![]() ![]() | 0..1 | code | A classification of the person's gender as self-identified by the person | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | 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). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred) | |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | A 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) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | The person's current address or location details if known (in NZ CIQ address profile format. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The type of address, e.g. residential (physical), mailing (postal) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The name of the building or institution. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The floor, unit and/or street address details. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Other geographic information related to the address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The name of the suburb or district within a city/town. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | patientGeneralCopy.Patient.Address.City | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | code | The two character ISO code that forms part of the address. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | This indicator denotes that the person’s address information is to be held ‘in confidence’ | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote an address is a permanent address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Date(s) that an address is effective from and/or to | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | New Zealand health domicile code representing a person’s usual residential address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote that the address is the primary address for the person | |
![]() ![]() ![]() ![]() | 0..1 | string | patientGeneralCopy.Patient.Title | |
![]() |
Path | Conformance | ValueSet | URI |
PatientGeneralCopy-cs.Patient.Sex | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sexhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex | |
PatientGeneralCopy-cs.Patient.Ethnicity | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicityhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base
Differential View
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Base | patient general copy Instances of this logical model are not marked to be the target of a Reference | |
![]() ![]() ![]() | 0..1 | BackboneElement | A short summary of the main identifying details for a patient.. | |
![]() ![]() ![]() ![]() | 1..1 | Identifier | A unique identifier assigned to a person by the NHI system. | |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | A person’s name details | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The person’s forename or given name at birth | |
![]() ![]() ![]() ![]() ![]() | 0..* | string | The person’s other given names or middle name and initials, but not the family name at birth | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
![]() ![]() ![]() ![]() ![]() | 0..* | string | The 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 | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote that a particular person name is the person’s preferred name | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | patientGeneralCopy.Patient.NZName.age | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the name source | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | The date(s) the name is effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | BackboneElement | A person’s birth details | |
![]() ![]() ![]() ![]() ![]() | 0..1 | date | The date on which the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the origin of date of birth information | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The town, suburb, city etc where the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Country where the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the source of information supporting the code for country of birth | |
![]() ![]() ![]() ![]() | 0..1 | integer | The age of the patient at the time the data was recorded. | |
![]() ![]() ![]() ![]() | 0..1 | code | A classification of the person's gender as self-identified by the person | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | 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). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred) | |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | A 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) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | The person's current address or location details if known (in NZ CIQ address profile format. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The type of address, e.g. residential (physical), mailing (postal) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The name of the building or institution. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The floor, unit and/or street address details. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Other geographic information related to the address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The name of the suburb or district within a city/town. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | patientGeneralCopy.Patient.Address.City | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | code | The two character ISO code that forms part of the address. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | This indicator denotes that the person’s address information is to be held ‘in confidence’ | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote an address is a permanent address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Date(s) that an address is effective from and/or to | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | New Zealand health domicile code representing a person’s usual residential address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote that the address is the primary address for the person | |
![]() ![]() ![]() ![]() | 0..1 | string | patientGeneralCopy.Patient.Title | |
![]() |
Path | Conformance | ValueSet | URI |
PatientGeneralCopy-cs.Patient.Sex | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sexhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex | |
PatientGeneralCopy-cs.Patient.Ethnicity | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicityhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Base | patient general copy Instances of this logical model are not marked to be the target of a Reference | |
![]() ![]() ![]() | 0..1 | BackboneElement | A short summary of the main identifying details for a patient.. | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | Identifier | A unique identifier assigned to a person by the NHI system. | |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | A person’s name details | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The person’s forename or given name at birth | |
![]() ![]() ![]() ![]() ![]() | 0..* | string | The person’s other given names or middle name and initials, but not the family name at birth | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
![]() ![]() ![]() ![]() ![]() | 0..* | string | The 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 | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote that a particular person name is the person’s preferred name | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | patientGeneralCopy.Patient.NZName.age | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the name source | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | The date(s) the name is effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | BackboneElement | A person’s birth details | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | 0..1 | date | The date on which the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the origin of date of birth information | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The town, suburb, city etc where the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Country where the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the source of information supporting the code for country of birth | |
![]() ![]() ![]() ![]() | 0..1 | integer | The age of the patient at the time the data was recorded. | |
![]() ![]() ![]() ![]() | 0..1 | code | A classification of the person's gender as self-identified by the person | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | 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). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred) | |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | A 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) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | The person's current address or location details if known (in NZ CIQ address profile format. | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The type of address, e.g. residential (physical), mailing (postal) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The name of the building or institution. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The floor, unit and/or street address details. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Other geographic information related to the address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The name of the suburb or district within a city/town. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | patientGeneralCopy.Patient.Address.City | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | code | The two character ISO code that forms part of the address. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | This indicator denotes that the person’s address information is to be held ‘in confidence’ | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote an address is a permanent address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Date(s) that an address is effective from and/or to | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | New Zealand health domicile code representing a person’s usual residential address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote that the address is the primary address for the person | |
![]() ![]() ![]() ![]() | 0..1 | string | patientGeneralCopy.Patient.Title | |
![]() |
Path | Conformance | ValueSet | URI |
PatientGeneralCopy-cs.Patient.Sex | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sexhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex | |
PatientGeneralCopy-cs.Patient.Ethnicity | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicityhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Base | patient general copy Instances of this logical model are not marked to be the target of a Reference | |
![]() ![]() ![]() | 0..1 | BackboneElement | A short summary of the main identifying details for a patient.. | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | Identifier | A unique identifier assigned to a person by the NHI system. | |
![]() ![]() ![]() ![]() | 1..1 | BackboneElement | A person’s name details | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The person’s forename or given name at birth | |
![]() ![]() ![]() ![]() ![]() | 0..* | string | The person’s other given names or middle name and initials, but not the family name at birth | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The family name (surname) of a person as distinct from their given, second and subsequent name(s) | |
![]() ![]() ![]() ![]() ![]() | 0..* | string | The 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 | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote that a particular person name is the person’s preferred name | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | This indicator denotes that the person’s name information is to be held ‘in confidence’ | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | patientGeneralCopy.Patient.NZName.age | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the name source | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | The date(s) the name is effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | BackboneElement | A person’s birth details | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | 0..1 | date | The date on which the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the origin of date of birth information | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The town, suburb, city etc where the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Country where the person was born | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code indicating the source of information supporting the code for country of birth | |
![]() ![]() ![]() ![]() | 0..1 | integer | The age of the patient at the time the data was recorded. | |
![]() ![]() ![]() ![]() | 0..1 | code | A classification of the person's gender as self-identified by the person | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | 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). Binding: https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex (preferred) | |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | A 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) | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement | The person's current address or location details if known (in NZ CIQ address profile format. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The type of address, e.g. residential (physical), mailing (postal) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The name of the building or institution. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The floor, unit and/or street address details. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Other geographic information related to the address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The name of the suburb or district within a city/town. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | patientGeneralCopy.Patient.Address.City | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | code | The two character ISO code that forms part of the address. | |
![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | This indicator denotes that the person’s address information is to be held ‘in confidence’ | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote an address is a permanent address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Date(s) that an address is effective from and/or to | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | New Zealand health domicile code representing a person’s usual residential address | |
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator used to denote that the address is the primary address for the person | |
![]() ![]() ![]() ![]() | 0..1 | string | patientGeneralCopy.Patient.Title | |
![]() |
Path | Conformance | ValueSet | URI |
PatientGeneralCopy-cs.Patient.Sex | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/canshare-sexhttps://nzhts.digital.health.nz/fhir/ValueSet/canshare-sex | |
PatientGeneralCopy-cs.Patient.Ethnicity | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicityhttps://nzhts.digital.health.nz/fhir/ValueSet/http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base