New Zealand HPI Implementation Guide
1.5.0 - Release
New Zealand HPI Implementation Guide - Local Development build (v1.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2024-09-05 |
Definitions for the HPIPractitioner resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Practitioner | |
2. Practitioner.extension:death-date | |
Slice Name | death-date |
Short | The date this person died |
4. Practitioner.extension:death-date.extension:source | |
Slice Name | source |
Control | 0..0 |
6. Practitioner.extension:educational-qualification | |
Slice Name | educational-qualification |
8. Practitioner.extension:educational-qualification.extension:country | |
Slice Name | country |
10. Practitioner.extension:educational-qualification.extension:country.value[x] | |
Binding | The codes SHALL be taken from ISO 3166-1:2013 (2-alpha country code) (required to https://nzhts.digital.health.nz/fhir/ValueSet/country-code ) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
12. Practitioner.extension:ethnicity | |
Slice Name | ethnicity |
Control | 0..6 |
14. Practitioner.extension:iwi | |
Slice Name | iwi |
Control | 0..0 |
16. Practitioner.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Slicing | This element introduces a set of slices on Practitioner.identifier . The slices areUnordered and Open at End, and can be differentiated using the following discriminators: |
18. Practitioner.identifier.use | |
Short | official | old |
Binding | The codes SHALL be taken from IdentifierUse (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code ) |
20. Practitioner.identifier:HPI | |
Slice Name | HPI |
Definition | The HPI Person Identifier or CPN of the person that is currently in use. It can be referred to as the ‘Live’ CPN or “live” HPI Person ID”. A person can only have one live CPN |
Short | The currently active CPN (Common Person Name) |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Must Support | true |
22. Practitioner.identifier:HPI.use | |
Short | fixed to official |
Control | 1..? |
Fixed Value | official |
24. Practitioner.identifier:HPI.type | |
Control | 0..0 |
26. Practitioner.identifier:HPI.system | |
Control | 1..? |
Fixed Value | https://standards.digital.health.nz/ns/hpi-person-id |
28. Practitioner.identifier:HPI.period | |
Control | 0..0 |
30. Practitioner.identifier:HPI.assigner | |
Type | Reference(HPI Organization) |
32. Practitioner.identifier:dormant | |
Slice Name | dormant |
Definition | An HPI Person Identifier or CPN of the person that is no longer in use. An HPI Person ID becomes dormant when it is discovered that 2 CPNs exist for the same person. The CPNs are linked, one becomes ‘live’ the other ‘dormant’. |
Short | CPN (Common Person Name) identifiers that have been deprecated for this Person |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Must Support | true |
34. Practitioner.identifier:dormant.use | |
Short | fixed to old |
Control | 1..? |
Fixed Value | old |
36. Practitioner.identifier:dormant.type | |
Control | 0..0 |
38. Practitioner.identifier:dormant.system | |
Control | 1..? |
Fixed Value | https://standards.digital.health.nz/ns/hpi-person-id |
40. Practitioner.identifier:dormant.period | |
Control | 0..0 |
42. Practitioner.identifier:dormant.assigner | |
Type | Reference(HPI Organization) |
44. Practitioner.identifier:RA | |
Slice Name | RA |
Short | The RA Identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Must Support | true |
46. Practitioner.identifier:RA.use | |
Short | fixed to official |
Control | 1..? |
Fixed Value | official |
48. Practitioner.identifier:RA.type | |
Control | 0..0 |
50. Practitioner.identifier:RA.system | |
Binding | The codes SHALL be taken from RaIdentifier (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-ra-identifier-code ) |
52. Practitioner.identifier:RA.period | |
Control | 0..0 |
54. Practitioner.identifier:RA.assigner | |
Type | Reference(HPI Organization) |
56. Practitioner.active | |
Control | 0..0 |
58. Practitioner.name | |
60. Practitioner.name.use | |
Short | usual | official | old |
Binding | The codes SHALL be taken from Use values for a HumanName (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-human-name-use-code ) |
62. Practitioner.name.text | |
Control | 0..0 |
64. Practitioner.name.prefix | |
Binding | The codes SHALL be taken from Name Prefix Codes (required to https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code ) |
66. Practitioner.name.suffix | |
Control | 0..0 |
Binding | The codes SHALL be taken from Name Suffix Codes (required to https://nzhts.digital.health.nz/fhir/ValueSet/name-suffix-code ) |
68. Practitioner.name.period | |
Control | 0..0 |
70. Practitioner.telecom | |
Control | 0..0 |
72. Practitioner.address | |
Control | 0..0 |
Type | Address(Common NZ Address datatype) |
74. Practitioner.photo | |
Control | 0..0 |
76. Practitioner.qualification | |
78. Practitioner.qualification.id | |
Control | 0..0 |
80. Practitioner.qualification.extension:additional-authorisation | |
Slice Name | additional-authorisation |
Short | Additional things the person is authorized to do |
82. Practitioner.qualification.extension:condition-on-practice | |
Slice Name | condition-on-practice |
Short | Conditions that have been applied to the ability of the person to practice |
84. Practitioner.qualification.extension:registration-initial-date | |
Slice Name | registration-initial-date |
Short | The date that the person was originally registered |
86. Practitioner.qualification.extension:registration-status-code | |
Slice Name | registration-status-code |
Short | Status of the registration, and the date it was set |
88. Practitioner.qualification.extension:scope-of-practice | |
Slice Name | scope-of-practice |
Short | the health services a practitioner is authorised to perform eg Nurse Practitioner |
90. Practitioner.qualification.extension:scope-of-practice.extension:code | |
Slice Name | code |
92. Practitioner.qualification.extension:scope-of-practice.extension:code.value[x]:valueCodeableConcept | |
Slice Name | valueCodeableConcept |
Binding | The codes SHOULD be taken from PractitionerScopeOfPractice (2.1.0) (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code|2.1.0 ) |
Type | CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
94. Practitioner.qualification.identifier | |
Short | The practitioner's identifier issued by the Responsible Authority eg medical council number, nursing council number |
Note | This is a business identifier, not a resource identifier (see discussion) |
96. Practitioner.qualification.code | |
Short | Coded representation of the Responsible Authority that issues the registration |
Binding | The codes SHALL be taken from HPI Registration Type (required to https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code ) |
98. Practitioner.qualification.period | |
Short | The period of the annual practicing certificate issued by the Responsible Authority |
100. Practitioner.qualification.issuer | |
Short | The HPI Organisation ID of the Responsible Authority that issues the registration |
Type | Reference(HPI Organization) |
102. Practitioner.communication | |
104. Practitioner.communication.coding | |
Binding | The codes SHALL be taken from ISO 639-3:2007 (3-alpha language code) (required to https://nzhts.digital.health.nz/fhir/ValueSet/language-code ) |
Guidance on how to interpret the contents of this table can be found here
0. Practitioner | |
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. |
Short | A person with a formal responsibility in the provisioning of healthcare or related services |
Control | 0..* |
Is Modifier | false |
Summary | false |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) |
2. Practitioner.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. Practitioner.extension:death-date | |
Slice Name | death-date |
Definition | The date of death of the individual, plus the source of that information |
Short | The date this person died |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(Date of death) (Complex Extension) |
Is Modifier | false |
Invariants | ele-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() ) |
6. Practitioner.extension:death-date.extension:date | |
Slice Name | date |
Definition | The date of death |
Short | The date of deathAdditional content defined by implementations |
Control | 0..1* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-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. Practitioner.extension:death-date.extension:date.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional 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. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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()) |
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
10. Practitioner.extension:death-date.extension:date.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | date |
12. Practitioner.extension:death-date.extension:source | |
Slice Name | source |
Definition | An Extension |
Short | ExtensionAdditional content defined by implementations |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-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()) |
18. Practitioner.extension:death-date.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://hl7.org.nz/fhir/StructureDefinition/death-date |
20. Practitioner.extension:death-date.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 0..01 |
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. Practitioner.extension:educational-qualification | |
Slice Name | educational-qualification |
Definition | Educational qualifications a practitioner has. These may or may not be related to registration information. |
Short | Extension |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(EducationalQualification) (Complex Extension) |
Is Modifier | false |
Invariants | ele-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() ) |
24. Practitioner.extension:educational-qualification.extension:fullname | |
Slice Name | fullname |
Definition | The full name of the educational qualification |
Short | The full name of the educational qualificationAdditional content defined by implementations |
Control | 0..1* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-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()) |
26. Practitioner.extension:educational-qualification.extension:fullname.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional 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. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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()) |
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
28. Practitioner.extension:educational-qualification.extension:fullname.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | fullname |
30. Practitioner.extension:educational-qualification.extension:shortname | |
Slice Name | shortname |
Definition | A short name of the educational qualification for when space is limited |
Short | A short name of the educational qualification for when space is limitedAdditional content defined by implementations |
Control | 0..1* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-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()) |
32. Practitioner.extension:educational-qualification.extension:shortname.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional 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. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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()) |
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
34. Practitioner.extension:educational-qualification.extension:shortname.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | shortname |
36. Practitioner.extension:educational-qualification.extension:year | |
Slice Name | year |
Definition | The year in which the qualification was granted |
Short | The year in which the qualification was grantedAdditional content defined by implementations |
Control | 0..1* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-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()) |
38. Practitioner.extension:educational-qualification.extension:year.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional 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. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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()) |
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
40. Practitioner.extension:educational-qualification.extension:year.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | year |
42. Practitioner.extension:educational-qualification.extension:institution | |
Slice Name | institution |
Definition | The institution that granted the qualification |
Short | The institution that granted the qualificationAdditional content defined by implementations |
Control | 0..1* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-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. Practitioner.extension:educational-qualification.extension:institution.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional 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. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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()) |
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
46. Practitioner.extension:educational-qualification.extension:institution.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | institution |
48. Practitioner.extension:educational-qualification.extension:city | |
Slice Name | city |
Definition | The city where the institution is located |
Short | The city where the institution is locatedAdditional content defined by implementations |
Control | 0..1* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-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()) |
50. Practitioner.extension:educational-qualification.extension:city.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional 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. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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()) |
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
52. Practitioner.extension:educational-qualification.extension:city.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | city |
54. Practitioner.extension:educational-qualification.extension:country | |
Slice Name | country |
Definition | An Extension |
Short | ExtensionAdditional content defined by implementations |
Control | 0..1* |
Type | Extension |
Is Modifier | false |
Summary | false |
Invariants | ele-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()) |
56. Practitioner.extension:educational-qualification.extension:country.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional 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. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-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()) |
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
58. Practitioner.extension:educational-qualification.extension:country.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | country |
60. Practitioner.extension:educational-qualification.extension:country.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 0..1 |
Binding | The codes SHALL be taken from For codes, see ISO 3166-1:2013 (2-alpha country code) (required to https://nzhts.digital.health.nz/fhir/ValueSet/country-code ) |
Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
62. Practitioner.extension:educational-qualification.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://hl7.org.nz/fhir/StructureDefinition/educational-qualification |
64. Practitioner.extension:educational-qualification.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 0..01 |
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
66. Practitioner.extension:ethnicity | |
Slice Name | ethnicity |
Definition | The ethnic group or groups that a person identifies with or feels they belong to. Ethnicity is a measure of cultural affiliation as opposed to race, ancestry, nationality or citizen. Ethnicity is self-perceived and a person can belong to more than one group. The Stats New Zealand standard can be found here. |
Short | NZ Ethnicity |
Control | 0..6 This element is affected by the following invariants: ele-1 |
Type | Extension(NZ Ethnicity) (Extension Type: CodeableConcept) |
Is Modifier | false |
Invariants | ele-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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
68. Practitioner.extension:iwi | |
Slice Name | iwi |
Definition | Persons Iwi affiliation |
Short | Extension |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Extension(Nz_iwi) (Extension Type: CodeableConcept) |
Is Modifier | false |
Invariants | ele-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() )ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
70. Practitioner.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
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 Names | extensions, user content |
Invariants | ele-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()) |
72. Practitioner.identifier | |
Definition | An identifier that applies to this person in this role. |
Short | An identifier for the person as this agent |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Is Modifier | false |
Summary | true |
Requirements | Often, specific identities are assigned for the agent. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Practitioner.identifier . The slices areUnordered and Open at End, and can be differentiated using the following discriminators: |
74. Practitioner.identifier.use | |
Definition | The purpose of this identifier. |
Short | official | oldusual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 0..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code ) |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
76. Practitioner.identifier:HPI | |
Slice Name | HPI |
Definition | The HPI Person Identifier or CPN of the person that is currently in use. It can be referred to as the ‘Live’ CPN or “live” HPI Person ID”. A person can only have one live CPN An identifier that applies to this person in this role. |
Short | The currently active CPN (Common Person Name)An identifier for the person as this agent |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1* |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Often, specific identities are assigned for the agent. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
78. Practitioner.identifier:HPI.use | |
Definition | The purpose of this identifier. |
Short | fixed to officialusual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 10..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Fixed Value | official |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
80. Practitioner.identifier:HPI.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Short | Description of identifier |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Control | 0..01 |
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
82. Practitioner.identifier:HPI.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Comments | Identifier.system is always case sensitive. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Fixed Value | https://standards.digital.health.nz/ns/hpi-person-id |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
84. Practitioner.identifier:HPI.period | |
Definition | Time period during which identifier is/was valid for use. |
Short | Time period when id is/was valid for use |
Control | 0..01 |
Type | Period |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
86. Practitioner.identifier:HPI.assigner | |
Definition | Organization that issued/manages the identifier. |
Short | Organization that issued id (may be just text) |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Control | 0..1 |
Type | Reference(HPI Organization, Organization) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
88. Practitioner.identifier:dormant | |
Slice Name | dormant |
Definition | An HPI Person Identifier or CPN of the person that is no longer in use. An HPI Person ID becomes dormant when it is discovered that 2 CPNs exist for the same person. The CPNs are linked, one becomes ‘live’ the other ‘dormant’. An identifier that applies to this person in this role. |
Short | CPN (Common Person Name) identifiers that have been deprecated for this PersonAn identifier for the person as this agent |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Often, specific identities are assigned for the agent. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
90. Practitioner.identifier:dormant.use | |
Definition | The purpose of this identifier. |
Short | fixed to oldusual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 10..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Fixed Value | old |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
92. Practitioner.identifier:dormant.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Short | Description of identifier |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Control | 0..01 |
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
94. Practitioner.identifier:dormant.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Comments | Identifier.system is always case sensitive. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Fixed Value | https://standards.digital.health.nz/ns/hpi-person-id |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
96. Practitioner.identifier:dormant.period | |
Definition | Time period during which identifier is/was valid for use. |
Short | Time period when id is/was valid for use |
Control | 0..01 |
Type | Period |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
98. Practitioner.identifier:dormant.assigner | |
Definition | Organization that issued/manages the identifier. |
Short | Organization that issued id (may be just text) |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Control | 0..1 |
Type | Reference(HPI Organization, Organization) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
100. Practitioner.identifier:RA | |
Slice Name | RA |
Definition | An identifier that applies to this person in this role. |
Short | The RA IdentifierAn identifier for the person as this agent |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Often, specific identities are assigned for the agent. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
102. Practitioner.identifier:RA.use | |
Definition | The purpose of this identifier. |
Short | fixed to officialusual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 10..1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Fixed Value | official |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
104. Practitioner.identifier:RA.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Short | Description of identifier |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Control | 0..01 |
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
106. Practitioner.identifier:RA.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Comments | Identifier.system is always case sensitive. |
Control | 0..1 |
Binding | The codes SHALL be taken from For codes, see RaIdentifier (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-ra-identifier-code ) |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
108. Practitioner.identifier:RA.period | |
Definition | Time period during which identifier is/was valid for use. |
Short | Time period when id is/was valid for use |
Control | 0..01 |
Type | Period |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
110. Practitioner.identifier:RA.assigner | |
Definition | Organization that issued/manages the identifier. |
Short | Organization that issued id (may be just text) |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Control | 0..1 |
Type | Reference(HPI Organization, Organization) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
112. Practitioner.active | |
Definition | Whether this practitioner's record is in active use. |
Short | Whether this practitioner's record is in active use |
Comments | If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. |
Control | 0..01 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be able to mark a practitioner record as not to be used because it was created in error. |
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
114. Practitioner.telecom | |
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address. |
Short | A contact detail for the practitioner (that apply to all roles) |
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. |
Control | 0..0* |
Type | ContactPoint |
Is Modifier | false |
Summary | true |
Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
116. Practitioner.address | |
Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. |
Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats)Address(es) of the practitioner that are not role specific (typically home address) |
Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). |
Control | 0..0* This element is affected by the following invariants: ele-1 |
Type | Address(Common NZ Address datatype) |
Is Modifier | false |
Requirements | The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
118. Practitioner.photo | |
Definition | Image of the person. |
Short | Image of the person |
Control | 0..0* |
Type | Attachment |
Is Modifier | false |
Summary | false |
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. Practitioner | |||||
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. | ||||
Short | A person with a formal responsibility in the provisioning of healthcare or related services | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() ) | ||||
2. Practitioner.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
4. Practitioner.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
6. Practitioner.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Short | A set of rules under which this content was created | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
8. Practitioner.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
10. Practitioner.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Short | Text summary of the resource, for human interpretation | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
12. Practitioner.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Short | Contained, inline Resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. Practitioner.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
16. Practitioner.extension:death-date | |||||
Slice Name | death-date | ||||
Definition | The date of death of the individual, plus the source of that information | ||||
Short | The date this person died | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Date of death) (Complex Extension) | ||||
Is Modifier | false | ||||
Invariants | ele-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() ) | ||||
18. Practitioner.extension:death-date.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
20. Practitioner.extension:death-date.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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
22. Practitioner.extension:death-date.extension:date | |||||
Slice Name | date | ||||
Definition | The date of death | ||||
Short | The date of death | ||||
Control | 0..1 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
24. Practitioner.extension:death-date.extension:date.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
26. Practitioner.extension:death-date.extension:date.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
28. Practitioner.extension:death-date.extension:date.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | date | ||||
30. Practitioner.extension:death-date.extension:date.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
32. Practitioner.extension:death-date.extension:source | |||||
Slice Name | source | ||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
39. Practitioner.extension:death-date.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | http://hl7.org.nz/fhir/StructureDefinition/death-date | ||||
41. Practitioner.extension:death-date.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..0 | ||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
43. Practitioner.extension:educational-qualification | |||||
Slice Name | educational-qualification | ||||
Definition | Educational qualifications a practitioner has. These may or may not be related to registration information. | ||||
Short | Extension | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(EducationalQualification) (Complex Extension) | ||||
Is Modifier | false | ||||
Invariants | ele-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() ) | ||||
45. Practitioner.extension:educational-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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
47. Practitioner.extension:educational-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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
49. Practitioner.extension:educational-qualification.extension:fullname | |||||
Slice Name | fullname | ||||
Definition | The full name of the educational qualification | ||||
Short | The full name of the educational qualification | ||||
Control | 0..1 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
51. Practitioner.extension:educational-qualification.extension:fullname.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
53. Practitioner.extension:educational-qualification.extension:fullname.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
55. Practitioner.extension:educational-qualification.extension:fullname.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | fullname | ||||
57. Practitioner.extension:educational-qualification.extension:fullname.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Type | string | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
59. Practitioner.extension:educational-qualification.extension:shortname | |||||
Slice Name | shortname | ||||
Definition | A short name of the educational qualification for when space is limited | ||||
Short | A short name of the educational qualification for when space is limited | ||||
Control | 0..1 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
61. Practitioner.extension:educational-qualification.extension:shortname.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
63. Practitioner.extension:educational-qualification.extension:shortname.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
65. Practitioner.extension:educational-qualification.extension:shortname.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | shortname | ||||
67. Practitioner.extension:educational-qualification.extension:shortname.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Type | string | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
69. Practitioner.extension:educational-qualification.extension:year | |||||
Slice Name | year | ||||
Definition | The year in which the qualification was granted | ||||
Short | The year in which the qualification was granted | ||||
Control | 0..1 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
71. Practitioner.extension:educational-qualification.extension:year.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
73. Practitioner.extension:educational-qualification.extension:year.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
75. Practitioner.extension:educational-qualification.extension:year.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | year | ||||
77. Practitioner.extension:educational-qualification.extension:year.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Type | date | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
79. Practitioner.extension:educational-qualification.extension:institution | |||||
Slice Name | institution | ||||
Definition | The institution that granted the qualification | ||||
Short | The institution that granted the qualification | ||||
Control | 0..1 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
81. Practitioner.extension:educational-qualification.extension:institution.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
83. Practitioner.extension:educational-qualification.extension:institution.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
85. Practitioner.extension:educational-qualification.extension:institution.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | institution | ||||
87. Practitioner.extension:educational-qualification.extension:institution.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Type | string | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
89. Practitioner.extension:educational-qualification.extension:city | |||||
Slice Name | city | ||||
Definition | The city where the institution is located | ||||
Short | The city where the institution is located | ||||
Control | 0..1 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
91. Practitioner.extension:educational-qualification.extension:city.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
93. Practitioner.extension:educational-qualification.extension:city.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
95. Practitioner.extension:educational-qualification.extension:city.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | city | ||||
97. Practitioner.extension:educational-qualification.extension:city.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Type | string | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
99. Practitioner.extension:educational-qualification.extension:country | |||||
Slice Name | country | ||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..1 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
101. Practitioner.extension:educational-qualification.extension:country.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
103. Practitioner.extension:educational-qualification.extension:country.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
105. Practitioner.extension:educational-qualification.extension:country.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | country | ||||
107. Practitioner.extension:educational-qualification.extension:country.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ISO 3166-1:2013 (2-alpha country code) (required to https://nzhts.digital.health.nz/fhir/ValueSet/country-code ) | ||||
Type | string | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
109. Practitioner.extension:educational-qualification.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | http://hl7.org.nz/fhir/StructureDefinition/educational-qualification | ||||
111. Practitioner.extension:educational-qualification.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..0 | ||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
113. Practitioner.extension:ethnicity | |||||
Slice Name | ethnicity | ||||
Definition | The ethnic group or groups that a person identifies with or feels they belong to. Ethnicity is a measure of cultural affiliation as opposed to race, ancestry, nationality or citizen. Ethnicity is self-perceived and a person can belong to more than one group. The Stats New Zealand standard can be found here. | ||||
Short | NZ Ethnicity | ||||
Control | 0..6 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(NZ Ethnicity) (Extension Type: CodeableConcept) | ||||
Is Modifier | false | ||||
Invariants | ele-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() ) | ||||
115. Practitioner.extension:iwi | |||||
Slice Name | iwi | ||||
Definition | Persons Iwi affiliation | ||||
Short | Extension | ||||
Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Nz_iwi) (Extension Type: CodeableConcept) | ||||
Is Modifier | false | ||||
Invariants | ele-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() ) | ||||
117. Practitioner.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
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 Names | extensions, user content | ||||
Invariants | ele-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() ) | ||||
119. Practitioner.identifier | |||||
Definition | An identifier that applies to this person in this role. | ||||
Short | An identifier for the person as this agent | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Often, specific identities are assigned for the agent. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on Practitioner.identifier . The slices areUnordered and Open at End, and can be differentiated using the following discriminators: | ||||
121. Practitioner.identifier.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
123. Practitioner.identifier.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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
125. Practitioner.identifier.use | |||||
Definition | The purpose of this identifier. | ||||
Short | official | old | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-identifier-use-code ) | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
127. Practitioner.identifier.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Short | Description of identifier | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
Control | 0..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
129. Practitioner.identifier.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Comments | Identifier.system is always case sensitive. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
131. Practitioner.identifier.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Short | The value that is unique | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Example | <br/><b>General</b>:123456 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
133. Practitioner.identifier.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
135. Practitioner.identifier.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
137. Practitioner.identifier:HPI | |||||
Slice Name | HPI | ||||
Definition | The HPI Person Identifier or CPN of the person that is currently in use. It can be referred to as the ‘Live’ CPN or “live” HPI Person ID”. A person can only have one live CPN | ||||
Short | The currently active CPN (Common Person Name) | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Often, specific identities are assigned for the agent. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
139. Practitioner.identifier:HPI.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
141. Practitioner.identifier:HPI.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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
143. Practitioner.identifier:HPI.use | |||||
Definition | The purpose of this identifier. | ||||
Short | fixed to official | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Fixed Value | official | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
145. Practitioner.identifier:HPI.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Short | Description of identifier | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
Control | 0..0 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
147. Practitioner.identifier:HPI.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Comments | Identifier.system is always case sensitive. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Fixed Value | https://standards.digital.health.nz/ns/hpi-person-id | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
149. Practitioner.identifier:HPI.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Short | The value that is unique | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Example | <br/><b>General</b>:123456 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
151. Practitioner.identifier:HPI.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..0 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
153. Practitioner.identifier:HPI.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
Control | 0..1 | ||||
Type | Reference(HPI Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
155. Practitioner.identifier:dormant | |||||
Slice Name | dormant | ||||
Definition | An HPI Person Identifier or CPN of the person that is no longer in use. An HPI Person ID becomes dormant when it is discovered that 2 CPNs exist for the same person. The CPNs are linked, one becomes ‘live’ the other ‘dormant’. | ||||
Short | CPN (Common Person Name) identifiers that have been deprecated for this Person | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Often, specific identities are assigned for the agent. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
157. Practitioner.identifier:dormant.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
159. Practitioner.identifier:dormant.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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
161. Practitioner.identifier:dormant.use | |||||
Definition | The purpose of this identifier. | ||||
Short | fixed to old | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Fixed Value | old | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
163. Practitioner.identifier:dormant.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Short | Description of identifier | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
Control | 0..0 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
165. Practitioner.identifier:dormant.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Comments | Identifier.system is always case sensitive. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Fixed Value | https://standards.digital.health.nz/ns/hpi-person-id | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
167. Practitioner.identifier:dormant.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Short | The value that is unique | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Example | <br/><b>General</b>:123456 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
169. Practitioner.identifier:dormant.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..0 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
171. Practitioner.identifier:dormant.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
Control | 0..1 | ||||
Type | Reference(HPI Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
173. Practitioner.identifier:RA | |||||
Slice Name | RA | ||||
Definition | An identifier that applies to this person in this role. | ||||
Short | The RA Identifier | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Often, specific identities are assigned for the agent. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
175. Practitioner.identifier:RA.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
177. Practitioner.identifier:RA.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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
179. Practitioner.identifier:RA.use | |||||
Definition | The purpose of this identifier. | ||||
Short | fixed to official | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Fixed Value | official | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
181. Practitioner.identifier:RA.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Short | Description of identifier | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
Control | 0..0 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
183. Practitioner.identifier:RA.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Comments | Identifier.system is always case sensitive. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from RaIdentifier (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-ra-identifier-code ) | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
185. Practitioner.identifier:RA.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Short | The value that is unique | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Example | <br/><b>General</b>:123456 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
187. Practitioner.identifier:RA.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..0 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
189. Practitioner.identifier:RA.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
Control | 0..1 | ||||
Type | Reference(HPI Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
191. Practitioner.active | |||||
Definition | Whether this practitioner's record is in active use. | ||||
Short | Whether this practitioner's record is in active use | ||||
Comments | If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. | ||||
Control | 0..0 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be able to mark a practitioner record as not to be used because it was created in error. | ||||
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
193. Practitioner.name | |||||
Definition | The name(s) associated with the practitioner. | ||||
Short | The name(s) associated with the practitioner | ||||
Comments | The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this:
| ||||
Control | 0..* | ||||
Type | HumanName | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
195. Practitioner.name.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
197. Practitioner.name.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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.name.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
199. Practitioner.name.use | |||||
Definition | Identifies the purpose for this name. | ||||
Short | usual | official | old | ||||
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Use values for a HumanName (required to https://nzhts.digital.health.nz/fhir/ValueSet/hpi-human-name-use-code ) | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
201. Practitioner.name.text | |||||
Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. | ||||
Short | Text representation of the full name | ||||
Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||
Control | 0..0 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | A renderable, unencoded form. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
203. Practitioner.name.family | |||||
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | ||||
Short | Family name (often called 'Surname') | ||||
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | surname | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
205. Practitioner.name.given | |||||
Definition | Given name. | ||||
Short | Given names (not always 'first'). Includes middle names | ||||
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. | ||||
Control | 0..* | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | first name, middle name | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
207. Practitioner.name.prefix | |||||
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. | ||||
Short | Parts that come before the name | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from Name Prefix Codes (required to https://nzhts.digital.health.nz/fhir/ValueSet/name-prefix-code ) | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
209. Practitioner.name.suffix | |||||
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. | ||||
Short | Parts that come after the name | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from Name Suffix Codes (required to https://nzhts.digital.health.nz/fhir/ValueSet/name-suffix-code ) | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
211. Practitioner.name.period | |||||
Definition | Indicates the period of time when this name was valid for the named person. | ||||
Short | Time period when name was/is in use | ||||
Control | 0..0 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows names to be placed in historical context. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
213. Practitioner.telecom | |||||
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address. | ||||
Short | A contact detail for the practitioner (that apply to all roles) | ||||
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. | ||||
Control | 0..0 | ||||
Type | ContactPoint | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
215. Practitioner.address | |||||
Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. | ||||
Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). | ||||
Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
Type | Address(Common NZ Address datatype) | ||||
Is Modifier | false | ||||
Requirements | The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
217. Practitioner.gender | |||||
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. | ||||
Short | male | female | other | unknown | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 )The gender of a person used for administrative purposes. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Needed to address the person correctly. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
219. Practitioner.birthDate | |||||
Definition | The date of birth for the practitioner. | ||||
Short | The date on which the practitioner was born | ||||
Control | 0..1 | ||||
Type | date | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Needed for identification. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
221. Practitioner.photo | |||||
Definition | Image of the person. | ||||
Short | Image of the person | ||||
Control | 0..0 | ||||
Type | Attachment | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
223. Practitioner.qualification | |||||
Definition | The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. | ||||
Short | Certification, licenses, or training pertaining to the provision of care | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
225. Practitioner.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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..0 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
227. Practitioner.qualification.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.qualification.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
229. Practitioner.qualification.extension:additional-authorisation | |||||
Slice Name | additional-authorisation | ||||
Definition | Additional authorisations that a practitioner is authorised to perform | ||||
Short | Additional things the person is authorized to do | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(AdditionalAuthorisation) (Complex Extension) | ||||
Is Modifier | false | ||||
Invariants | ele-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() ) | ||||
231. Practitioner.qualification.extension:condition-on-practice | |||||
Slice Name | condition-on-practice | ||||
Definition | A full description of the conditions the health practitioner is subject to in relation to their scope of practice. | ||||
Short | Conditions that have been applied to the ability of the person to practice | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ConditionOnPractice) (Complex Extension) | ||||
Is Modifier | false | ||||
Invariants | ele-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() ) | ||||
233. Practitioner.qualification.extension:registration-initial-date | |||||
Slice Name | registration-initial-date | ||||
Definition | The date the practitioner first became registered with the Responsible Authority or professional body | ||||
Short | The date that the person was originally registered | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(RegistrationInitialDate) (Extension Type: date) | ||||
Is Modifier | false | ||||
Invariants | ele-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() ) | ||||
235. Practitioner.qualification.extension:registration-status-code | |||||
Slice Name | registration-status-code | ||||
Definition | An indicator of the practicing status of the practitioner as supplied by their Responsible Authority or professional body. | ||||
Short | Status of the registration, and the date it was set | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(RegistrationStatusCode) (Complex Extension) | ||||
Is Modifier | false | ||||
Invariants | ele-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() ) | ||||
237. Practitioner.qualification.extension:scope-of-practice | |||||
Slice Name | scope-of-practice | ||||
Definition | The type or range of health services a practitioner is authorised to perform, as determined by the Responsible Authority or professional body. | ||||
Short | the health services a practitioner is authorised to perform eg Nurse Practitioner | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ScopeOfPractice) (Complex Extension) | ||||
Is Modifier | false | ||||
Invariants | ele-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() ) | ||||
239. Practitioner.qualification.extension:scope-of-practice.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
241. Practitioner.qualification.extension:scope-of-practice.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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.qualification.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
243. Practitioner.qualification.extension:scope-of-practice.extension:code | |||||
Slice Name | code | ||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..1 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
245. Practitioner.qualification.extension:scope-of-practice.extension:code.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
247. Practitioner.qualification.extension:scope-of-practice.extension:code.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.qualification.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
249. Practitioner.qualification.extension:scope-of-practice.extension:code.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | code | ||||
251. Practitioner.qualification.extension:scope-of-practice.extension:code.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on Practitioner.qualification.extension.extension.value[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||
253. Practitioner.qualification.extension:scope-of-practice.extension:code.value[x]:valueCodeableConcept | |||||
Slice Name | valueCodeableConcept | ||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from PractitionerScopeOfPractice (2.1.0) (preferred to https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-scope-of-practice-code|2.1.0 ) | ||||
Type | CodeableConcept | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
255. Practitioner.qualification.extension:scope-of-practice.extension:period | |||||
Slice Name | period | ||||
Definition | The period the scope of practice is effective | ||||
Short | Extension | ||||
Control | 0..1 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
257. Practitioner.qualification.extension:scope-of-practice.extension:period.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
259. Practitioner.qualification.extension:scope-of-practice.extension:period.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.qualification.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
261. Practitioner.qualification.extension:scope-of-practice.extension:period.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | period | ||||
263. Practitioner.qualification.extension:scope-of-practice.extension:period.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..1 | ||||
Type | Period | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
265. Practitioner.qualification.extension:scope-of-practice.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice | ||||
267. Practitioner.qualification.extension:scope-of-practice.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..0 | ||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
269. Practitioner.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). | ||||
Short | Extensions 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
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 Names | extensions, user content, modifiers | ||||
Invariants | ele-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() ) | ||||
271. Practitioner.qualification.identifier | |||||
Definition | An identifier that applies to this person's qualification in this role. | ||||
Short | The practitioner's identifier issued by the Responsible Authority eg medical council number, nursing council number | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Often, specific identities are assigned for the qualification. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
273. Practitioner.qualification.code | |||||
Definition | Coded representation of the qualification. | ||||
Short | Coded representation of the Responsible Authority that issues the registration | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from HPI Registration Type (required to https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-registration-authority-code ) | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
275. Practitioner.qualification.period | |||||
Definition | Period during which the qualification is valid. | ||||
Short | The period of the annual practicing certificate issued by the Responsible Authority | ||||
Control | 0..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Qualifications are often for a limited period of time, and can be revoked. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
277. Practitioner.qualification.issuer | |||||
Definition | Organization that regulates and issues the qualification. | ||||
Short | The HPI Organisation ID of the Responsible Authority that issues the registration | ||||
Control | 0..1 | ||||
Type | Reference(HPI Organization) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
279. Practitioner.communication | |||||
Definition | A language the practitioner can use in patient communication. | ||||
Short | A language the practitioner can use in patient communication | ||||
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||||
Control | 0..* | ||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Knowing which language a practitioner speaks can help in facilitating communication with patients. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
281. Practitioner.communication.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
283. Practitioner.communication.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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-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() ) | ||||
Slicing | This element introduces a set of slices on Practitioner.communication.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
285. Practitioner.communication.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from ISO 639-3:2007 (3-alpha language code) (required to https://nzhts.digital.health.nz/fhir/ValueSet/language-code ) | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
287. Practitioner.communication.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Short | Plain text representation of the concept | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |