HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/core/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: PT_PractitionerRole

A generic PractitionerRole resource for Portugal

Usage:

• Refer to this Resource Profile: PT_Patient, PT_MessageHeader, MedicationParticipant, PT_CarePlan... Show 7 more, PT_Condition, PT_Encounter, PT_NutritionOrder, PT_Procedure, PT_RequestGroup, PT_ServiceRequest and PT_AllergyIntolerance

Formal Views of Profile Content

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

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

This structure is derived from PractitionerRole

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole			PractitionerRole
identifier		0..*	Identifier	Business Identifiers that are specific to a role/location
type		0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible)
coding
code		0..1	code	Symbol in syntax defined by the system
system		0..1	uri	The namespace for the identifier value
value		0..1	string	The value that is unique
period
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
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)
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
practitioner		0..1	Reference(PT_Practitioner)	Practitioner that is able to provide the defined services for the organization
reference		0..1	string	Literal reference, Relative, internal or absolute URL
organization
reference		0..1	string	Literal reference, Relative, internal or absolute URL
Slices for code		0..*	CodeableConcept	Roles which this practitioner may perform Slice: Unordered, Open by pattern:$this
code:healthcareProfessionalRoles		0..*	CodeableConcept	Roles which this practitioner may perform
coding		0..*	Coding	Code defined by a terminology system Binding: http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips (required)
system		0..1	uri	Identity of the terminology system
code		0..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
text		0..1	string	Plain text representation of the concept
specialty		0..*	CodeableConcept	Specific specialty of the practitioner
coding
system		0..1	uri	Identity of the terminology system
code		0..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
location		0..*	Reference(PT_Location)	The location(s) at which this practitioner provides care
reference		0..1	string	Literal reference, Relative, internal or absolute URL
healthcareService
reference		0..1	string	Literal reference, Relative, internal or absolute URL
telecom		0..*	ContactPoint	Contact details that are specific to the role/location/service
system		0..1	code	phone | fax | email | pager | url | sms | other
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: hl7VS-telecommunicationUseCode (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
PractitionerRole.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
PractitionerRole.code:healthcareProfessionalRoles.coding	required	http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips
PractitionerRole.telecom.use	required	Hl7VSTelecommunicationUseCode http://terminology.hl7.org/ValueSet/v2-0201

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	PractitionerRole	Roles/organizations the practitioner is associated with
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business Identifiers that are specific to a role/location
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
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)
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
practitioner	Σ	0..1	Reference(PT_Practitioner)	Practitioner that is able to provide the defined services for the organization
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
Slices for code	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Slice: Unordered, Open by pattern:$this Binding: PractitionerRole (example): The role a person plays representing an organization.
code:healthcareProfessionalRoles	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips (required)
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
specialty	Σ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location	Σ	0..*	Reference(PT_Location)	The location(s) at which this practitioner provides care
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
telecom	Σ	0..*	ContactPoint	Contact details that are specific to the role/location/service
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: hl7VS-telecommunicationUseCode (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PractitionerRole.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
PractitionerRole.code	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
PractitionerRole.code:healthcareProfessionalRoles	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
PractitionerRole.code:healthcareProfessionalRoles.coding	required	http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips
PractitionerRole.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
PractitionerRole.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
PractitionerRole.telecom.use	required	Hl7VSTelecommunicationUseCode http://terminology.hl7.org/ValueSet/v2-0201

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	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	error	PractitionerRole	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	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	PractitionerRole	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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
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)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
practitioner	Σ	0..1	Reference(PT_Practitioner)	Practitioner that is able to provide the defined services for the organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
organization	Σ	0..1	Reference(Organization)	Organization where the roles are available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
Slices for code	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Slice: Unordered, Open by pattern:$this Binding: PractitionerRole (example): The role a person plays representing an organization.
code:healthcareProfessionalRoles	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips (required)
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
specialty	Σ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
location	Σ	0..*	Reference(PT_Location)	The location(s) at which this practitioner provides care
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
healthcareService		0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
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: hl7VS-telecommunicationUseCode (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
availableTime		0..*	BackboneElement	Times the Service Site is available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not available from this date
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
PractitionerRole.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PractitionerRole.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
PractitionerRole.practitioner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.organization.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.code	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
PractitionerRole.code:healthcareProfessionalRoles	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
PractitionerRole.code:healthcareProfessionalRoles.coding	required	http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips
PractitionerRole.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
PractitionerRole.location.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.healthcareService.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
PractitionerRole.telecom.use	required	Hl7VSTelecommunicationUseCode http://terminology.hl7.org/ValueSet/v2-0201
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	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	error	PractitionerRole	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	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from PractitionerRole

Summary

Structures

This structure refers to these other structures:

• PT_Practitioner (http://hl7.pt/fhir/core/StructureDefinition/ac7bcb60-c472-44c2-8a98-d412e8645c6d)
• PT_Location (http://hl7.pt/fhir/core/StructureDefinition/PTLocation)

Slices

This structure defines the following Slices:

• The element PractitionerRole.code is sliced based on the value of pattern:$this

Differential View

This structure is derived from PractitionerRole

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole			PractitionerRole
identifier		0..*	Identifier	Business Identifiers that are specific to a role/location
type		0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible)
coding
code		0..1	code	Symbol in syntax defined by the system
system		0..1	uri	The namespace for the identifier value
value		0..1	string	The value that is unique
period
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
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)
start		0..1	dateTime	Starting time with inclusive boundary
end		0..1	dateTime	End time with inclusive boundary, if not ongoing
practitioner		0..1	Reference(PT_Practitioner)	Practitioner that is able to provide the defined services for the organization
reference		0..1	string	Literal reference, Relative, internal or absolute URL
organization
reference		0..1	string	Literal reference, Relative, internal or absolute URL
Slices for code		0..*	CodeableConcept	Roles which this practitioner may perform Slice: Unordered, Open by pattern:$this
code:healthcareProfessionalRoles		0..*	CodeableConcept	Roles which this practitioner may perform
coding		0..*	Coding	Code defined by a terminology system Binding: http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips (required)
system		0..1	uri	Identity of the terminology system
code		0..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
text		0..1	string	Plain text representation of the concept
specialty		0..*	CodeableConcept	Specific specialty of the practitioner
coding
system		0..1	uri	Identity of the terminology system
code		0..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
location		0..*	Reference(PT_Location)	The location(s) at which this practitioner provides care
reference		0..1	string	Literal reference, Relative, internal or absolute URL
healthcareService
reference		0..1	string	Literal reference, Relative, internal or absolute URL
telecom		0..*	ContactPoint	Contact details that are specific to the role/location/service
system		0..1	code	phone | fax | email | pager | url | sms | other
use		0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: hl7VS-telecommunicationUseCode (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
PractitionerRole.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
PractitionerRole.code:healthcareProfessionalRoles.coding	required	http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips
PractitionerRole.telecom.use	required	Hl7VSTelecommunicationUseCode http://terminology.hl7.org/ValueSet/v2-0201

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	PractitionerRole	Roles/organizations the practitioner is associated with
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business Identifiers that are specific to a role/location
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
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)
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
practitioner	Σ	0..1	Reference(PT_Practitioner)	Practitioner that is able to provide the defined services for the organization
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
Slices for code	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Slice: Unordered, Open by pattern:$this Binding: PractitionerRole (example): The role a person plays representing an organization.
code:healthcareProfessionalRoles	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips (required)
system	Σ	0..1	uri	Identity of the terminology system
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
text	Σ	0..1	string	Plain text representation of the concept
specialty	Σ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location	Σ	0..*	Reference(PT_Location)	The location(s) at which this practitioner provides care
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
telecom	Σ	0..*	ContactPoint	Contact details that are specific to the role/location/service
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: hl7VS-telecommunicationUseCode (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PractitionerRole.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
PractitionerRole.code	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
PractitionerRole.code:healthcareProfessionalRoles	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
PractitionerRole.code:healthcareProfessionalRoles.coding	required	http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips
PractitionerRole.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
PractitionerRole.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
PractitionerRole.telecom.use	required	Hl7VSTelecommunicationUseCode http://terminology.hl7.org/ValueSet/v2-0201

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	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	error	PractitionerRole	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	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	PractitionerRole	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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
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)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	ΣC	0..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
practitioner	Σ	0..1	Reference(PT_Practitioner)	Practitioner that is able to provide the defined services for the organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
organization	Σ	0..1	Reference(Organization)	Organization where the roles are available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
Slices for code	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Slice: Unordered, Open by pattern:$this Binding: PractitionerRole (example): The role a person plays representing an organization.
code:healthcareProfessionalRoles	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system Binding: http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips (required)
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
specialty	Σ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
location	Σ	0..*	Reference(PT_Location)	The location(s) at which this practitioner provides care
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
healthcareService		0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
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: hl7VS-telecommunicationUseCode (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
availableTime		0..*	BackboneElement	Times the Service Site is available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not available from this date
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
PractitionerRole.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PractitionerRole.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
PractitionerRole.practitioner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.organization.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.code	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
PractitionerRole.code:healthcareProfessionalRoles	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
PractitionerRole.code:healthcareProfessionalRoles.coding	required	http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips
PractitionerRole.specialty	preferred	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard
PractitionerRole.location.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.healthcareService.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
PractitionerRole.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
PractitionerRole.telecom.use	required	Hl7VSTelecommunicationUseCode http://terminology.hl7.org/ValueSet/v2-0201
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	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	error	PractitionerRole	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	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from PractitionerRole

Summary

Structures

This structure refers to these other structures:

• PT_Practitioner (http://hl7.pt/fhir/core/StructureDefinition/ac7bcb60-c472-44c2-8a98-d412e8645c6d)
• PT_Location (http://hl7.pt/fhir/core/StructureDefinition/PTLocation)

Slices

This structure defines the following Slices:

• The element PractitionerRole.code is sliced based on the value of pattern:$this

Other representations of profile: CSV, Excel, Schematron