HSAAP Special Authority FHIR Implementation Guide - Local Development build (v0.1.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: SA Practitioner

A practitioner on a Special Authority Application: the Applicant (referenced from QuestionnaireResponse.author and Claim.requestor) or the Referrer (referenced from the referring-practitioner extension). Derived from NZ Base NzPractitioner (D4).

The role is carried by which element refers to the Practitioner, not by a role code (D5). Practitioner is used rather than PractitionerRole because organisational context is not required.

A registration identifier is mandatory. The registration authority is carried in Identifier.system, using the NZ Base responsible-authority naming systems (e.g. https://standards.digital.health.nz/ns/medical-council-id), and the registration number in Identifier.value.

The HPI CPN is optional in the payload. For the Applicant, where a CPN is present it SHALL agree with the CPN claim in the validated access token or the submission is rejected. No CPN is held for the Referrer.

Usages:

• Use this Profile: SA Submission Bundle
• Refer to this Profile: Referring Practitioner, SA Application ClaimResponse, SA Approval ClaimResponse, SA Claim and SA QuestionnaireResponse
• Examples for this Profile: Practitioner/sa-example-applicant and Practitioner/sa-example-referrer

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	NzPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services Constraints: sa-prac-1
Practitioner.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Practitioner.Slices for extension				Content/Rules for all slices
Practitioner.Slices for extension.extension:death-date		0..1	(Complex)	Date of death URL: http://hl7.org.nz/fhir/StructureDefinition/death-date
Practitioner.Slices for extension.extension:educational-qualification		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
Practitioner.Slices for extension.extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
Practitioner.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Practitioner.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Practitioner.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Practitioner.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:cpn	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	HPI Common Person Number (CPN)
Practitioner.Slices for identifier.identifier:cpn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Practitioner.Slices for identifier.identifier:cpn.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:cpn.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Practitioner.name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	The name(s) associated with the practitioner
Practitioner.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	Address(es) of the practitioner that are not role specific (typically home address)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Practitioner.identifier:cpn.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
sa-prac-1	error	Practitioner	A Special Authority Practitioner SHALL carry a registration identifier, with a value, issued by a New Zealand responsible authority. The registration authority is carried in Identifier.system.	identifier.where(value.exists() and system in ('https://standards.digital.health.nz/ns/medical-council-id' | 'https://standards.digital.health.nz/ns/nursing-council-id' | 'https://standards.digital.health.nz/ns/midwifery-council-id' | 'https://standards.digital.health.nz/ns/dental-council-id' | 'https://standards.digital.health.nz/ns/pharmacy-council-id' | 'https://standards.digital.health.nz/ns/optometrists-dispensing-opticians-board-id' | 'https://standards.digital.health.nz/ns/dietitians-board-id' | 'https://standards.digital.health.nz/ns/chiropractic-board-id' | 'https://standards.digital.health.nz/ns/medical-radiation-technologists-board-id' | 'https://standards.digital.health.nz/ns/medical-sciences-council-id' | 'https://standards.digital.health.nz/ns/occupational-therapy-board-id' | 'https://standards.digital.health.nz/ns/osteopathic-council-id' | 'https://standards.digital.health.nz/ns/paramedic-council-id' | 'https://standards.digital.health.nz/ns/physiotherapy-board-id' | 'https://standards.digital.health.nz/ns/podiatrists-board-id' | 'https://standards.digital.health.nz/ns/psychologists-board-id' | 'https://standards.digital.health.nz/ns/psychotherapists-board-id')).exists()

This structure is derived from NzPractitioner

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	NzPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services Constraints: sa-prac-1
Practitioner.Slices for identifier	S This element must be supported.	1..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:cpn	S This element must be supported.	0..1	Identifier	HPI Common Person Number (CPN)
Practitioner.Slices for identifier.identifier:cpn.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:cpn.value		1..1	string	The value that is unique
Practitioner.name	S This element must be supported.	1..*	HumanName	The name(s) associated with the practitioner
Practitioner.address	S This element must be supported.	0..*	Address	Address(es) of the practitioner that are not role specific (typically home address)
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
sa-prac-1	error	Practitioner	A Special Authority Practitioner SHALL carry a registration identifier, with a value, issued by a New Zealand responsible authority. The registration authority is carried in Identifier.system.	identifier.where(value.exists() and system in ('https://standards.digital.health.nz/ns/medical-council-id' | 'https://standards.digital.health.nz/ns/nursing-council-id' | 'https://standards.digital.health.nz/ns/midwifery-council-id' | 'https://standards.digital.health.nz/ns/dental-council-id' | 'https://standards.digital.health.nz/ns/pharmacy-council-id' | 'https://standards.digital.health.nz/ns/optometrists-dispensing-opticians-board-id' | 'https://standards.digital.health.nz/ns/dietitians-board-id' | 'https://standards.digital.health.nz/ns/chiropractic-board-id' | 'https://standards.digital.health.nz/ns/medical-radiation-technologists-board-id' | 'https://standards.digital.health.nz/ns/medical-sciences-council-id' | 'https://standards.digital.health.nz/ns/occupational-therapy-board-id' | 'https://standards.digital.health.nz/ns/osteopathic-council-id' | 'https://standards.digital.health.nz/ns/paramedic-council-id' | 'https://standards.digital.health.nz/ns/physiotherapy-board-id' | 'https://standards.digital.health.nz/ns/podiatrists-board-id' | 'https://standards.digital.health.nz/ns/psychologists-board-id' | 'https://standards.digital.health.nz/ns/psychotherapists-board-id')).exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	NzPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services Constraints: sa-prac-1
Practitioner.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Practitioner.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Practitioner.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Practitioner.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Practitioner.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Practitioner.contained		0..*	Resource	Contained, inline Resources
Practitioner.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:death-date		0..1	(Complex)	Date of death URL: http://hl7.org.nz/fhir/StructureDefinition/death-date
Practitioner.Slices for extension.extension:educational-qualification		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
Practitioner.Slices for extension.extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
Practitioner.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Practitioner.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Practitioner.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Practitioner.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:cpn	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	HPI Common Person Number (CPN)
Practitioner.Slices for identifier.identifier:cpn.id		0..1	string	Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:cpn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Practitioner.Slices for identifier.identifier:cpn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Practitioner.Slices for identifier.identifier:cpn.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Practitioner.Slices for identifier.identifier:cpn.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:cpn.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Practitioner.Slices for identifier.identifier:cpn.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:cpn.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Practitioner.active	Σ This element is included in summaries.	0..1	boolean	Whether this practitioner's record is in active use
Practitioner.name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	The name(s) associated with the practitioner
Practitioner.telecom	Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
Practitioner.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	Address(es) of the practitioner that are not role specific (typically home address)
Practitioner.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Practitioner.birthDate	Σ This element is included in summaries.	0..1	date	The date on which the practitioner was born
Practitioner.photo		0..*	Attachment	Image of the person
Practitioner.qualification		0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
Practitioner.qualification.id		0..1	string	Unique id for inter-element referencing
Practitioner.qualification.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:additional-authorisation		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation
Practitioner.qualification.Slices for extension.extension:condition-on-practice		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice
Practitioner.qualification.Slices for extension.extension:registration-initial-date		0..1	date	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date
Practitioner.qualification.Slices for extension.extension:registration-status-code		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
Practitioner.qualification.Slices for extension.extension:scope-of-practice		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
Practitioner.qualification.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Practitioner.qualification.identifier		0..*	Identifier	An identifier for this qualification for the practitioner
Practitioner.qualification.code		1..1	CodeableConcept	Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
Practitioner.qualification.period		0..1	Period	Period during which the qualification is valid
Practitioner.qualification.issuer		0..1	Reference(Organization)	Organization that regulates and issues the qualification
Practitioner.communication		0..*	CodeableConcept	A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Practitioner.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Practitioner.identifier:cpn.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Practitioner.identifier:cpn.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Practitioner.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Practitioner.qualification.​code	Base	example	v2 table 0360, Version 2.7	📦0360	FHIR Std.
Practitioner.communication	Base	preferred	Common Languages	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
sa-prac-1	error	Practitioner	A Special Authority Practitioner SHALL carry a registration identifier, with a value, issued by a New Zealand responsible authority. The registration authority is carried in Identifier.system.	identifier.where(value.exists() and system in ('https://standards.digital.health.nz/ns/medical-council-id' | 'https://standards.digital.health.nz/ns/nursing-council-id' | 'https://standards.digital.health.nz/ns/midwifery-council-id' | 'https://standards.digital.health.nz/ns/dental-council-id' | 'https://standards.digital.health.nz/ns/pharmacy-council-id' | 'https://standards.digital.health.nz/ns/optometrists-dispensing-opticians-board-id' | 'https://standards.digital.health.nz/ns/dietitians-board-id' | 'https://standards.digital.health.nz/ns/chiropractic-board-id' | 'https://standards.digital.health.nz/ns/medical-radiation-technologists-board-id' | 'https://standards.digital.health.nz/ns/medical-sciences-council-id' | 'https://standards.digital.health.nz/ns/occupational-therapy-board-id' | 'https://standards.digital.health.nz/ns/osteopathic-council-id' | 'https://standards.digital.health.nz/ns/paramedic-council-id' | 'https://standards.digital.health.nz/ns/physiotherapy-board-id' | 'https://standards.digital.health.nz/ns/podiatrists-board-id' | 'https://standards.digital.health.nz/ns/psychologists-board-id' | 'https://standards.digital.health.nz/ns/psychotherapists-board-id')).exists()

This structure is derived from NzPractitioner

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 4 elements
Fixed: 1 element

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Practitioner.identifier

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	NzPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services Constraints: sa-prac-1
Practitioner.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Practitioner.Slices for extension				Content/Rules for all slices
Practitioner.Slices for extension.extension:death-date		0..1	(Complex)	Date of death URL: http://hl7.org.nz/fhir/StructureDefinition/death-date
Practitioner.Slices for extension.extension:educational-qualification		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
Practitioner.Slices for extension.extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
Practitioner.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Practitioner.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Practitioner.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Practitioner.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:cpn	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	HPI Common Person Number (CPN)
Practitioner.Slices for identifier.identifier:cpn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Practitioner.Slices for identifier.identifier:cpn.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:cpn.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Practitioner.name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	The name(s) associated with the practitioner
Practitioner.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	Address(es) of the practitioner that are not role specific (typically home address)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Practitioner.identifier:cpn.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
sa-prac-1	error	Practitioner	A Special Authority Practitioner SHALL carry a registration identifier, with a value, issued by a New Zealand responsible authority. The registration authority is carried in Identifier.system.	identifier.where(value.exists() and system in ('https://standards.digital.health.nz/ns/medical-council-id' | 'https://standards.digital.health.nz/ns/nursing-council-id' | 'https://standards.digital.health.nz/ns/midwifery-council-id' | 'https://standards.digital.health.nz/ns/dental-council-id' | 'https://standards.digital.health.nz/ns/pharmacy-council-id' | 'https://standards.digital.health.nz/ns/optometrists-dispensing-opticians-board-id' | 'https://standards.digital.health.nz/ns/dietitians-board-id' | 'https://standards.digital.health.nz/ns/chiropractic-board-id' | 'https://standards.digital.health.nz/ns/medical-radiation-technologists-board-id' | 'https://standards.digital.health.nz/ns/medical-sciences-council-id' | 'https://standards.digital.health.nz/ns/occupational-therapy-board-id' | 'https://standards.digital.health.nz/ns/osteopathic-council-id' | 'https://standards.digital.health.nz/ns/paramedic-council-id' | 'https://standards.digital.health.nz/ns/physiotherapy-board-id' | 'https://standards.digital.health.nz/ns/podiatrists-board-id' | 'https://standards.digital.health.nz/ns/psychologists-board-id' | 'https://standards.digital.health.nz/ns/psychotherapists-board-id')).exists()

Differential View

This structure is derived from NzPractitioner

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	NzPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services Constraints: sa-prac-1
Practitioner.Slices for identifier	S This element must be supported.	1..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:cpn	S This element must be supported.	0..1	Identifier	HPI Common Person Number (CPN)
Practitioner.Slices for identifier.identifier:cpn.system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:cpn.value		1..1	string	The value that is unique
Practitioner.name	S This element must be supported.	1..*	HumanName	The name(s) associated with the practitioner
Practitioner.address	S This element must be supported.	0..*	Address	Address(es) of the practitioner that are not role specific (typically home address)
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
sa-prac-1	error	Practitioner	A Special Authority Practitioner SHALL carry a registration identifier, with a value, issued by a New Zealand responsible authority. The registration authority is carried in Identifier.system.	identifier.where(value.exists() and system in ('https://standards.digital.health.nz/ns/medical-council-id' | 'https://standards.digital.health.nz/ns/nursing-council-id' | 'https://standards.digital.health.nz/ns/midwifery-council-id' | 'https://standards.digital.health.nz/ns/dental-council-id' | 'https://standards.digital.health.nz/ns/pharmacy-council-id' | 'https://standards.digital.health.nz/ns/optometrists-dispensing-opticians-board-id' | 'https://standards.digital.health.nz/ns/dietitians-board-id' | 'https://standards.digital.health.nz/ns/chiropractic-board-id' | 'https://standards.digital.health.nz/ns/medical-radiation-technologists-board-id' | 'https://standards.digital.health.nz/ns/medical-sciences-council-id' | 'https://standards.digital.health.nz/ns/occupational-therapy-board-id' | 'https://standards.digital.health.nz/ns/osteopathic-council-id' | 'https://standards.digital.health.nz/ns/paramedic-council-id' | 'https://standards.digital.health.nz/ns/physiotherapy-board-id' | 'https://standards.digital.health.nz/ns/podiatrists-board-id' | 'https://standards.digital.health.nz/ns/psychologists-board-id' | 'https://standards.digital.health.nz/ns/psychotherapists-board-id')).exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Practitioner	C	0..*	NzPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services Constraints: sa-prac-1
Practitioner.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Practitioner.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Practitioner.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Practitioner.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Practitioner.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Practitioner.contained		0..*	Resource	Contained, inline Resources
Practitioner.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Practitioner.Slices for extension.extension:death-date		0..1	(Complex)	Date of death URL: http://hl7.org.nz/fhir/StructureDefinition/death-date
Practitioner.Slices for extension.extension:educational-qualification		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/educational-qualification
Practitioner.Slices for extension.extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
Practitioner.Slices for extension.extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
Practitioner.Slices for extension.extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Practitioner.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Practitioner.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for identifier.identifier:cpn	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	HPI Common Person Number (CPN)
Practitioner.Slices for identifier.identifier:cpn.id		0..1	string	Unique id for inter-element referencing
Practitioner.Slices for identifier.identifier:cpn.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Practitioner.Slices for identifier.identifier:cpn.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Practitioner.Slices for identifier.identifier:cpn.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Practitioner.Slices for identifier.identifier:cpn.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id (no extensions allowed)
Practitioner.Slices for identifier.identifier:cpn.value	Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Practitioner.Slices for identifier.identifier:cpn.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Practitioner.Slices for identifier.identifier:cpn.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Practitioner.active	Σ This element is included in summaries.	0..1	boolean	Whether this practitioner's record is in active use
Practitioner.name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	The name(s) associated with the practitioner
Practitioner.telecom	Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
Practitioner.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	Address(es) of the practitioner that are not role specific (typically home address)
Practitioner.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Practitioner.birthDate	Σ This element is included in summaries.	0..1	date	The date on which the practitioner was born
Practitioner.photo		0..*	Attachment	Image of the person
Practitioner.qualification		0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
Practitioner.qualification.id		0..1	string	Unique id for inter-element referencing
Practitioner.qualification.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Practitioner.qualification.Slices for extension.extension:additional-authorisation		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/additional-authorisation
Practitioner.qualification.Slices for extension.extension:condition-on-practice		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/condition-on-practice
Practitioner.qualification.Slices for extension.extension:registration-initial-date		0..1	date	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-initial-date
Practitioner.qualification.Slices for extension.extension:registration-status-code		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code
Practitioner.qualification.Slices for extension.extension:scope-of-practice		0..*	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice
Practitioner.qualification.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Practitioner.qualification.identifier		0..*	Identifier	An identifier for this qualification for the practitioner
Practitioner.qualification.code		1..1	CodeableConcept	Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
Practitioner.qualification.period		0..1	Period	Period during which the qualification is valid
Practitioner.qualification.issuer		0..1	Reference(Organization)	Organization that regulates and issues the qualification
Practitioner.communication		0..*	CodeableConcept	A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Practitioner.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Practitioner.identifier:cpn.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Practitioner.identifier:cpn.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Practitioner.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Practitioner.qualification.​code	Base	example	v2 table 0360, Version 2.7	📦0360	FHIR Std.
Practitioner.communication	Base	preferred	Common Languages	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
sa-prac-1	error	Practitioner	A Special Authority Practitioner SHALL carry a registration identifier, with a value, issued by a New Zealand responsible authority. The registration authority is carried in Identifier.system.	identifier.where(value.exists() and system in ('https://standards.digital.health.nz/ns/medical-council-id' | 'https://standards.digital.health.nz/ns/nursing-council-id' | 'https://standards.digital.health.nz/ns/midwifery-council-id' | 'https://standards.digital.health.nz/ns/dental-council-id' | 'https://standards.digital.health.nz/ns/pharmacy-council-id' | 'https://standards.digital.health.nz/ns/optometrists-dispensing-opticians-board-id' | 'https://standards.digital.health.nz/ns/dietitians-board-id' | 'https://standards.digital.health.nz/ns/chiropractic-board-id' | 'https://standards.digital.health.nz/ns/medical-radiation-technologists-board-id' | 'https://standards.digital.health.nz/ns/medical-sciences-council-id' | 'https://standards.digital.health.nz/ns/occupational-therapy-board-id' | 'https://standards.digital.health.nz/ns/osteopathic-council-id' | 'https://standards.digital.health.nz/ns/paramedic-council-id' | 'https://standards.digital.health.nz/ns/physiotherapy-board-id' | 'https://standards.digital.health.nz/ns/podiatrists-board-id' | 'https://standards.digital.health.nz/ns/psychologists-board-id' | 'https://standards.digital.health.nz/ns/psychotherapists-board-id')).exists()

This structure is derived from NzPractitioner

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 4 elements
Fixed: 1 element

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Practitioner.identifier

Other representations of profile: CSV, Excel, Schematron