CanShare models
0.1.0 - ci-build

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

Logical Model: HealthcarePractitioner_cs - Detailed Descriptions

Draft as of 2024-03-04

Definitions for the HealthcarePractitioner-cs logical model.

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

0. HealthcarePractitioner-cs
Definition

A person who is directly or indirectly involved in the provision of healthcare or related services.

ShortHealthcare practitioner
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HealthcarePractitioner-cs.Id
Definition

HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker

ShortHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
Control0..1
TypeIdentifier
4. HealthcarePractitioner-cs.PersonName
Definition

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.

ShortPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
Control0..1
TypeBackboneElement
6. HealthcarePractitioner-cs.PersonName.Title
Definition

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

ShortThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
Control0..1
TypeCodeableConcept
8. HealthcarePractitioner-cs.PersonName.GivenName
Definition

The person’s forename or given name at birth

ShortThe person’s forename or given name at birth
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. HealthcarePractitioner-cs.PersonName.OtherGivenName
Definition

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

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

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

ShortThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. HealthcarePractitioner-cs.PersonName.NameSuffix
Definition

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

ShortThe 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
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. HealthcarePractitioner-cs.PersonName.PreferredNameIndicator
Definition

An indicator used to denote that a particular person name is the person’s preferred name

ShortAn indicator used to denote that a particular person name is the person’s preferred name
Control0..1
TypeCodeableConcept
18. HealthcarePractitioner-cs.PersonName.NameProtectionFlag
Definition

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

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. HealthcarePractitioner-cs.PersonName.age
Definition

HealthcarePractitioner.PersonName.age

ShortHealthcarePractitioner.PersonName.age
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. HealthcarePractitioner-cs.DOB
Definition

The date on which the person was born

ShortThe date on which the person was born
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. HealthcarePractitioner-cs.Gender
Definition

A self-identified classification of the gender of the person

ShortA self-identified classification of the gender of the person
Control0..1
TypeCodeableConcept
26. HealthcarePractitioner-cs.Ethnicity
Definition

A self-identified classification of the ethnicity of the person

ShortA self-identified classification of the ethnicity of the person
Control0..1
TypeCodeableConcept
28. HealthcarePractitioner-cs.DateDeath
Definition

The date the person died

ShortThe date the person died
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. HealthcarePractitioner-cs.Address
Definition

The address of the person

ShortThe address of the person
Control0..*
TypeBackboneElement
32. HealthcarePractitioner-cs.Address.Type
Definition

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

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

The name of the building or institution.

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

The floor, unit and/or street address details.

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

Other geographic information related to the address

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

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

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

HealthcarePractitioner.Address.City

ShortHealthcarePractitioner.Address.City
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. HealthcarePractitioner-cs.Address.Postcode
Definition

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

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

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

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

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

ShortThis indicator denotes that the person’s address information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
50. HealthcarePractitioner-cs.ContactInformation
Definition

The methods of electronic communication to be used to contact a healthcare practitioner

ShortThe methods of electronic communication to be used to contact a healthcare practitioner
Control0..*
TypeBackboneElement
52. HealthcarePractitioner-cs.ContactInformation.ContactUsage
Definition

The classification that specifies the way in which the contact medium is intended to be used

ShortThe classification that specifies the way in which the contact medium is intended to be used
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
TypeCodeableConcept
54. HealthcarePractitioner-cs.ContactInformation.ContactType
Definition

The code representing the type of electronic contact medium to be used

ShortThe code representing the type of electronic contact medium to be used
Control0..1
TypeCodeableConcept
56. HealthcarePractitioner-cs.ContactInformation.ContactDetail
Definition

The contact details may comprise an electronic address or a number

ShortThe contact details may comprise an electronic address or a number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
58. HealthcarePractitioner-cs.ContactInformation.ContactProtectedFlag
Definition

This indicates that the contact information is confidential

ShortThis indicates that the contact information is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
60. HealthcarePractitioner-cs.ContactInformation.ContactDetailsPeriod
Definition

Date contact details effective from and/or to

ShortDate contact details effective from and/or to
Control0..1
TypePeriod
62. HealthcarePractitioner-cs.ContactInformation.PerferredContactFlag
Definition

This flag denotes that the contact details provided are the person’s preference

ShortThis flag denotes that the contact details provided are the person’s preference
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
64. HealthcarePractitioner-cs.Language
Definition

A code representing the languages spoken or understood by the person

ShortA code representing the languages spoken or understood by the person
Control0..*
TypeCodeableConcept
66. HealthcarePractitioner-cs.Qualification
Definition

A health worker’s qualifications

ShortA health worker’s qualifications
Control0..*
TypeBackboneElement
68. HealthcarePractitioner-cs.Qualification.QualificationName
Definition

The name of the qualification that enabled the health worker to be registered with the appropriate responsible authority

ShortThe name of the qualification that enabled the health worker to be registered with the appropriate responsible authority
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
70. HealthcarePractitioner-cs.Qualification.QualificationYear
Definition

The year in which the health worker achieved the qualification

ShortThe year in which the health worker achieved the qualification
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
72. HealthcarePractitioner-cs.Qualification.GrantingInstitution
Definition

The name of the granting institution that conferred the qualification

ShortThe name of the granting institution that conferred the qualification
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
74. HealthcarePractitioner-cs.Qualification.GrantingInstitutionCity
Definition

The name of the city where the granting institution is located

ShortThe name of the city where the granting institution is located
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
76. HealthcarePractitioner-cs.Qualification.GrantingInstitutionCountry
Definition

The identifier for the Country or nation of the granting institution

ShortThe identifier for the Country or nation of the granting institution
Control0..1
TypeCodeableConcept
78. HealthcarePractitioner-cs.ProfessionalRegistration
Definition

the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced

Shortthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
Control0..*
TypeBackboneElement
80. HealthcarePractitioner-cs.ProfessionalRegistration.AssigningOrganisationIdentifier
Definition

The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number

ShortThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
Control0..1
TypeCodeableConcept
82. HealthcarePractitioner-cs.ProfessionalRegistration.AssigningSourceIdentifier
Definition

A unique identifier assigned to a health worker by an assigning source

ShortA unique identifier assigned to a health worker by an assigning source
Control0..1
TypeIdentifier
84. HealthcarePractitioner-cs.ProfessionalRegistration.ResponsibleAuthorityCode
Definition

A code to identify the type of professional registration the health worker has been assigned

ShortA code to identify the type of professional registration the health worker has been assigned
Control0..1
TypeCodeableConcept
86. HealthcarePractitioner-cs.ProfessionalRegistration.InitialRegistrationDate
Definition

The date on which the health worker first became registered with a responsible authority

ShortThe date on which the health worker first became registered with a responsible authority
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
88. HealthcarePractitioner-cs.ProfessionalRegistration.RegistrationStatusCode
Definition

An indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source

ShortAn indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source
Control0..1
TypeCodeableConcept
90. HealthcarePractitioner-cs.PracticingCertificate
Definition

Practicing certificate details are recorded for health practitioners, who operate under a responsible authority.

ShortPracticing certificate details are recorded for health practitioners, who operate under a responsible authority.
Control0..*
TypeBackboneElement
92. HealthcarePractitioner-cs.PracticingCertificate.ResponsibleAuthority
Definition

Responsible authority who has issued practicing certificate for healthcare practitioner.

ShortResponsible authority who has issued practicing certificate for healthcare practitioner.
Control0..1
TypeCodeableConcept
94. HealthcarePractitioner-cs.PracticingCertificate.Effectiveperiod
Definition

A Practicing certificate has an effective date range that is provided by the responsible authority.

ShortA Practicing certificate has an effective date range that is provided by the responsible authority.
Control0..1
TypePeriod
96. HealthcarePractitioner-cs.ScopePractice
Definition

Health worker scope of practice registration details

ShortHealth worker scope of practice registration details
Control0..*
TypeBackboneElement
98. HealthcarePractitioner-cs.ScopePractice.ScopePracticeCode
Definition

A code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003

ShortA code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003
Control1..*
TypeCodeableConcept
100. HealthcarePractitioner-cs.ScopePractice.EffectiveDateRange
Definition

Scope on practice has an effective date from and/or to

ShortScope on practice has an effective date from and/or to
Control0..1
TypePeriod
102. HealthcarePractitioner-cs.ConditionsPractice
Definition

Conditions on practice for the health practitioner

ShortConditions on practice for the health practitioner
Control0..*
TypeBackboneElement
104. HealthcarePractitioner-cs.ConditionsPractice.ConditionsPracticeDescription
Definition

A narrative describing the conditions that may apply to a particular provider’s scope of practice

ShortA narrative describing the conditions that may apply to a particular provider’s scope of practice
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
106. HealthcarePractitioner-cs.ConditionsPractice.EffectiveDateRange
Definition

Conditions on practice effective date from and/or to

ShortConditions on practice effective date from and/or to
Control0..1
TypePeriod
108. HealthcarePractitioner-cs.AdditionalAuthorisationsPractice
Definition

The additional authorisations that a health worker is authorised to practice or prescribe

ShortThe additional authorisations that a health worker is authorised to practice or prescribe
Control0..*
TypeBackboneElement
110. HealthcarePractitioner-cs.AdditionalAuthorisationsPractice.AuthorisationTypeCode
Definition

A coded value of the additional authorisations that a health worker is authorised to practice or prescribe

ShortA coded value of the additional authorisations that a health worker is authorised to practice or prescribe
Control0..1
TypeCodeableConcept
112. HealthcarePractitioner-cs.AdditionalAuthorisationsPractice.EffectiveDateRange
Definition

Additional authorisations to practice effective date range from and/or to

ShortAdditional authorisations to practice effective date range from and/or to
Control0..1
TypePeriod
114. HealthcarePractitioner-cs.HealthWorkerRole
Definition

The employment of a health worker in a specific role

ShortThe employment of a health worker in a specific role
Control0..1
TypeBackboneElement
116. HealthcarePractitioner-cs.HealthWorkerRole.PRI
Definition

A unique ten-character identifier assigned by the HPI system to an individual role

ShortA unique ten-character identifier assigned by the HPI system to an individual role
Control1..1
TypeIdentifier
118. HealthcarePractitioner-cs.HealthWorkerRole.RoleCode
Definition

The designated the role of a health worker

ShortThe designated the role of a health worker
Control1..1
TypeCodeableConcept
120. HealthcarePractitioner-cs.HealthWorkerRole.EffectiveDateRange
Definition

Role date effective from and/or to

ShortRole date effective from and/or to
Control0..1
TypePeriod
122. HealthcarePractitioner-cs.HealthWorkerRole.RoleConfidential
Definition

Whether or not the role of health care practitioner is confidential

ShortWhether or not the role of health care practitioner is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
124. HealthcarePractitioner-cs.HealthWorkerRole.FacilityId
Definition

The identifier of the healthcare facility at which the practitioner works in this role.

ShortThe identifier of the healthcare facility at which the practitioner works in this role.
Control0..1
TypeIdentifier

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

0. HealthcarePractitioner-cs
Definition

A person who is directly or indirectly involved in the provision of healthcare or related services.

ShortHealthcare practitioner
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HealthcarePractitioner-cs.Id
Definition

HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker

ShortHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
Control0..1
TypeIdentifier
4. HealthcarePractitioner-cs.PersonName
Definition

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.

ShortPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. HealthcarePractitioner-cs.PersonName.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

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

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

The person’s forename or given name at birth

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

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

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

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

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

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

ShortThe 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
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. HealthcarePractitioner-cs.PersonName.PreferredNameIndicator
Definition

An indicator used to denote that a particular person name is the person’s preferred name

ShortAn indicator used to denote that a particular person name is the person’s preferred name
Control0..1
TypeCodeableConcept
20. HealthcarePractitioner-cs.PersonName.NameProtectionFlag
Definition

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

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. HealthcarePractitioner-cs.PersonName.age
Definition

HealthcarePractitioner.PersonName.age

ShortHealthcarePractitioner.PersonName.age
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. HealthcarePractitioner-cs.DOB
Definition

The date on which the person was born

ShortThe date on which the person was born
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. HealthcarePractitioner-cs.Gender
Definition

A self-identified classification of the gender of the person

ShortA self-identified classification of the gender of the person
Control0..1
TypeCodeableConcept
28. HealthcarePractitioner-cs.Ethnicity
Definition

A self-identified classification of the ethnicity of the person

ShortA self-identified classification of the ethnicity of the person
Control0..1
TypeCodeableConcept
30. HealthcarePractitioner-cs.DateDeath
Definition

The date the person died

ShortThe date the person died
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. HealthcarePractitioner-cs.Address
Definition

The address of the person

ShortThe address of the person
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. HealthcarePractitioner-cs.Address.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

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

ShortThe type of address, e.g. residential (physical), mailing (postal)
Control0..1
TypeCodeableConcept
38. HealthcarePractitioner-cs.Address.BuildingName
Definition

The name of the building or institution.

ShortThe name of the building or institution.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. HealthcarePractitioner-cs.Address.StreetAddress1
Definition

The floor, unit and/or street address details.

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

Other geographic information related to the address

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

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

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

HealthcarePractitioner.Address.City

ShortHealthcarePractitioner.Address.City
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. HealthcarePractitioner-cs.Address.Postcode
Definition

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

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

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

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

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

ShortThis indicator denotes that the person’s address information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
54. HealthcarePractitioner-cs.ContactInformation
Definition

The methods of electronic communication to be used to contact a healthcare practitioner

ShortThe methods of electronic communication to be used to contact a healthcare practitioner
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. HealthcarePractitioner-cs.ContactInformation.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The classification that specifies the way in which the contact medium is intended to be used

ShortThe classification that specifies the way in which the contact medium is intended to be used
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
TypeCodeableConcept
60. HealthcarePractitioner-cs.ContactInformation.ContactType
Definition

The code representing the type of electronic contact medium to be used

ShortThe code representing the type of electronic contact medium to be used
Control0..1
TypeCodeableConcept
62. HealthcarePractitioner-cs.ContactInformation.ContactDetail
Definition

The contact details may comprise an electronic address or a number

ShortThe contact details may comprise an electronic address or a number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
64. HealthcarePractitioner-cs.ContactInformation.ContactProtectedFlag
Definition

This indicates that the contact information is confidential

ShortThis indicates that the contact information is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
66. HealthcarePractitioner-cs.ContactInformation.ContactDetailsPeriod
Definition

Date contact details effective from and/or to

ShortDate contact details effective from and/or to
Control0..1
TypePeriod
68. HealthcarePractitioner-cs.ContactInformation.PerferredContactFlag
Definition

This flag denotes that the contact details provided are the person’s preference

ShortThis flag denotes that the contact details provided are the person’s preference
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
70. HealthcarePractitioner-cs.Language
Definition

A code representing the languages spoken or understood by the person

ShortA code representing the languages spoken or understood by the person
Control0..*
TypeCodeableConcept
72. HealthcarePractitioner-cs.Qualification
Definition

A health worker’s qualifications

ShortA health worker’s qualifications
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. HealthcarePractitioner-cs.Qualification.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The name of the qualification that enabled the health worker to be registered with the appropriate responsible authority

ShortThe name of the qualification that enabled the health worker to be registered with the appropriate responsible authority
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
78. HealthcarePractitioner-cs.Qualification.QualificationYear
Definition

The year in which the health worker achieved the qualification

ShortThe year in which the health worker achieved the qualification
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
80. HealthcarePractitioner-cs.Qualification.GrantingInstitution
Definition

The name of the granting institution that conferred the qualification

ShortThe name of the granting institution that conferred the qualification
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
82. HealthcarePractitioner-cs.Qualification.GrantingInstitutionCity
Definition

The name of the city where the granting institution is located

ShortThe name of the city where the granting institution is located
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
84. HealthcarePractitioner-cs.Qualification.GrantingInstitutionCountry
Definition

The identifier for the Country or nation of the granting institution

ShortThe identifier for the Country or nation of the granting institution
Control0..1
TypeCodeableConcept
86. HealthcarePractitioner-cs.ProfessionalRegistration
Definition

the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced

Shortthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. HealthcarePractitioner-cs.ProfessionalRegistration.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number

ShortThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
Control0..1
TypeCodeableConcept
92. HealthcarePractitioner-cs.ProfessionalRegistration.AssigningSourceIdentifier
Definition

A unique identifier assigned to a health worker by an assigning source

ShortA unique identifier assigned to a health worker by an assigning source
Control0..1
TypeIdentifier
94. HealthcarePractitioner-cs.ProfessionalRegistration.ResponsibleAuthorityCode
Definition

A code to identify the type of professional registration the health worker has been assigned

ShortA code to identify the type of professional registration the health worker has been assigned
Control0..1
TypeCodeableConcept
96. HealthcarePractitioner-cs.ProfessionalRegistration.InitialRegistrationDate
Definition

The date on which the health worker first became registered with a responsible authority

ShortThe date on which the health worker first became registered with a responsible authority
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
98. HealthcarePractitioner-cs.ProfessionalRegistration.RegistrationStatusCode
Definition

An indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source

ShortAn indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source
Control0..1
TypeCodeableConcept
100. HealthcarePractitioner-cs.PracticingCertificate
Definition

Practicing certificate details are recorded for health practitioners, who operate under a responsible authority.

ShortPracticing certificate details are recorded for health practitioners, who operate under a responsible authority.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. HealthcarePractitioner-cs.PracticingCertificate.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

Responsible authority who has issued practicing certificate for healthcare practitioner.

ShortResponsible authority who has issued practicing certificate for healthcare practitioner.
Control0..1
TypeCodeableConcept
106. HealthcarePractitioner-cs.PracticingCertificate.Effectiveperiod
Definition

A Practicing certificate has an effective date range that is provided by the responsible authority.

ShortA Practicing certificate has an effective date range that is provided by the responsible authority.
Control0..1
TypePeriod
108. HealthcarePractitioner-cs.ScopePractice
Definition

Health worker scope of practice registration details

ShortHealth worker scope of practice registration details
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. HealthcarePractitioner-cs.ScopePractice.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

A code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003

ShortA code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003
Control1..*
TypeCodeableConcept
114. HealthcarePractitioner-cs.ScopePractice.EffectiveDateRange
Definition

Scope on practice has an effective date from and/or to

ShortScope on practice has an effective date from and/or to
Control0..1
TypePeriod
116. HealthcarePractitioner-cs.ConditionsPractice
Definition

Conditions on practice for the health practitioner

ShortConditions on practice for the health practitioner
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. HealthcarePractitioner-cs.ConditionsPractice.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

A narrative describing the conditions that may apply to a particular provider’s scope of practice

ShortA narrative describing the conditions that may apply to a particular provider’s scope of practice
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
122. HealthcarePractitioner-cs.ConditionsPractice.EffectiveDateRange
Definition

Conditions on practice effective date from and/or to

ShortConditions on practice effective date from and/or to
Control0..1
TypePeriod
124. HealthcarePractitioner-cs.AdditionalAuthorisationsPractice
Definition

The additional authorisations that a health worker is authorised to practice or prescribe

ShortThe additional authorisations that a health worker is authorised to practice or prescribe
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. HealthcarePractitioner-cs.AdditionalAuthorisationsPractice.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

A coded value of the additional authorisations that a health worker is authorised to practice or prescribe

ShortA coded value of the additional authorisations that a health worker is authorised to practice or prescribe
Control0..1
TypeCodeableConcept
130. HealthcarePractitioner-cs.AdditionalAuthorisationsPractice.EffectiveDateRange
Definition

Additional authorisations to practice effective date range from and/or to

ShortAdditional authorisations to practice effective date range from and/or to
Control0..1
TypePeriod
132. HealthcarePractitioner-cs.HealthWorkerRole
Definition

The employment of a health worker in a specific role

ShortThe employment of a health worker in a specific role
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. HealthcarePractitioner-cs.HealthWorkerRole.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

A unique ten-character identifier assigned by the HPI system to an individual role

ShortA unique ten-character identifier assigned by the HPI system to an individual role
Control1..1
TypeIdentifier
138. HealthcarePractitioner-cs.HealthWorkerRole.RoleCode
Definition

The designated the role of a health worker

ShortThe designated the role of a health worker
Control1..1
TypeCodeableConcept
140. HealthcarePractitioner-cs.HealthWorkerRole.EffectiveDateRange
Definition

Role date effective from and/or to

ShortRole date effective from and/or to
Control0..1
TypePeriod
142. HealthcarePractitioner-cs.HealthWorkerRole.RoleConfidential
Definition

Whether or not the role of health care practitioner is confidential

ShortWhether or not the role of health care practitioner is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
144. HealthcarePractitioner-cs.HealthWorkerRole.FacilityId
Definition

The identifier of the healthcare facility at which the practitioner works in this role.

ShortThe identifier of the healthcare facility at which the practitioner works in this role.
Control0..1
TypeIdentifier

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

0. HealthcarePractitioner-cs
Definition

A person who is directly or indirectly involved in the provision of healthcare or related services.

ShortHealthcare practitioner
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. HealthcarePractitioner-cs.Id
Definition

HPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker

ShortHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
Control0..1
TypeIdentifier
4. HealthcarePractitioner-cs.PersonName
Definition

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.

ShortPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. HealthcarePractitioner-cs.PersonName.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
8. HealthcarePractitioner-cs.PersonName.extension
Definition

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

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

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

The person’s forename or given name at birth

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

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

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

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

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

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

ShortThe 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
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. HealthcarePractitioner-cs.PersonName.PreferredNameIndicator
Definition

An indicator used to denote that a particular person name is the person’s preferred name

ShortAn indicator used to denote that a particular person name is the person’s preferred name
Control0..1
TypeCodeableConcept
24. HealthcarePractitioner-cs.PersonName.NameProtectionFlag
Definition

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

ShortThis indicator denotes that the person’s name information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. HealthcarePractitioner-cs.PersonName.age
Definition

HealthcarePractitioner.PersonName.age

ShortHealthcarePractitioner.PersonName.age
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. HealthcarePractitioner-cs.DOB
Definition

The date on which the person was born

ShortThe date on which the person was born
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. HealthcarePractitioner-cs.Gender
Definition

A self-identified classification of the gender of the person

ShortA self-identified classification of the gender of the person
Control0..1
TypeCodeableConcept
32. HealthcarePractitioner-cs.Ethnicity
Definition

A self-identified classification of the ethnicity of the person

ShortA self-identified classification of the ethnicity of the person
Control0..1
TypeCodeableConcept
34. HealthcarePractitioner-cs.DateDeath
Definition

The date the person died

ShortThe date the person died
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. HealthcarePractitioner-cs.Address
Definition

The address of the person

ShortThe address of the person
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. HealthcarePractitioner-cs.Address.id
Definition

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

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

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

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

ShortThe type of address, e.g. residential (physical), mailing (postal)
Control0..1
TypeCodeableConcept
46. HealthcarePractitioner-cs.Address.BuildingName
Definition

The name of the building or institution.

ShortThe name of the building or institution.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. HealthcarePractitioner-cs.Address.StreetAddress1
Definition

The floor, unit and/or street address details.

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

Other geographic information related to the address

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

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

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

HealthcarePractitioner.Address.City

ShortHealthcarePractitioner.Address.City
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
56. HealthcarePractitioner-cs.Address.Postcode
Definition

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

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

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

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

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

ShortThis indicator denotes that the person’s address information is to be held ‘in confidence’
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
62. HealthcarePractitioner-cs.ContactInformation
Definition

The methods of electronic communication to be used to contact a healthcare practitioner

ShortThe methods of electronic communication to be used to contact a healthcare practitioner
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. HealthcarePractitioner-cs.ContactInformation.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
66. HealthcarePractitioner-cs.ContactInformation.extension
Definition

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The classification that specifies the way in which the contact medium is intended to be used

ShortThe classification that specifies the way in which the contact medium is intended to be used
Control0..1
BindingThe codes SHOULD be taken from https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
(preferred to https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
TypeCodeableConcept
72. HealthcarePractitioner-cs.ContactInformation.ContactType
Definition

The code representing the type of electronic contact medium to be used

ShortThe code representing the type of electronic contact medium to be used
Control0..1
TypeCodeableConcept
74. HealthcarePractitioner-cs.ContactInformation.ContactDetail
Definition

The contact details may comprise an electronic address or a number

ShortThe contact details may comprise an electronic address or a number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
76. HealthcarePractitioner-cs.ContactInformation.ContactProtectedFlag
Definition

This indicates that the contact information is confidential

ShortThis indicates that the contact information is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
78. HealthcarePractitioner-cs.ContactInformation.ContactDetailsPeriod
Definition

Date contact details effective from and/or to

ShortDate contact details effective from and/or to
Control0..1
TypePeriod
80. HealthcarePractitioner-cs.ContactInformation.PerferredContactFlag
Definition

This flag denotes that the contact details provided are the person’s preference

ShortThis flag denotes that the contact details provided are the person’s preference
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
82. HealthcarePractitioner-cs.Language
Definition

A code representing the languages spoken or understood by the person

ShortA code representing the languages spoken or understood by the person
Control0..*
TypeCodeableConcept
84. HealthcarePractitioner-cs.Qualification
Definition

A health worker’s qualifications

ShortA health worker’s qualifications
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. HealthcarePractitioner-cs.Qualification.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
88. HealthcarePractitioner-cs.Qualification.extension
Definition

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The name of the qualification that enabled the health worker to be registered with the appropriate responsible authority

ShortThe name of the qualification that enabled the health worker to be registered with the appropriate responsible authority
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
94. HealthcarePractitioner-cs.Qualification.QualificationYear
Definition

The year in which the health worker achieved the qualification

ShortThe year in which the health worker achieved the qualification
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
96. HealthcarePractitioner-cs.Qualification.GrantingInstitution
Definition

The name of the granting institution that conferred the qualification

ShortThe name of the granting institution that conferred the qualification
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
98. HealthcarePractitioner-cs.Qualification.GrantingInstitutionCity
Definition

The name of the city where the granting institution is located

ShortThe name of the city where the granting institution is located
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
100. HealthcarePractitioner-cs.Qualification.GrantingInstitutionCountry
Definition

The identifier for the Country or nation of the granting institution

ShortThe identifier for the Country or nation of the granting institution
Control0..1
TypeCodeableConcept
102. HealthcarePractitioner-cs.ProfessionalRegistration
Definition

the authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced

Shortthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. HealthcarePractitioner-cs.ProfessionalRegistration.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
106. HealthcarePractitioner-cs.ProfessionalRegistration.extension
Definition

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

The HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number

ShortThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
Control0..1
TypeCodeableConcept
112. HealthcarePractitioner-cs.ProfessionalRegistration.AssigningSourceIdentifier
Definition

A unique identifier assigned to a health worker by an assigning source

ShortA unique identifier assigned to a health worker by an assigning source
Control0..1
TypeIdentifier
114. HealthcarePractitioner-cs.ProfessionalRegistration.ResponsibleAuthorityCode
Definition

A code to identify the type of professional registration the health worker has been assigned

ShortA code to identify the type of professional registration the health worker has been assigned
Control0..1
TypeCodeableConcept
116. HealthcarePractitioner-cs.ProfessionalRegistration.InitialRegistrationDate
Definition

The date on which the health worker first became registered with a responsible authority

ShortThe date on which the health worker first became registered with a responsible authority
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
118. HealthcarePractitioner-cs.ProfessionalRegistration.RegistrationStatusCode
Definition

An indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source

ShortAn indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source
Control0..1
TypeCodeableConcept
120. HealthcarePractitioner-cs.PracticingCertificate
Definition

Practicing certificate details are recorded for health practitioners, who operate under a responsible authority.

ShortPracticing certificate details are recorded for health practitioners, who operate under a responsible authority.
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
122. HealthcarePractitioner-cs.PracticingCertificate.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
124. HealthcarePractitioner-cs.PracticingCertificate.extension
Definition

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

Responsible authority who has issued practicing certificate for healthcare practitioner.

ShortResponsible authority who has issued practicing certificate for healthcare practitioner.
Control0..1
TypeCodeableConcept
130. HealthcarePractitioner-cs.PracticingCertificate.Effectiveperiod
Definition

A Practicing certificate has an effective date range that is provided by the responsible authority.

ShortA Practicing certificate has an effective date range that is provided by the responsible authority.
Control0..1
TypePeriod
132. HealthcarePractitioner-cs.ScopePractice
Definition

Health worker scope of practice registration details

ShortHealth worker scope of practice registration details
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
134. HealthcarePractitioner-cs.ScopePractice.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
136. HealthcarePractitioner-cs.ScopePractice.extension
Definition

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

A code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003

ShortA code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003
Control1..*
TypeCodeableConcept
142. HealthcarePractitioner-cs.ScopePractice.EffectiveDateRange
Definition

Scope on practice has an effective date from and/or to

ShortScope on practice has an effective date from and/or to
Control0..1
TypePeriod
144. HealthcarePractitioner-cs.ConditionsPractice
Definition

Conditions on practice for the health practitioner

ShortConditions on practice for the health practitioner
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. HealthcarePractitioner-cs.ConditionsPractice.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
148. HealthcarePractitioner-cs.ConditionsPractice.extension
Definition

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

A narrative describing the conditions that may apply to a particular provider’s scope of practice

ShortA narrative describing the conditions that may apply to a particular provider’s scope of practice
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
154. HealthcarePractitioner-cs.ConditionsPractice.EffectiveDateRange
Definition

Conditions on practice effective date from and/or to

ShortConditions on practice effective date from and/or to
Control0..1
TypePeriod
156. HealthcarePractitioner-cs.AdditionalAuthorisationsPractice
Definition

The additional authorisations that a health worker is authorised to practice or prescribe

ShortThe additional authorisations that a health worker is authorised to practice or prescribe
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. HealthcarePractitioner-cs.AdditionalAuthorisationsPractice.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
160. HealthcarePractitioner-cs.AdditionalAuthorisationsPractice.extension
Definition

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

A coded value of the additional authorisations that a health worker is authorised to practice or prescribe

ShortA coded value of the additional authorisations that a health worker is authorised to practice or prescribe
Control0..1
TypeCodeableConcept
166. HealthcarePractitioner-cs.AdditionalAuthorisationsPractice.EffectiveDateRange
Definition

Additional authorisations to practice effective date range from and/or to

ShortAdditional authorisations to practice effective date range from and/or to
Control0..1
TypePeriod
168. HealthcarePractitioner-cs.HealthWorkerRole
Definition

The employment of a health worker in a specific role

ShortThe employment of a health worker in a specific role
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. HealthcarePractitioner-cs.HealthWorkerRole.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
172. HealthcarePractitioner-cs.HealthWorkerRole.extension
Definition

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

ShortAdditional content defined by implementations
Comments

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

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

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

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

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

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

A unique ten-character identifier assigned by the HPI system to an individual role

ShortA unique ten-character identifier assigned by the HPI system to an individual role
Control1..1
TypeIdentifier
178. HealthcarePractitioner-cs.HealthWorkerRole.RoleCode
Definition

The designated the role of a health worker

ShortThe designated the role of a health worker
Control1..1
TypeCodeableConcept
180. HealthcarePractitioner-cs.HealthWorkerRole.EffectiveDateRange
Definition

Role date effective from and/or to

ShortRole date effective from and/or to
Control0..1
TypePeriod
182. HealthcarePractitioner-cs.HealthWorkerRole.RoleConfidential
Definition

Whether or not the role of health care practitioner is confidential

ShortWhether or not the role of health care practitioner is confidential
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
184. HealthcarePractitioner-cs.HealthWorkerRole.FacilityId
Definition

The identifier of the healthcare facility at which the practitioner works in this role.

ShortThe identifier of the healthcare facility at which the practitioner works in this role.
Control0..1
TypeIdentifier