Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	NzPractitionerRole	Roles/organizations the practitioner is associated with
Slices for extension				Content/Rules for all slices
extension:practitionerRole-creator		0..1	PractitionerRoleCreator	The person and/or organization that created the PR
extension:practitionerRole-status-reason		0..1	PractitionerRoleStatusReason	The reason for the status of this role. Generally when it is inactive.
messaging-address		0..1	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Slices for identifier		0..*	Identifier	Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system
identifier:RI	S	0..1	Identifier	Business Identifiers that are specific to a role/location
use		1..1	code	PractitionerRole Id Fixed Value: official
type		0..0
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id
period		0..0
practitioner		0..1	Reference(HPI Practitioner)	Practitioner that is able to provide the defined services for the organization
organization		0..1	Reference(HPI Organization)	Organization where the roles are available
code		0..1	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole code (required)
specialty		0..0
location		0..1	Reference(HPI Location)	The location(s) at which this practitioner provides care
healthcareService		0..0
telecom
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required)
availableTime		0..0
notAvailable		0..0
availabilityExceptions		0..0
endpoint		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
PractitionerRole.code	required	Hpi_practitioner_role https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code
PractitionerRole.telecom.use	required	Hpi_ContactPointUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	NzPractitionerRole	Roles/organizations the practitioner is associated with dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
practitionerRole-creator		0..1	(Complex)	The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
practitionerRole-status-reason		0..1	CodeableConcept	The reason for the status of this role. Generally when it is inactive. URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
messaging-address		0..1	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	Σ	0..*	Identifier	Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system ele-1: All FHIR elements must have a @value or children
identifier:RI	SΣ	0..1	Identifier	Business Identifiers that are specific to a role/location ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id
practitioner	Σ	0..1	Reference(HPI Practitioner)	Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children
organization	Σ	0..1	Reference(HPI Organization)	Organization where the roles are available ele-1: All FHIR elements must have a @value or children
code	Σ	0..1	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole code (required) ele-1: All FHIR elements must have a @value or children
location	Σ	0..1	Reference(HPI Location)	The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PractitionerRole.identifier:RI.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PractitionerRole.code	required	Hpi_practitioner_role https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	NzPractitionerRole	Roles/organizations the practitioner is associated with
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
practitionerRole-creator		0..1	(Complex)	The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator
practitionerRole-status-reason		0..1	CodeableConcept	The reason for the status of this role. Generally when it is inactive. URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred)
messaging-address		0..1	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system
identifier:RI	SΣ	0..1	Identifier	Business Identifiers that are specific to a role/location
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id
value	Σ	0..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	Σ	0..1	boolean	Whether this practitioner role record is in active use
period	Σ	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	Σ	0..1	Reference(HPI Practitioner)	Practitioner that is able to provide the defined services for the organization
organization	Σ	0..1	Reference(HPI Organization)	Organization where the roles are available
code	Σ	0..1	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole code (required)
location	Σ	0..1	Reference(HPI Location)	The location(s) at which this practitioner provides care
telecom	Σ	0..*	ContactPoint	Contact details that are specific to the role/location/service
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required)
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PractitionerRole.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.identifier:RI.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PractitionerRole.code	required	Hpi_practitioner_role https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code
PractitionerRole.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
PractitionerRole.telecom.use	required	Hpi_ContactPointUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 1 element
Fixed: 2 elements
Prohibited: 9 elements

Structures

This structure refers to these other structures:

• HPI Practitioner (http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner)
• HPI Organization (http://hl7.org.nz/fhir/StructureDefinition/HPIOrganization)
• HPI Location (http://hl7.org.nz/fhir/StructureDefinition/HPILocation)

Extensions

This structure refers to these extensions:

• http://hl7.org.nz/fhir/StructureDefinition/messaging-address

Slices

This structure defines the following Slices:

• The element 2 is sliced based on the values of PractitionerRole.identifier (Open at End)

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	NzPractitionerRole	Roles/organizations the practitioner is associated with
Slices for extension				Content/Rules for all slices
extension:practitionerRole-creator		0..1	PractitionerRoleCreator	The person and/or organization that created the PR
extension:practitionerRole-status-reason		0..1	PractitionerRoleStatusReason	The reason for the status of this role. Generally when it is inactive.
messaging-address		0..1	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
Slices for identifier		0..*	Identifier	Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system
identifier:RI	S	0..1	Identifier	Business Identifiers that are specific to a role/location
use		1..1	code	PractitionerRole Id Fixed Value: official
type		0..0
system		1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id
period		0..0
practitioner		0..1	Reference(HPI Practitioner)	Practitioner that is able to provide the defined services for the organization
organization		0..1	Reference(HPI Organization)	Organization where the roles are available
code		0..1	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole code (required)
specialty		0..0
location		0..1	Reference(HPI Location)	The location(s) at which this practitioner provides care
healthcareService		0..0
telecom
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required)
availableTime		0..0
notAvailable		0..0
availabilityExceptions		0..0
endpoint		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
PractitionerRole.code	required	Hpi_practitioner_role https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code
PractitionerRole.telecom.use	required	Hpi_ContactPointUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	NzPractitionerRole	Roles/organizations the practitioner is associated with dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
practitionerRole-creator		0..1	(Complex)	The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
practitionerRole-status-reason		0..1	CodeableConcept	The reason for the status of this role. Generally when it is inactive. URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
messaging-address		0..1	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	Σ	0..*	Identifier	Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system ele-1: All FHIR elements must have a @value or children
identifier:RI	SΣ	0..1	Identifier	Business Identifiers that are specific to a role/location ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id
practitioner	Σ	0..1	Reference(HPI Practitioner)	Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children
organization	Σ	0..1	Reference(HPI Organization)	Organization where the roles are available ele-1: All FHIR elements must have a @value or children
code	Σ	0..1	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole code (required) ele-1: All FHIR elements must have a @value or children
location	Σ	0..1	Reference(HPI Location)	The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PractitionerRole.identifier:RI.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PractitionerRole.code	required	Hpi_practitioner_role https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	NzPractitionerRole	Roles/organizations the practitioner is associated with
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
practitionerRole-creator		0..1	(Complex)	The person and/or organization that created the PR URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-creator
practitionerRole-status-reason		0..1	CodeableConcept	The reason for the status of this role. Generally when it is inactive. URL: http://hl7.org.nz/fhir/StructureDefinition/practitionerRole-status-reason Binding: PractitionerRole status reason (preferred)
messaging-address		0..1	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	Business Identifiers that are specific to a role/location Slice: Unordered, Open At End by value:use, value:system
identifier:RI	SΣ	0..1	Identifier	Business Identifiers that are specific to a role/location
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	PractitionerRole Id Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/hpi-practitionerrole-id
value	Σ	0..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	Σ	0..1	boolean	Whether this practitioner role record is in active use
period	Σ	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	Σ	0..1	Reference(HPI Practitioner)	Practitioner that is able to provide the defined services for the organization
organization	Σ	0..1	Reference(HPI Organization)	Organization where the roles are available
code	Σ	0..1	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole code (required)
location	Σ	0..1	Reference(HPI Location)	The location(s) at which this practitioner provides care
telecom	Σ	0..*	ContactPoint	Contact details that are specific to the role/location/service
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: Use values for a ContactPoint (required)
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PractitionerRole.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.identifier:RI.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PractitionerRole.code	required	Hpi_practitioner_role https://nzhts.digital.health.nz/fhir/ValueSet/practitioner-role-code
PractitionerRole.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
PractitionerRole.telecom.use	required	Hpi_ContactPointUse https://nzhts.digital.health.nz/fhir/ValueSet/hpi-contact-point-use-code

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 1 element
Fixed: 2 elements
Prohibited: 9 elements

Structures

This structure refers to these other structures:

• HPI Practitioner (http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner)
• HPI Organization (http://hl7.org.nz/fhir/StructureDefinition/HPIOrganization)
• HPI Location (http://hl7.org.nz/fhir/StructureDefinition/HPILocation)

Extensions

This structure refers to these extensions:

• http://hl7.org.nz/fhir/StructureDefinition/messaging-address

Slices

This structure defines the following Slices:

• The element 2 is sliced based on the values of PractitionerRole.identifier (Open at End)