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/HealthcarePractitioner-cs | Version: 0.1.0 | |||
Draft as of 2024-03-04 | Computable Name: HealthcarePractitioner_cs |
A person who is directly or indirectly involved in the provision of healthcare or related services.
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 | Healthcare practitioner Instances of this logical model are not marked to be the target of a Reference | |
![]() ![]() ![]() | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
![]() ![]() ![]() | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
![]() ![]() ![]() ![]() | 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 | HealthcarePractitioner.PersonName.age | |
![]() ![]() ![]() | 0..1 | date | The date on which the person was born | |
![]() ![]() ![]() | 0..1 | CodeableConcept | A self-identified classification of the gender of the person | |
![]() ![]() ![]() | 0..1 | CodeableConcept | A self-identified classification of the ethnicity of the person | |
![]() ![]() ![]() | 0..1 | date | The date the person died | |
![]() ![]() ![]() | 0..* | BackboneElement | The address of the person | |
![]() ![]() ![]() ![]() | 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 | string | HealthcarePractitioner.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..* | BackboneElement | The methods of electronic communication to be used to contact a healthcare practitioner | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The 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) | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The code representing the type of electronic contact medium to be used | |
![]() ![]() ![]() ![]() | 0..1 | string | The contact details may comprise an electronic address or a number | |
![]() ![]() ![]() ![]() | 0..1 | boolean | This indicates that the contact information is confidential | |
![]() ![]() ![]() ![]() | 0..1 | Period | Date contact details effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | boolean | This flag denotes that the contact details provided are the person’s preference | |
![]() ![]() ![]() | 0..* | CodeableConcept | A code representing the languages spoken or understood by the person | |
![]() ![]() ![]() | 0..* | BackboneElement | A health worker’s qualifications | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the qualification that enabled the health worker to be registered with the appropriate responsible authority | |
![]() ![]() ![]() ![]() | 0..1 | date | The year in which the health worker achieved the qualification | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the granting institution that conferred the qualification | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the city where the granting institution is located | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The identifier for the Country or nation of the granting institution | |
![]() ![]() ![]() | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | A unique identifier assigned to a health worker by an assigning source | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code to identify the type of professional registration the health worker has been assigned | |
![]() ![]() ![]() ![]() | 0..1 | date | The date on which the health worker first became registered with a responsible authority | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source | |
![]() ![]() ![]() | 0..* | BackboneElement | Practicing certificate details are recorded for health practitioners, who operate under a responsible authority. | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Responsible authority who has issued practicing certificate for healthcare practitioner. | |
![]() ![]() ![]() ![]() | 0..1 | Period | A Practicing certificate has an effective date range that is provided by the responsible authority. | |
![]() ![]() ![]() | 0..* | BackboneElement | Health worker scope of practice registration details | |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | A code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003 | |
![]() ![]() ![]() ![]() | 0..1 | Period | Scope on practice has an effective date from and/or to | |
![]() ![]() ![]() | 0..* | BackboneElement | Conditions on practice for the health practitioner | |
![]() ![]() ![]() ![]() | 0..1 | string | A narrative describing the conditions that may apply to a particular provider’s scope of practice | |
![]() ![]() ![]() ![]() | 0..1 | Period | Conditions on practice effective date from and/or to | |
![]() ![]() ![]() | 0..* | BackboneElement | The additional authorisations that a health worker is authorised to practice or prescribe | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A coded value of the additional authorisations that a health worker is authorised to practice or prescribe | |
![]() ![]() ![]() ![]() | 0..1 | Period | Additional authorisations to practice effective date range from and/or to | |
![]() ![]() ![]() | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
![]() ![]() ![]() ![]() | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The designated the role of a health worker | |
![]() ![]() ![]() ![]() | 0..1 | Period | Role date effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
![]() |
Path | Conformance | ValueSet | URI |
HealthcarePractitioner-cs.ContactInformation.ContactUsage | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personalhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Base | Healthcare practitioner Instances of this logical model are not marked to be the target of a Reference | |
![]() ![]() ![]() | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
![]() ![]() ![]() | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
![]() ![]() ![]() ![]() | ?!Σ | 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 | HealthcarePractitioner.PersonName.age | |
![]() ![]() ![]() | 0..1 | date | The date on which the person was born | |
![]() ![]() ![]() | 0..1 | CodeableConcept | A self-identified classification of the gender of the person | |
![]() ![]() ![]() | 0..1 | CodeableConcept | A self-identified classification of the ethnicity of the person | |
![]() ![]() ![]() | 0..1 | date | The date the person died | |
![]() ![]() ![]() | 0..* | BackboneElement | The address of the person | |
![]() ![]() ![]() ![]() | ?!Σ | 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 | string | HealthcarePractitioner.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..* | BackboneElement | The methods of electronic communication to be used to contact a healthcare practitioner | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The 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) | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The code representing the type of electronic contact medium to be used | |
![]() ![]() ![]() ![]() | 0..1 | string | The contact details may comprise an electronic address or a number | |
![]() ![]() ![]() ![]() | 0..1 | boolean | This indicates that the contact information is confidential | |
![]() ![]() ![]() ![]() | 0..1 | Period | Date contact details effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | boolean | This flag denotes that the contact details provided are the person’s preference | |
![]() ![]() ![]() | 0..* | CodeableConcept | A code representing the languages spoken or understood by the person | |
![]() ![]() ![]() | 0..* | BackboneElement | A health worker’s qualifications | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the qualification that enabled the health worker to be registered with the appropriate responsible authority | |
![]() ![]() ![]() ![]() | 0..1 | date | The year in which the health worker achieved the qualification | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the granting institution that conferred the qualification | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the city where the granting institution is located | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The identifier for the Country or nation of the granting institution | |
![]() ![]() ![]() | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | A unique identifier assigned to a health worker by an assigning source | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code to identify the type of professional registration the health worker has been assigned | |
![]() ![]() ![]() ![]() | 0..1 | date | The date on which the health worker first became registered with a responsible authority | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source | |
![]() ![]() ![]() | 0..* | BackboneElement | Practicing certificate details are recorded for health practitioners, who operate under a responsible authority. | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Responsible authority who has issued practicing certificate for healthcare practitioner. | |
![]() ![]() ![]() ![]() | 0..1 | Period | A Practicing certificate has an effective date range that is provided by the responsible authority. | |
![]() ![]() ![]() | 0..* | BackboneElement | Health worker scope of practice registration details | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | A code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003 | |
![]() ![]() ![]() ![]() | 0..1 | Period | Scope on practice has an effective date from and/or to | |
![]() ![]() ![]() | 0..* | BackboneElement | Conditions on practice for the health practitioner | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | string | A narrative describing the conditions that may apply to a particular provider’s scope of practice | |
![]() ![]() ![]() ![]() | 0..1 | Period | Conditions on practice effective date from and/or to | |
![]() ![]() ![]() | 0..* | BackboneElement | The additional authorisations that a health worker is authorised to practice or prescribe | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A coded value of the additional authorisations that a health worker is authorised to practice or prescribe | |
![]() ![]() ![]() ![]() | 0..1 | Period | Additional authorisations to practice effective date range from and/or to | |
![]() ![]() ![]() | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The designated the role of a health worker | |
![]() ![]() ![]() ![]() | 0..1 | Period | Role date effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
![]() |
Path | Conformance | ValueSet | URI |
HealthcarePractitioner-cs.ContactInformation.ContactUsage | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personalhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal |
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 | Healthcare practitioner Instances of this logical model are not marked to be the target of a Reference | |
![]() ![]() ![]() | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
![]() ![]() ![]() | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
![]() ![]() ![]() ![]() | 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 | HealthcarePractitioner.PersonName.age | |
![]() ![]() ![]() | 0..1 | date | The date on which the person was born | |
![]() ![]() ![]() | 0..1 | CodeableConcept | A self-identified classification of the gender of the person | |
![]() ![]() ![]() | 0..1 | CodeableConcept | A self-identified classification of the ethnicity of the person | |
![]() ![]() ![]() | 0..1 | date | The date the person died | |
![]() ![]() ![]() | 0..* | BackboneElement | The address of the person | |
![]() ![]() ![]() ![]() | 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 | string | HealthcarePractitioner.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..* | BackboneElement | The methods of electronic communication to be used to contact a healthcare practitioner | |
![]() ![]() ![]() ![]() | 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 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) | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The code representing the type of electronic contact medium to be used | |
![]() ![]() ![]() ![]() | 0..1 | string | The contact details may comprise an electronic address or a number | |
![]() ![]() ![]() ![]() | 0..1 | boolean | This indicates that the contact information is confidential | |
![]() ![]() ![]() ![]() | 0..1 | Period | Date contact details effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | boolean | This flag denotes that the contact details provided are the person’s preference | |
![]() ![]() ![]() | 0..* | CodeableConcept | A code representing the languages spoken or understood by the person | |
![]() ![]() ![]() | 0..* | BackboneElement | A health worker’s qualifications | |
![]() ![]() ![]() ![]() | 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 | string | The name of the qualification that enabled the health worker to be registered with the appropriate responsible authority | |
![]() ![]() ![]() ![]() | 0..1 | date | The year in which the health worker achieved the qualification | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the granting institution that conferred the qualification | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the city where the granting institution is located | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The identifier for the Country or nation of the granting institution | |
![]() ![]() ![]() | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
![]() ![]() ![]() ![]() | 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 HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | A unique identifier assigned to a health worker by an assigning source | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code to identify the type of professional registration the health worker has been assigned | |
![]() ![]() ![]() ![]() | 0..1 | date | The date on which the health worker first became registered with a responsible authority | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source | |
![]() ![]() ![]() | 0..* | BackboneElement | Practicing certificate details are recorded for health practitioners, who operate under a responsible authority. | |
![]() ![]() ![]() ![]() | 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 | Responsible authority who has issued practicing certificate for healthcare practitioner. | |
![]() ![]() ![]() ![]() | 0..1 | Period | A Practicing certificate has an effective date range that is provided by the responsible authority. | |
![]() ![]() ![]() | 0..* | BackboneElement | Health worker scope of practice registration 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 |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | A code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003 | |
![]() ![]() ![]() ![]() | 0..1 | Period | Scope on practice has an effective date from and/or to | |
![]() ![]() ![]() | 0..* | BackboneElement | Conditions on practice for the health practitioner | |
![]() ![]() ![]() ![]() | 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 | string | A narrative describing the conditions that may apply to a particular provider’s scope of practice | |
![]() ![]() ![]() ![]() | 0..1 | Period | Conditions on practice effective date from and/or to | |
![]() ![]() ![]() | 0..* | BackboneElement | The additional authorisations that a health worker is authorised to practice or prescribe | |
![]() ![]() ![]() ![]() | 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 | A coded value of the additional authorisations that a health worker is authorised to practice or prescribe | |
![]() ![]() ![]() ![]() | 0..1 | Period | Additional authorisations to practice effective date range from and/or to | |
![]() ![]() ![]() | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
![]() ![]() ![]() ![]() | 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 ten-character identifier assigned by the HPI system to an individual role | |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The designated the role of a health worker | |
![]() ![]() ![]() ![]() | 0..1 | Period | Role date effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
![]() |
Path | Conformance | ValueSet | URI |
HealthcarePractitioner-cs.ContactInformation.ContactUsage | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personalhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal |
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 | Healthcare practitioner Instances of this logical model are not marked to be the target of a Reference | |
![]() ![]() ![]() | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
![]() ![]() ![]() | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
![]() ![]() ![]() ![]() | 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 | HealthcarePractitioner.PersonName.age | |
![]() ![]() ![]() | 0..1 | date | The date on which the person was born | |
![]() ![]() ![]() | 0..1 | CodeableConcept | A self-identified classification of the gender of the person | |
![]() ![]() ![]() | 0..1 | CodeableConcept | A self-identified classification of the ethnicity of the person | |
![]() ![]() ![]() | 0..1 | date | The date the person died | |
![]() ![]() ![]() | 0..* | BackboneElement | The address of the person | |
![]() ![]() ![]() ![]() | 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 | string | HealthcarePractitioner.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..* | BackboneElement | The methods of electronic communication to be used to contact a healthcare practitioner | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The 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) | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The code representing the type of electronic contact medium to be used | |
![]() ![]() ![]() ![]() | 0..1 | string | The contact details may comprise an electronic address or a number | |
![]() ![]() ![]() ![]() | 0..1 | boolean | This indicates that the contact information is confidential | |
![]() ![]() ![]() ![]() | 0..1 | Period | Date contact details effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | boolean | This flag denotes that the contact details provided are the person’s preference | |
![]() ![]() ![]() | 0..* | CodeableConcept | A code representing the languages spoken or understood by the person | |
![]() ![]() ![]() | 0..* | BackboneElement | A health worker’s qualifications | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the qualification that enabled the health worker to be registered with the appropriate responsible authority | |
![]() ![]() ![]() ![]() | 0..1 | date | The year in which the health worker achieved the qualification | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the granting institution that conferred the qualification | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the city where the granting institution is located | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The identifier for the Country or nation of the granting institution | |
![]() ![]() ![]() | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | A unique identifier assigned to a health worker by an assigning source | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code to identify the type of professional registration the health worker has been assigned | |
![]() ![]() ![]() ![]() | 0..1 | date | The date on which the health worker first became registered with a responsible authority | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source | |
![]() ![]() ![]() | 0..* | BackboneElement | Practicing certificate details are recorded for health practitioners, who operate under a responsible authority. | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Responsible authority who has issued practicing certificate for healthcare practitioner. | |
![]() ![]() ![]() ![]() | 0..1 | Period | A Practicing certificate has an effective date range that is provided by the responsible authority. | |
![]() ![]() ![]() | 0..* | BackboneElement | Health worker scope of practice registration details | |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | A code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003 | |
![]() ![]() ![]() ![]() | 0..1 | Period | Scope on practice has an effective date from and/or to | |
![]() ![]() ![]() | 0..* | BackboneElement | Conditions on practice for the health practitioner | |
![]() ![]() ![]() ![]() | 0..1 | string | A narrative describing the conditions that may apply to a particular provider’s scope of practice | |
![]() ![]() ![]() ![]() | 0..1 | Period | Conditions on practice effective date from and/or to | |
![]() ![]() ![]() | 0..* | BackboneElement | The additional authorisations that a health worker is authorised to practice or prescribe | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A coded value of the additional authorisations that a health worker is authorised to practice or prescribe | |
![]() ![]() ![]() ![]() | 0..1 | Period | Additional authorisations to practice effective date range from and/or to | |
![]() ![]() ![]() | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
![]() ![]() ![]() ![]() | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The designated the role of a health worker | |
![]() ![]() ![]() ![]() | 0..1 | Period | Role date effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
![]() |
Path | Conformance | ValueSet | URI |
HealthcarePractitioner-cs.ContactInformation.ContactUsage | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personalhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Base | Healthcare practitioner Instances of this logical model are not marked to be the target of a Reference | |
![]() ![]() ![]() | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
![]() ![]() ![]() | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
![]() ![]() ![]() ![]() | ?!Σ | 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 | HealthcarePractitioner.PersonName.age | |
![]() ![]() ![]() | 0..1 | date | The date on which the person was born | |
![]() ![]() ![]() | 0..1 | CodeableConcept | A self-identified classification of the gender of the person | |
![]() ![]() ![]() | 0..1 | CodeableConcept | A self-identified classification of the ethnicity of the person | |
![]() ![]() ![]() | 0..1 | date | The date the person died | |
![]() ![]() ![]() | 0..* | BackboneElement | The address of the person | |
![]() ![]() ![]() ![]() | ?!Σ | 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 | string | HealthcarePractitioner.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..* | BackboneElement | The methods of electronic communication to be used to contact a healthcare practitioner | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The 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) | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The code representing the type of electronic contact medium to be used | |
![]() ![]() ![]() ![]() | 0..1 | string | The contact details may comprise an electronic address or a number | |
![]() ![]() ![]() ![]() | 0..1 | boolean | This indicates that the contact information is confidential | |
![]() ![]() ![]() ![]() | 0..1 | Period | Date contact details effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | boolean | This flag denotes that the contact details provided are the person’s preference | |
![]() ![]() ![]() | 0..* | CodeableConcept | A code representing the languages spoken or understood by the person | |
![]() ![]() ![]() | 0..* | BackboneElement | A health worker’s qualifications | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the qualification that enabled the health worker to be registered with the appropriate responsible authority | |
![]() ![]() ![]() ![]() | 0..1 | date | The year in which the health worker achieved the qualification | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the granting institution that conferred the qualification | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the city where the granting institution is located | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The identifier for the Country or nation of the granting institution | |
![]() ![]() ![]() | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | A unique identifier assigned to a health worker by an assigning source | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code to identify the type of professional registration the health worker has been assigned | |
![]() ![]() ![]() ![]() | 0..1 | date | The date on which the health worker first became registered with a responsible authority | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source | |
![]() ![]() ![]() | 0..* | BackboneElement | Practicing certificate details are recorded for health practitioners, who operate under a responsible authority. | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Responsible authority who has issued practicing certificate for healthcare practitioner. | |
![]() ![]() ![]() ![]() | 0..1 | Period | A Practicing certificate has an effective date range that is provided by the responsible authority. | |
![]() ![]() ![]() | 0..* | BackboneElement | Health worker scope of practice registration details | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | A code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003 | |
![]() ![]() ![]() ![]() | 0..1 | Period | Scope on practice has an effective date from and/or to | |
![]() ![]() ![]() | 0..* | BackboneElement | Conditions on practice for the health practitioner | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | string | A narrative describing the conditions that may apply to a particular provider’s scope of practice | |
![]() ![]() ![]() ![]() | 0..1 | Period | Conditions on practice effective date from and/or to | |
![]() ![]() ![]() | 0..* | BackboneElement | The additional authorisations that a health worker is authorised to practice or prescribe | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A coded value of the additional authorisations that a health worker is authorised to practice or prescribe | |
![]() ![]() ![]() ![]() | 0..1 | Period | Additional authorisations to practice effective date range from and/or to | |
![]() ![]() ![]() | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | Identifier | A unique ten-character identifier assigned by the HPI system to an individual role | |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The designated the role of a health worker | |
![]() ![]() ![]() ![]() | 0..1 | Period | Role date effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
![]() |
Path | Conformance | ValueSet | URI |
HealthcarePractitioner-cs.ContactInformation.ContactUsage | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personalhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal |
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 | Healthcare practitioner Instances of this logical model are not marked to be the target of a Reference | |
![]() ![]() ![]() | 0..1 | Identifier | HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker | |
![]() ![]() ![]() | 0..1 | BackboneElement | Person name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names. | |
![]() ![]() ![]() ![]() | 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 | HealthcarePractitioner.PersonName.age | |
![]() ![]() ![]() | 0..1 | date | The date on which the person was born | |
![]() ![]() ![]() | 0..1 | CodeableConcept | A self-identified classification of the gender of the person | |
![]() ![]() ![]() | 0..1 | CodeableConcept | A self-identified classification of the ethnicity of the person | |
![]() ![]() ![]() | 0..1 | date | The date the person died | |
![]() ![]() ![]() | 0..* | BackboneElement | The address of the person | |
![]() ![]() ![]() ![]() | 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 | string | HealthcarePractitioner.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..* | BackboneElement | The methods of electronic communication to be used to contact a healthcare practitioner | |
![]() ![]() ![]() ![]() | 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 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) | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The code representing the type of electronic contact medium to be used | |
![]() ![]() ![]() ![]() | 0..1 | string | The contact details may comprise an electronic address or a number | |
![]() ![]() ![]() ![]() | 0..1 | boolean | This indicates that the contact information is confidential | |
![]() ![]() ![]() ![]() | 0..1 | Period | Date contact details effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | boolean | This flag denotes that the contact details provided are the person’s preference | |
![]() ![]() ![]() | 0..* | CodeableConcept | A code representing the languages spoken or understood by the person | |
![]() ![]() ![]() | 0..* | BackboneElement | A health worker’s qualifications | |
![]() ![]() ![]() ![]() | 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 | string | The name of the qualification that enabled the health worker to be registered with the appropriate responsible authority | |
![]() ![]() ![]() ![]() | 0..1 | date | The year in which the health worker achieved the qualification | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the granting institution that conferred the qualification | |
![]() ![]() ![]() ![]() | 0..1 | string | The name of the city where the granting institution is located | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The identifier for the Country or nation of the granting institution | |
![]() ![]() ![]() | 0..* | BackboneElement | the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced | |
![]() ![]() ![]() ![]() | 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 HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | A unique identifier assigned to a health worker by an assigning source | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | A code to identify the type of professional registration the health worker has been assigned | |
![]() ![]() ![]() ![]() | 0..1 | date | The date on which the health worker first became registered with a responsible authority | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | An indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source | |
![]() ![]() ![]() | 0..* | BackboneElement | Practicing certificate details are recorded for health practitioners, who operate under a responsible authority. | |
![]() ![]() ![]() ![]() | 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 | Responsible authority who has issued practicing certificate for healthcare practitioner. | |
![]() ![]() ![]() ![]() | 0..1 | Period | A Practicing certificate has an effective date range that is provided by the responsible authority. | |
![]() ![]() ![]() | 0..* | BackboneElement | Health worker scope of practice registration 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 |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | A code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003 | |
![]() ![]() ![]() ![]() | 0..1 | Period | Scope on practice has an effective date from and/or to | |
![]() ![]() ![]() | 0..* | BackboneElement | Conditions on practice for the health practitioner | |
![]() ![]() ![]() ![]() | 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 | string | A narrative describing the conditions that may apply to a particular provider’s scope of practice | |
![]() ![]() ![]() ![]() | 0..1 | Period | Conditions on practice effective date from and/or to | |
![]() ![]() ![]() | 0..* | BackboneElement | The additional authorisations that a health worker is authorised to practice or prescribe | |
![]() ![]() ![]() ![]() | 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 | A coded value of the additional authorisations that a health worker is authorised to practice or prescribe | |
![]() ![]() ![]() ![]() | 0..1 | Period | Additional authorisations to practice effective date range from and/or to | |
![]() ![]() ![]() | 0..1 | BackboneElement | The employment of a health worker in a specific role | |
![]() ![]() ![]() ![]() | 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 ten-character identifier assigned by the HPI system to an individual role | |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The designated the role of a health worker | |
![]() ![]() ![]() ![]() | 0..1 | Period | Role date effective from and/or to | |
![]() ![]() ![]() ![]() | 0..1 | boolean | Whether or not the role of health care practitioner is confidential | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | The identifier of the healthcare facility at which the practitioner works in this role. | |
![]() |
Path | Conformance | ValueSet | URI |
HealthcarePractitioner-cs.ContactInformation.ContactUsage | preferred | https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personalhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal |
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