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: Healthcare practitioner

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

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

Usage:

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

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcarePractitioner-cs 0..*BaseHealthcare practitioner
Instances of this logical model are not marked to be the target of a Reference
... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
.... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
.... GivenName 0..1stringThe person’s forename or given name at birth
.... OtherGivenName 0..*stringThe person’s other given names or middle name and initials, but not the family name at birth
.... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
.... NameSuffix 0..*stringThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
.... PreferredNameIndicator 0..1CodeableConceptAn indicator used to denote that a particular person name is the person’s preferred name
.... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
.... age 0..1stringHealthcarePractitioner.PersonName.age
... DOB 0..1dateThe date on which the person was born
... Ethnicity 0..1CodeableConceptA self-identified classification of the ethnicity of the person
... DateDeath 0..1dateThe date the person died
... Address 0..*BackboneElementThe address of the person
.... Type 0..1CodeableConceptThe type of address, e.g. residential (physical), mailing (postal)
.... BuildingName 0..1stringThe name of the building or institution.
.... StreetAddress1 0..1stringThe floor, unit and/or street address details.
.... StreetAddress2 0..1stringOther geographic information related to the address
.... Suburb 0..1stringThe name of the suburb or district within a city/town.
.... City 0..1stringHealthcarePractitioner.Address.City
.... Postcode 0..1stringThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
.... CountryCode 0..1codeThe two character ISO code that forms part of the address.
.... AddressProtectedFlag 0..1booleanThis indicator denotes that the person’s address information is to be held ‘in confidence’
... ContactInformation 0..*BackboneElementThe methods of electronic communication to be used to contact a healthcare practitioner
.... ContactUsage 0..1CodeableConceptThe classification that specifies the way in which the contact medium is intended to be used
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal (preferred)
.... ContactType 0..1CodeableConceptThe code representing the type of electronic contact medium to be used
.... ContactDetail 0..1stringThe contact details may comprise an electronic address or a number
.... ContactProtectedFlag 0..1booleanThis indicates that the contact information is confidential
.... ContactDetailsPeriod 0..1PeriodDate contact details effective from and/or to
.... PerferredContactFlag 0..1booleanThis flag denotes that the contact details provided are the person’s preference
... Language 0..*CodeableConceptA code representing the languages spoken or understood by the person
... Qualification 0..*BackboneElementA health worker’s qualifications
.... QualificationName 0..1stringThe name of the qualification that enabled the health worker to be registered with the appropriate responsible authority
.... QualificationYear 0..1dateThe year in which the health worker achieved the qualification
.... GrantingInstitution 0..1stringThe name of the granting institution that conferred the qualification
.... GrantingInstitutionCity 0..1stringThe name of the city where the granting institution is located
.... GrantingInstitutionCountry 0..1CodeableConceptThe identifier for the Country or nation of the granting institution
... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
.... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
.... AssigningSourceIdentifier 0..1IdentifierA unique identifier assigned to a health worker by an assigning source
.... ResponsibleAuthorityCode 0..1CodeableConceptA code to identify the type of professional registration the health worker has been assigned
.... InitialRegistrationDate 0..1dateThe date on which the health worker first became registered with a responsible authority
.... RegistrationStatusCode 0..1CodeableConceptAn indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source
... PracticingCertificate 0..*BackboneElementPracticing certificate details are recorded for health practitioners, who operate under a responsible authority.
.... ResponsibleAuthority 0..1CodeableConceptResponsible authority who has issued practicing certificate for healthcare practitioner.
.... Effectiveperiod 0..1PeriodA Practicing certificate has an effective date range that is provided by the responsible authority.
... ScopePractice 0..*BackboneElementHealth worker scope of practice registration details
.... ScopePracticeCode 1..*CodeableConceptA code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003
.... EffectiveDateRange 0..1PeriodScope on practice has an effective date from and/or to
... ConditionsPractice 0..*BackboneElementConditions on practice for the health practitioner
.... ConditionsPracticeDescription 0..1stringA narrative describing the conditions that may apply to a particular provider’s scope of practice
.... EffectiveDateRange 0..1PeriodConditions on practice effective date from and/or to
... AdditionalAuthorisationsPractice 0..*BackboneElementThe additional authorisations that a health worker is authorised to practice or prescribe
.... AuthorisationTypeCode 0..1CodeableConceptA coded value of the additional authorisations that a health worker is authorised to practice or prescribe
.... EffectiveDateRange 0..1PeriodAdditional authorisations to practice effective date range from and/or to
... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
.... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
.... RoleCode 1..1CodeableConceptThe designated the role of a health worker
.... EffectiveDateRange 0..1PeriodRole date effective from and/or to
.... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
.... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
HealthcarePractitioner-cs.ContactInformation.ContactUsagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcarePractitioner-cs 0..*BaseHealthcare practitioner
Instances of this logical model are not marked to be the target of a Reference
... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
.... GivenName 0..1stringThe person’s forename or given name at birth
.... OtherGivenName 0..*stringThe person’s other given names or middle name and initials, but not the family name at birth
.... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
.... NameSuffix 0..*stringThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
.... PreferredNameIndicator 0..1CodeableConceptAn indicator used to denote that a particular person name is the person’s preferred name
.... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
.... age 0..1stringHealthcarePractitioner.PersonName.age
... DOB 0..1dateThe date on which the person was born
... Ethnicity 0..1CodeableConceptA self-identified classification of the ethnicity of the person
... DateDeath 0..1dateThe date the person died
... Address 0..*BackboneElementThe address of the person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Type 0..1CodeableConceptThe type of address, e.g. residential (physical), mailing (postal)
.... BuildingName 0..1stringThe name of the building or institution.
.... StreetAddress1 0..1stringThe floor, unit and/or street address details.
.... StreetAddress2 0..1stringOther geographic information related to the address
.... Suburb 0..1stringThe name of the suburb or district within a city/town.
.... City 0..1stringHealthcarePractitioner.Address.City
.... Postcode 0..1stringThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
.... CountryCode 0..1codeThe two character ISO code that forms part of the address.
.... AddressProtectedFlag 0..1booleanThis indicator denotes that the person’s address information is to be held ‘in confidence’
... ContactInformation 0..*BackboneElementThe methods of electronic communication to be used to contact a healthcare practitioner
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContactUsage 0..1CodeableConceptThe classification that specifies the way in which the contact medium is intended to be used
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal (preferred)
.... ContactType 0..1CodeableConceptThe code representing the type of electronic contact medium to be used
.... ContactDetail 0..1stringThe contact details may comprise an electronic address or a number
.... ContactProtectedFlag 0..1booleanThis indicates that the contact information is confidential
.... ContactDetailsPeriod 0..1PeriodDate contact details effective from and/or to
.... PerferredContactFlag 0..1booleanThis flag denotes that the contact details provided are the person’s preference
... Language 0..*CodeableConceptA code representing the languages spoken or understood by the person
... Qualification 0..*BackboneElementA health worker’s qualifications
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... QualificationName 0..1stringThe name of the qualification that enabled the health worker to be registered with the appropriate responsible authority
.... QualificationYear 0..1dateThe year in which the health worker achieved the qualification
.... GrantingInstitution 0..1stringThe name of the granting institution that conferred the qualification
.... GrantingInstitutionCity 0..1stringThe name of the city where the granting institution is located
.... GrantingInstitutionCountry 0..1CodeableConceptThe identifier for the Country or nation of the granting institution
... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
.... AssigningSourceIdentifier 0..1IdentifierA unique identifier assigned to a health worker by an assigning source
.... ResponsibleAuthorityCode 0..1CodeableConceptA code to identify the type of professional registration the health worker has been assigned
.... InitialRegistrationDate 0..1dateThe date on which the health worker first became registered with a responsible authority
.... RegistrationStatusCode 0..1CodeableConceptAn indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source
... PracticingCertificate 0..*BackboneElementPracticing certificate details are recorded for health practitioners, who operate under a responsible authority.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ResponsibleAuthority 0..1CodeableConceptResponsible authority who has issued practicing certificate for healthcare practitioner.
.... Effectiveperiod 0..1PeriodA Practicing certificate has an effective date range that is provided by the responsible authority.
... ScopePractice 0..*BackboneElementHealth worker scope of practice registration details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ScopePracticeCode 1..*CodeableConceptA code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003
.... EffectiveDateRange 0..1PeriodScope on practice has an effective date from and/or to
... ConditionsPractice 0..*BackboneElementConditions on practice for the health practitioner
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ConditionsPracticeDescription 0..1stringA narrative describing the conditions that may apply to a particular provider’s scope of practice
.... EffectiveDateRange 0..1PeriodConditions on practice effective date from and/or to
... AdditionalAuthorisationsPractice 0..*BackboneElementThe additional authorisations that a health worker is authorised to practice or prescribe
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... AuthorisationTypeCode 0..1CodeableConceptA coded value of the additional authorisations that a health worker is authorised to practice or prescribe
.... EffectiveDateRange 0..1PeriodAdditional authorisations to practice effective date range from and/or to
... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
.... RoleCode 1..1CodeableConceptThe designated the role of a health worker
.... EffectiveDateRange 0..1PeriodRole date effective from and/or to
.... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
.... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcarePractitioner-cs.ContactInformation.ContactUsagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcarePractitioner-cs 0..*BaseHealthcare practitioner
Instances of this logical model are not marked to be the target of a Reference
... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
.... GivenName 0..1stringThe person’s forename or given name at birth
.... OtherGivenName 0..*stringThe person’s other given names or middle name and initials, but not the family name at birth
.... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
.... NameSuffix 0..*stringThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
.... PreferredNameIndicator 0..1CodeableConceptAn indicator used to denote that a particular person name is the person’s preferred name
.... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
.... age 0..1stringHealthcarePractitioner.PersonName.age
... DOB 0..1dateThe date on which the person was born
... Ethnicity 0..1CodeableConceptA self-identified classification of the ethnicity of the person
... DateDeath 0..1dateThe date the person died
... Address 0..*BackboneElementThe address of the person
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Type 0..1CodeableConceptThe type of address, e.g. residential (physical), mailing (postal)
.... BuildingName 0..1stringThe name of the building or institution.
.... StreetAddress1 0..1stringThe floor, unit and/or street address details.
.... StreetAddress2 0..1stringOther geographic information related to the address
.... Suburb 0..1stringThe name of the suburb or district within a city/town.
.... City 0..1stringHealthcarePractitioner.Address.City
.... Postcode 0..1stringThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
.... CountryCode 0..1codeThe two character ISO code that forms part of the address.
.... AddressProtectedFlag 0..1booleanThis indicator denotes that the person’s address information is to be held ‘in confidence’
... ContactInformation 0..*BackboneElementThe methods of electronic communication to be used to contact a healthcare practitioner
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContactUsage 0..1CodeableConceptThe classification that specifies the way in which the contact medium is intended to be used
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal (preferred)
.... ContactType 0..1CodeableConceptThe code representing the type of electronic contact medium to be used
.... ContactDetail 0..1stringThe contact details may comprise an electronic address or a number
.... ContactProtectedFlag 0..1booleanThis indicates that the contact information is confidential
.... ContactDetailsPeriod 0..1PeriodDate contact details effective from and/or to
.... PerferredContactFlag 0..1booleanThis flag denotes that the contact details provided are the person’s preference
... Language 0..*CodeableConceptA code representing the languages spoken or understood by the person
... Qualification 0..*BackboneElementA health worker’s qualifications
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... QualificationName 0..1stringThe name of the qualification that enabled the health worker to be registered with the appropriate responsible authority
.... QualificationYear 0..1dateThe year in which the health worker achieved the qualification
.... GrantingInstitution 0..1stringThe name of the granting institution that conferred the qualification
.... GrantingInstitutionCity 0..1stringThe name of the city where the granting institution is located
.... GrantingInstitutionCountry 0..1CodeableConceptThe identifier for the Country or nation of the granting institution
... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
.... AssigningSourceIdentifier 0..1IdentifierA unique identifier assigned to a health worker by an assigning source
.... ResponsibleAuthorityCode 0..1CodeableConceptA code to identify the type of professional registration the health worker has been assigned
.... InitialRegistrationDate 0..1dateThe date on which the health worker first became registered with a responsible authority
.... RegistrationStatusCode 0..1CodeableConceptAn indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source
... PracticingCertificate 0..*BackboneElementPracticing certificate details are recorded for health practitioners, who operate under a responsible authority.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ResponsibleAuthority 0..1CodeableConceptResponsible authority who has issued practicing certificate for healthcare practitioner.
.... Effectiveperiod 0..1PeriodA Practicing certificate has an effective date range that is provided by the responsible authority.
... ScopePractice 0..*BackboneElementHealth worker scope of practice registration details
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ScopePracticeCode 1..*CodeableConceptA code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003
.... EffectiveDateRange 0..1PeriodScope on practice has an effective date from and/or to
... ConditionsPractice 0..*BackboneElementConditions on practice for the health practitioner
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ConditionsPracticeDescription 0..1stringA narrative describing the conditions that may apply to a particular provider’s scope of practice
.... EffectiveDateRange 0..1PeriodConditions on practice effective date from and/or to
... AdditionalAuthorisationsPractice 0..*BackboneElementThe additional authorisations that a health worker is authorised to practice or prescribe
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... AuthorisationTypeCode 0..1CodeableConceptA coded value of the additional authorisations that a health worker is authorised to practice or prescribe
.... EffectiveDateRange 0..1PeriodAdditional authorisations to practice effective date range from and/or to
... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
.... RoleCode 1..1CodeableConceptThe designated the role of a health worker
.... EffectiveDateRange 0..1PeriodRole date effective from and/or to
.... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
.... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcarePractitioner-cs.ContactInformation.ContactUsagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal

Constraints

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

This structure is derived from Base

Summary

Mandatory: 0 element (3 nested mandatory elements)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcarePractitioner-cs 0..*BaseHealthcare practitioner
Instances of this logical model are not marked to be the target of a Reference
... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
.... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
.... GivenName 0..1stringThe person’s forename or given name at birth
.... OtherGivenName 0..*stringThe person’s other given names or middle name and initials, but not the family name at birth
.... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
.... NameSuffix 0..*stringThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
.... PreferredNameIndicator 0..1CodeableConceptAn indicator used to denote that a particular person name is the person’s preferred name
.... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
.... age 0..1stringHealthcarePractitioner.PersonName.age
... DOB 0..1dateThe date on which the person was born
... Ethnicity 0..1CodeableConceptA self-identified classification of the ethnicity of the person
... DateDeath 0..1dateThe date the person died
... Address 0..*BackboneElementThe address of the person
.... Type 0..1CodeableConceptThe type of address, e.g. residential (physical), mailing (postal)
.... BuildingName 0..1stringThe name of the building or institution.
.... StreetAddress1 0..1stringThe floor, unit and/or street address details.
.... StreetAddress2 0..1stringOther geographic information related to the address
.... Suburb 0..1stringThe name of the suburb or district within a city/town.
.... City 0..1stringHealthcarePractitioner.Address.City
.... Postcode 0..1stringThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
.... CountryCode 0..1codeThe two character ISO code that forms part of the address.
.... AddressProtectedFlag 0..1booleanThis indicator denotes that the person’s address information is to be held ‘in confidence’
... ContactInformation 0..*BackboneElementThe methods of electronic communication to be used to contact a healthcare practitioner
.... ContactUsage 0..1CodeableConceptThe classification that specifies the way in which the contact medium is intended to be used
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal (preferred)
.... ContactType 0..1CodeableConceptThe code representing the type of electronic contact medium to be used
.... ContactDetail 0..1stringThe contact details may comprise an electronic address or a number
.... ContactProtectedFlag 0..1booleanThis indicates that the contact information is confidential
.... ContactDetailsPeriod 0..1PeriodDate contact details effective from and/or to
.... PerferredContactFlag 0..1booleanThis flag denotes that the contact details provided are the person’s preference
... Language 0..*CodeableConceptA code representing the languages spoken or understood by the person
... Qualification 0..*BackboneElementA health worker’s qualifications
.... QualificationName 0..1stringThe name of the qualification that enabled the health worker to be registered with the appropriate responsible authority
.... QualificationYear 0..1dateThe year in which the health worker achieved the qualification
.... GrantingInstitution 0..1stringThe name of the granting institution that conferred the qualification
.... GrantingInstitutionCity 0..1stringThe name of the city where the granting institution is located
.... GrantingInstitutionCountry 0..1CodeableConceptThe identifier for the Country or nation of the granting institution
... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
.... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
.... AssigningSourceIdentifier 0..1IdentifierA unique identifier assigned to a health worker by an assigning source
.... ResponsibleAuthorityCode 0..1CodeableConceptA code to identify the type of professional registration the health worker has been assigned
.... InitialRegistrationDate 0..1dateThe date on which the health worker first became registered with a responsible authority
.... RegistrationStatusCode 0..1CodeableConceptAn indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source
... PracticingCertificate 0..*BackboneElementPracticing certificate details are recorded for health practitioners, who operate under a responsible authority.
.... ResponsibleAuthority 0..1CodeableConceptResponsible authority who has issued practicing certificate for healthcare practitioner.
.... Effectiveperiod 0..1PeriodA Practicing certificate has an effective date range that is provided by the responsible authority.
... ScopePractice 0..*BackboneElementHealth worker scope of practice registration details
.... ScopePracticeCode 1..*CodeableConceptA code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003
.... EffectiveDateRange 0..1PeriodScope on practice has an effective date from and/or to
... ConditionsPractice 0..*BackboneElementConditions on practice for the health practitioner
.... ConditionsPracticeDescription 0..1stringA narrative describing the conditions that may apply to a particular provider’s scope of practice
.... EffectiveDateRange 0..1PeriodConditions on practice effective date from and/or to
... AdditionalAuthorisationsPractice 0..*BackboneElementThe additional authorisations that a health worker is authorised to practice or prescribe
.... AuthorisationTypeCode 0..1CodeableConceptA coded value of the additional authorisations that a health worker is authorised to practice or prescribe
.... EffectiveDateRange 0..1PeriodAdditional authorisations to practice effective date range from and/or to
... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
.... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
.... RoleCode 1..1CodeableConceptThe designated the role of a health worker
.... EffectiveDateRange 0..1PeriodRole date effective from and/or to
.... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
.... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
HealthcarePractitioner-cs.ContactInformation.ContactUsagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcarePractitioner-cs 0..*BaseHealthcare practitioner
Instances of this logical model are not marked to be the target of a Reference
... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
.... GivenName 0..1stringThe person’s forename or given name at birth
.... OtherGivenName 0..*stringThe person’s other given names or middle name and initials, but not the family name at birth
.... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
.... NameSuffix 0..*stringThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
.... PreferredNameIndicator 0..1CodeableConceptAn indicator used to denote that a particular person name is the person’s preferred name
.... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
.... age 0..1stringHealthcarePractitioner.PersonName.age
... DOB 0..1dateThe date on which the person was born
... Ethnicity 0..1CodeableConceptA self-identified classification of the ethnicity of the person
... DateDeath 0..1dateThe date the person died
... Address 0..*BackboneElementThe address of the person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Type 0..1CodeableConceptThe type of address, e.g. residential (physical), mailing (postal)
.... BuildingName 0..1stringThe name of the building or institution.
.... StreetAddress1 0..1stringThe floor, unit and/or street address details.
.... StreetAddress2 0..1stringOther geographic information related to the address
.... Suburb 0..1stringThe name of the suburb or district within a city/town.
.... City 0..1stringHealthcarePractitioner.Address.City
.... Postcode 0..1stringThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
.... CountryCode 0..1codeThe two character ISO code that forms part of the address.
.... AddressProtectedFlag 0..1booleanThis indicator denotes that the person’s address information is to be held ‘in confidence’
... ContactInformation 0..*BackboneElementThe methods of electronic communication to be used to contact a healthcare practitioner
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContactUsage 0..1CodeableConceptThe classification that specifies the way in which the contact medium is intended to be used
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal (preferred)
.... ContactType 0..1CodeableConceptThe code representing the type of electronic contact medium to be used
.... ContactDetail 0..1stringThe contact details may comprise an electronic address or a number
.... ContactProtectedFlag 0..1booleanThis indicates that the contact information is confidential
.... ContactDetailsPeriod 0..1PeriodDate contact details effective from and/or to
.... PerferredContactFlag 0..1booleanThis flag denotes that the contact details provided are the person’s preference
... Language 0..*CodeableConceptA code representing the languages spoken or understood by the person
... Qualification 0..*BackboneElementA health worker’s qualifications
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... QualificationName 0..1stringThe name of the qualification that enabled the health worker to be registered with the appropriate responsible authority
.... QualificationYear 0..1dateThe year in which the health worker achieved the qualification
.... GrantingInstitution 0..1stringThe name of the granting institution that conferred the qualification
.... GrantingInstitutionCity 0..1stringThe name of the city where the granting institution is located
.... GrantingInstitutionCountry 0..1CodeableConceptThe identifier for the Country or nation of the granting institution
... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
.... AssigningSourceIdentifier 0..1IdentifierA unique identifier assigned to a health worker by an assigning source
.... ResponsibleAuthorityCode 0..1CodeableConceptA code to identify the type of professional registration the health worker has been assigned
.... InitialRegistrationDate 0..1dateThe date on which the health worker first became registered with a responsible authority
.... RegistrationStatusCode 0..1CodeableConceptAn indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source
... PracticingCertificate 0..*BackboneElementPracticing certificate details are recorded for health practitioners, who operate under a responsible authority.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ResponsibleAuthority 0..1CodeableConceptResponsible authority who has issued practicing certificate for healthcare practitioner.
.... Effectiveperiod 0..1PeriodA Practicing certificate has an effective date range that is provided by the responsible authority.
... ScopePractice 0..*BackboneElementHealth worker scope of practice registration details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ScopePracticeCode 1..*CodeableConceptA code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003
.... EffectiveDateRange 0..1PeriodScope on practice has an effective date from and/or to
... ConditionsPractice 0..*BackboneElementConditions on practice for the health practitioner
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ConditionsPracticeDescription 0..1stringA narrative describing the conditions that may apply to a particular provider’s scope of practice
.... EffectiveDateRange 0..1PeriodConditions on practice effective date from and/or to
... AdditionalAuthorisationsPractice 0..*BackboneElementThe additional authorisations that a health worker is authorised to practice or prescribe
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... AuthorisationTypeCode 0..1CodeableConceptA coded value of the additional authorisations that a health worker is authorised to practice or prescribe
.... EffectiveDateRange 0..1PeriodAdditional authorisations to practice effective date range from and/or to
... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
.... RoleCode 1..1CodeableConceptThe designated the role of a health worker
.... EffectiveDateRange 0..1PeriodRole date effective from and/or to
.... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
.... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcarePractitioner-cs.ContactInformation.ContactUsagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcarePractitioner-cs 0..*BaseHealthcare practitioner
Instances of this logical model are not marked to be the target of a Reference
... Id 0..1IdentifierHPI Common Person Number (HPI CPN) is the primary identifier for an individual health worker
... PersonName 0..1BackboneElementPerson name is the name of a natural person. Person name generally consists of a family name or surname, and one or more given names.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Title 0..1CodeableConceptThe ‘Title (prefix)’ is an honorific form of address preceding a name, used when addressing a person
.... GivenName 0..1stringThe person’s forename or given name at birth
.... OtherGivenName 0..*stringThe person’s other given names or middle name and initials, but not the family name at birth
.... FamilyName 0..1stringThe family name (surname) of a person as distinct from their given, second and subsequent name(s)
.... NameSuffix 0..*stringThe suffix contains the parts of a person’s name attached to the end of a name but other than the title, given names and family name – eg, awards, qualifications, academic, honorary, esquire, professional and professional membership
.... PreferredNameIndicator 0..1CodeableConceptAn indicator used to denote that a particular person name is the person’s preferred name
.... NameProtectionFlag 0..1booleanThis indicator denotes that the person’s name information is to be held ‘in confidence’
.... age 0..1stringHealthcarePractitioner.PersonName.age
... DOB 0..1dateThe date on which the person was born
... Ethnicity 0..1CodeableConceptA self-identified classification of the ethnicity of the person
... DateDeath 0..1dateThe date the person died
... Address 0..*BackboneElementThe address of the person
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Type 0..1CodeableConceptThe type of address, e.g. residential (physical), mailing (postal)
.... BuildingName 0..1stringThe name of the building or institution.
.... StreetAddress1 0..1stringThe floor, unit and/or street address details.
.... StreetAddress2 0..1stringOther geographic information related to the address
.... Suburb 0..1stringThe name of the suburb or district within a city/town.
.... City 0..1stringHealthcarePractitioner.Address.City
.... Postcode 0..1stringThe numeric descriptor for a postal delivery area, aligned with the locality, suburb or place for this address.
.... CountryCode 0..1codeThe two character ISO code that forms part of the address.
.... AddressProtectedFlag 0..1booleanThis indicator denotes that the person’s address information is to be held ‘in confidence’
... ContactInformation 0..*BackboneElementThe methods of electronic communication to be used to contact a healthcare practitioner
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ContactUsage 0..1CodeableConceptThe classification that specifies the way in which the contact medium is intended to be used
Binding: https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal (preferred)
.... ContactType 0..1CodeableConceptThe code representing the type of electronic contact medium to be used
.... ContactDetail 0..1stringThe contact details may comprise an electronic address or a number
.... ContactProtectedFlag 0..1booleanThis indicates that the contact information is confidential
.... ContactDetailsPeriod 0..1PeriodDate contact details effective from and/or to
.... PerferredContactFlag 0..1booleanThis flag denotes that the contact details provided are the person’s preference
... Language 0..*CodeableConceptA code representing the languages spoken or understood by the person
... Qualification 0..*BackboneElementA health worker’s qualifications
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... QualificationName 0..1stringThe name of the qualification that enabled the health worker to be registered with the appropriate responsible authority
.... QualificationYear 0..1dateThe year in which the health worker achieved the qualification
.... GrantingInstitution 0..1stringThe name of the granting institution that conferred the qualification
.... GrantingInstitutionCity 0..1stringThe name of the city where the granting institution is located
.... GrantingInstitutionCountry 0..1CodeableConceptThe identifier for the Country or nation of the granting institution
... ProfessionalRegistration 0..*BackboneElementthe authority responsible for the registration of practitioners of the profession that the person concerned practices or seeks to practice or has practiced
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... AssigningOrganisationIdentifier 0..1CodeableConceptThe HPI generated organisation identifier of the organisation that has allocated the health worker’s identifier number
.... AssigningSourceIdentifier 0..1IdentifierA unique identifier assigned to a health worker by an assigning source
.... ResponsibleAuthorityCode 0..1CodeableConceptA code to identify the type of professional registration the health worker has been assigned
.... InitialRegistrationDate 0..1dateThe date on which the health worker first became registered with a responsible authority
.... RegistrationStatusCode 0..1CodeableConceptAn indicator of the practicing status of the health worker as supplied by their responsible authority or a health care worker source
... PracticingCertificate 0..*BackboneElementPracticing certificate details are recorded for health practitioners, who operate under a responsible authority.
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ResponsibleAuthority 0..1CodeableConceptResponsible authority who has issued practicing certificate for healthcare practitioner.
.... Effectiveperiod 0..1PeriodA Practicing certificate has an effective date range that is provided by the responsible authority.
... ScopePractice 0..*BackboneElementHealth worker scope of practice registration details
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ScopePracticeCode 1..*CodeableConceptA code identifying the scope of practice that is applied to a health provider under the Health Practitioners Competence Assurance Act 2003
.... EffectiveDateRange 0..1PeriodScope on practice has an effective date from and/or to
... ConditionsPractice 0..*BackboneElementConditions on practice for the health practitioner
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... ConditionsPracticeDescription 0..1stringA narrative describing the conditions that may apply to a particular provider’s scope of practice
.... EffectiveDateRange 0..1PeriodConditions on practice effective date from and/or to
... AdditionalAuthorisationsPractice 0..*BackboneElementThe additional authorisations that a health worker is authorised to practice or prescribe
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... AuthorisationTypeCode 0..1CodeableConceptA coded value of the additional authorisations that a health worker is authorised to practice or prescribe
.... EffectiveDateRange 0..1PeriodAdditional authorisations to practice effective date range from and/or to
... HealthWorkerRole 0..1BackboneElementThe employment of a health worker in a specific role
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... PRI 1..1IdentifierA unique ten-character identifier assigned by the HPI system to an individual role
.... RoleCode 1..1CodeableConceptThe designated the role of a health worker
.... EffectiveDateRange 0..1PeriodRole date effective from and/or to
.... RoleConfidential 0..1booleanWhether or not the role of health care practitioner is confidential
.... FacilityId 0..1IdentifierThe identifier of the healthcare facility at which the practitioner works in this role.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcarePractitioner-cs.ContactInformation.ContactUsagepreferredhttps://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal
https://nzhts.digital.health.nz/fhir/ValueSet/B=BusinessE=EmergencyC=ConnectedHealthH=HealthLinkP=Personal

Constraints

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

This structure is derived from Base

Summary

Mandatory: 0 element (3 nested mandatory elements)

 

Other representations of profile: CSV, Excel