This profile sets minimum expectations for searching for and fetching information associated with a practitioner role. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the PractitionerRole resource when using this profile.

Background & Scope

PractitionerRole describes the role a practitioner plays at an organization, including the services they provide, the location(s) where they work, and their availability, electronic endpoints, and other relevant information.

This profile modifies the base PractitionerRole resource in the following manner:

• Constrains the cardinality of practitionerRole.active (1..1) and practitionerRole.code (1..*)

• All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile

• Adds extensions:

1. Identifier status (1..1) - indicates the status of a practitionerRole's identifier
2. Via intermediary (0..1) - a reference to an alternative point of contact for a practitioner in a role
3. Available time (0..*) - indicates when the contact point for a practitioner in a role is available
4. Network (0..*) - a reference to the healthcare provider insurance networks the practitioner participates in through their role
5. NewPatients (0..*) - indicates whether the practitioner is accepting new patients in their role
6. NewPatientProfile (0..*) - a description of the type of new patients a practitioner accepts in their role (e.g. pediatric only)
7. Qualification (0..*) - indicates qualifications the practitioner has through their role (e.g. registered to prescribe controlled substances)
8. DigitalCertificate (0..*) - a digital certificate associated with the practitioner in their role
9. Restriction (0..*) - indicates whether disclosure of any data associated with a practitionerRole is restricted

• Adds new value sets/updates value set bindings:

TBD

Examples:

The following are example uses for the vhdir-practitionerrole profile:

• George Washington practices at Founding Fathers Memorial Hospital

Mandatory Data Elements

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each practitionerRole must have:

1. A boolean value in practitionerRole.active
2. At least one value describing the role the practitioner performs in practitionerRole.code

Profile specific implementation guidance:

• TBD

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

This structure is derived from PractitionerRole

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	PractitionerRole	Roles/organizations the practitioner is associated with
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Network	S	0..*	Reference(VhDir Network)	A health insurance provider network the practitioner belongs to URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference
newpatients	S	0..*	(Complex)	Whether the practitioner is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients
newpatientprofile	S	0..*	string	Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
digitalcertificate	S	0..*	(Complex)	Digital certificate specific to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
qualification	S	0..*	(Complex)	Practitioner's qualifications unique to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
identifier	S	0..*	Identifier	Business Identifiers that are specific to a role/location
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required)
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
period	S	0..1	Period	Time period when id is/was valid for use
assigner	S	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text)
active	S	1..1	boolean	Whether this practitioner role record is in active use
period	S	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	S	0..1	Reference(VhDir Practitioner)	Practitioner that is able to provide the defined services for the organization
organization	S	0..1	Reference(VhDir Organization)	Organization where the roles are available
code	S	1..*	CodeableConcept	Roles which this practitioner may perform
specialty	S	0..*	CodeableConcept	Specific specialty of the practitioner
location	S	0..*	Reference(VhDir Location)	The location(s) at which this practitioner provides care
healthcareService	S	0..*	Reference(VhDir Healthcare Service)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	S	0..*	ContactPoint	Contact details that are specific to the role/location/service
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
viaintermediary	S	0..1	Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)	viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
rank	S	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	S	0..1	Period	Time period when the contact point was/is in use
availableTime	S	0..*	BackboneElement	Times the Service Site is available
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason
description	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Service not available from this date
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(VhDir Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Network	S	0..*	Reference(VhDir Network)	A health insurance provider network the practitioner belongs to URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference
newpatients	S	0..*	(Complex)	Whether the practitioner is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients
newpatientprofile	S	0..*	string	Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
digitalcertificate	S	0..*	(Complex)	Digital certificate specific to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
qualification	S	0..*	(Complex)	Practitioner's qualifications unique to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business Identifiers that are specific to a role/location
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	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.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text)
active	SΣ	1..1	boolean	Whether this practitioner role record is in active use
period	SΣ	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	SΣ	0..1	Reference(VhDir Practitioner)	Practitioner that is able to provide the defined services for the organization
organization	SΣ	0..1	Reference(VhDir Organization)	Organization where the roles are available
code	SΣ	1..*	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location	SΣ	0..*	Reference(VhDir Location)	The location(s) at which this practitioner provides care
healthcareService	S	0..*	Reference(VhDir Healthcare Service)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SΣ	0..*	ContactPoint	Contact details that are specific to the role/location/service
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
viaintermediary	S	0..1	Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)	viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	SΣ	0..1	Period	Time period when the contact point was/is in use
availableTime	S	0..*	BackboneElement	Times the Service Site is available
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Service not available from this date
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(VhDir 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.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PractitionerRole.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
PractitionerRole.code	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
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	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Network	S	0..*	Reference(VhDir Network)	A health insurance provider network the practitioner belongs to URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference
newpatients	S	0..*	(Complex)	Whether the practitioner is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients
newpatientprofile	S	0..*	string	Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
digitalcertificate	S	0..*	(Complex)	Digital certificate specific to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
qualification	S	0..*	(Complex)	Practitioner's qualifications unique to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business Identifiers that are specific to a role/location
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	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.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text)
active	SΣ	1..1	boolean	Whether this practitioner role record is in active use
period	SΣ	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	SΣ	0..1	Reference(VhDir Practitioner)	Practitioner that is able to provide the defined services for the organization
organization	SΣ	0..1	Reference(VhDir Organization)	Organization where the roles are available
code	SΣ	1..*	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location	SΣ	0..*	Reference(VhDir Location)	The location(s) at which this practitioner provides care
healthcareService	S	0..*	Reference(VhDir Healthcare Service)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SΣ	0..*	ContactPoint	Contact details that are specific to the role/location/service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
viaintermediary	S	0..1	Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)	viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	SΣ	0..1	Period	Time period when the contact point was/is in use
availableTime	S	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	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	S	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	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Service not available from this date
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(VhDir 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	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
PractitionerRole.code	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
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	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

Differential View

This structure is derived from PractitionerRole

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	PractitionerRole	Roles/organizations the practitioner is associated with
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Network	S	0..*	Reference(VhDir Network)	A health insurance provider network the practitioner belongs to URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference
newpatients	S	0..*	(Complex)	Whether the practitioner is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients
newpatientprofile	S	0..*	string	Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
digitalcertificate	S	0..*	(Complex)	Digital certificate specific to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
qualification	S	0..*	(Complex)	Practitioner's qualifications unique to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
identifier	S	0..*	Identifier	Business Identifiers that are specific to a role/location
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required)
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
period	S	0..1	Period	Time period when id is/was valid for use
assigner	S	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text)
active	S	1..1	boolean	Whether this practitioner role record is in active use
period	S	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	S	0..1	Reference(VhDir Practitioner)	Practitioner that is able to provide the defined services for the organization
organization	S	0..1	Reference(VhDir Organization)	Organization where the roles are available
code	S	1..*	CodeableConcept	Roles which this practitioner may perform
specialty	S	0..*	CodeableConcept	Specific specialty of the practitioner
location	S	0..*	Reference(VhDir Location)	The location(s) at which this practitioner provides care
healthcareService	S	0..*	Reference(VhDir Healthcare Service)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	S	0..*	ContactPoint	Contact details that are specific to the role/location/service
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
viaintermediary	S	0..1	Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)	viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
rank	S	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	S	0..1	Period	Time period when the contact point was/is in use
availableTime	S	0..*	BackboneElement	Times the Service Site is available
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason
description	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Service not available from this date
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(VhDir Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Network	S	0..*	Reference(VhDir Network)	A health insurance provider network the practitioner belongs to URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference
newpatients	S	0..*	(Complex)	Whether the practitioner is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients
newpatientprofile	S	0..*	string	Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
digitalcertificate	S	0..*	(Complex)	Digital certificate specific to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
qualification	S	0..*	(Complex)	Practitioner's qualifications unique to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business Identifiers that are specific to a role/location
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	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.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text)
active	SΣ	1..1	boolean	Whether this practitioner role record is in active use
period	SΣ	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	SΣ	0..1	Reference(VhDir Practitioner)	Practitioner that is able to provide the defined services for the organization
organization	SΣ	0..1	Reference(VhDir Organization)	Organization where the roles are available
code	SΣ	1..*	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location	SΣ	0..*	Reference(VhDir Location)	The location(s) at which this practitioner provides care
healthcareService	S	0..*	Reference(VhDir Healthcare Service)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SΣ	0..*	ContactPoint	Contact details that are specific to the role/location/service
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
viaintermediary	S	0..1	Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)	viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	SΣ	0..1	Period	Time period when the contact point was/is in use
availableTime	S	0..*	BackboneElement	Times the Service Site is available
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Service not available from this date
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(VhDir 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.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
PractitionerRole.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
PractitionerRole.code	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
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	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Network	S	0..*	Reference(VhDir Network)	A health insurance provider network the practitioner belongs to URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference
newpatients	S	0..*	(Complex)	Whether the practitioner is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients
newpatientprofile	S	0..*	string	Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
digitalcertificate	S	0..*	(Complex)	Digital certificate specific to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
qualification	S	0..*	(Complex)	Practitioner's qualifications unique to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business Identifiers that are specific to a role/location
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	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.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text)
active	SΣ	1..1	boolean	Whether this practitioner role record is in active use
period	SΣ	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
practitioner	SΣ	0..1	Reference(VhDir Practitioner)	Practitioner that is able to provide the defined services for the organization
organization	SΣ	0..1	Reference(VhDir Organization)	Organization where the roles are available
code	SΣ	1..*	CodeableConcept	Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location	SΣ	0..*	Reference(VhDir Location)	The location(s) at which this practitioner provides care
healthcareService	S	0..*	Reference(VhDir Healthcare Service)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SΣ	0..*	ContactPoint	Contact details that are specific to the role/location/service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
viaintermediary	S	0..1	Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)	viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	SΣ	0..1	Period	Time period when the contact point was/is in use
availableTime	S	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	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	S	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	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Service not available from this date
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(VhDir 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	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
PractitionerRole.code	example	PractitionerRole http://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard
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	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
PractitionerRole.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

This structure is derived from PractitionerRole

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 40 elements

Structures

This structure refers to these other structures:

• VhDir Organization (http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organization)
• VhDir Practitioner (http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-practitioner)
• VhDir Location (http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-location)
• VhDir Healthcare Service (http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-healthcareservice)
• VhDir Endpoint (http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-endpoint)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary

Supported Searches

1. GET [base]/PractitionerRole?active=[code]

   Support: SHALL support search by the active parameter: http://hl7.org/fhir/SearchParameter/PractitionerRole-active

1. GET [base]/PractitionerRole?endpoint=[id]

   Support: SHOULD support search by the endpoint parameter

   • with a target type: Endpoint
   • including these search paramaters which may be chained: endpoint.identifier, endpoint.connection-type, endpoint.organization

1. GET [base]/PractitionerRole?identifier=[code]

   Support: SHALL support search by the identifier parameter

   • including the modifiers: text, ofType

1. GET [base]/PractitionerRole?identifier-assigner=[id]

   Support: MAY support search by the identifier-assigner parameter

   • with a target type: Organization
   • including the modifiers: below
   • including these search paramaters which may be chained: identifier-assigner.identifier, identifier-assigner.name

1. GET [base]/PractitionerRole?location=[id]

   Support: SHALL support search by the location parameter

   • with a target type: Location
   • including the modifiers: above, below
   • including these search paramaters which may be chained: location.identifier, location.type, location.address, location.organization

1. GET [base]/PractitionerRole?network=[id]

   Support: SHOULD support search by the network parameter

   • with a target type: Organization
   • including these search paramaters which may be chained: network.identifier, network.name, network.partof

1. GET [base]/PractitionerRole?new-patient=[code]

   Support: SHOULD support search by the new-patient parameter

1. GET [base]/PractitionerRole?new-patient-network=[id]

   Support: SHOULD support search by the new-patient-network parameter

   • with a target type: Organization
   • including these search paramaters which may be chained: new-patient-network.identifier, new-patient-network.name, new-patient-network.partof

1. GET [base]/PractitionerRole?organization=[id]

   Support: SHALL support search by the organization parameter

   • with a target type: Organization
   • including the modifiers: above, below
   • including these search paramaters which may be chained: organization.identifier, organization.name, organization.address, organization.partof, organization-type

1. GET [base]/PractitionerRole?practitioner=[id]

   Support: SHALL support search by the practitioner parameter

   • with a target type: Practitioner
   • including these search paramaters which may be chained: practitioner.identifier, practitioner.name

1. GET [base]/PractitionerRole?qualification-code=[code]

   Support: SHOULD support search by the qualification-code parameter

   • including the modifiers: text

1. GET [base]/PractitionerRole?qualification-issuer=[id]

   Support: MAY support search by the qualification-issuer parameter

   • with a target type: Organization
   • including the modifiers: below
   • including these search paramaters which may be chained: qualification-issuer.identifier, qualification-issuer.name

1. GET [base]/PractitionerRole?qualification-status=[code]

   Support: SHOULD support search by the qualification-status parameter

1. GET [base]/PractitionerRole?qualification-wherevalid-code=[code]

   Support: SHOULD support search by the qualification-wherevalid-code parameter

   • including the modifiers: text

1. GET [base]/PractitionerRole?qualification-wherevalid-location=[id]

   Support: SHOULD support search by the qualification-wherevalid-location parameter

   • with a target type: Location
   • including the modifiers: above, below
   • including these search paramaters which may be chained: qualification-wherevalid-location.identifier, qualification-wherevalid-location.address, qualification-wherevalid-location.organization

1. GET [base]/PractitionerRole?role=[code]

   Support: SHALL support search by the role parameter

   • including the modifiers: text

1. GET [base]/PractitionerRole?service=[id]

   Support: SHOULD support search by the service parameter

   • with a target type: HealthcareService
   • including these search paramaters which may be chained: service.identifier, service.service-category, service.organization, service.location

1. GET [base]/PractitionerRole?specialty=[code]

   Support: SHOULD support search by the specialty parameter

   • including the modifiers: text

1. GET [base]/PractitionerRole?via-intermediary=[id]

   Support: MAY support search by the via-intermediary parameter

   • with a target type: PractitionerRole, Organization, OrganizationAffiliation, Location