Scope and Usage

This profile sets minimum expectations for the PractitionerRole resource to record, search, and fetch the practitioner role for a practitioner. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the PractitionerRole resource when using this profile. The requirements for the US Core Practitioner were drawn from the Argonaut Provider Directory, IHE Healthcare Provider Directory and the ONC Provider Directory Workshop.

Mandatory and Must Support Data Elements

The following data-elements must always be present (Mandatory definition]) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each PractitionerRole must support:

1. An associated organization
2. An associated practitioner
3. A role
4. A specialty
5. An associated location
6. Contact information
7. A communication endpoint

Profile specific implementation guidance:

• At least one of the following elements must be present:
  • PractitionerRole.practitioner
  • PractitionerRole.organization
  • PractitionerRole.healthcareService
  • PractitionerRole.location
• The PractitionerRole.endpoint is where a Direct address may be represented.
• Clients can request servers return the Practitioner resource and Endpoint resources by using _include. See Quick Start.
• As a result of implementation feedback, the US Core Location and PractitionerRole Profiles are not explicitly referenced in any US Core Profile. However they SHOULD be used as the default profile if referenced by another US Core profile. See this guidance on Referencing US Core Profiles.

Examples

• Bundle-PractitionerRole-with-Practitioner-Endpoint

• Text Summary
• Differential Table
• Snapshot Table
• Snapshot Table (Must Support)
• All

This structure is derived from PractitionerRole

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	I	0..*	PractitionerRole	Roles/organizations the practitioner is associated with pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
practitioner	SI	0..1	Reference(US Core Practitioner Profile)	Practitioner that is able to provide the defined services for the organization
organization	SI	0..1	Reference(US Core Organization Profile)	Organization where the roles are available
code	S	0..*	CodeableConcept	Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
specialty	S	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible)
location	SI	0..*	Reference(Location)	The location(s) at which this practitioner provides care
healthcareService	I	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SI	0..*	ContactPoint	Contact details that are specific to the role/location/service
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
endpoint	SI	0..*	Reference(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	I	0..*	PractitionerRole	Roles/organizations the practitioner is associated with pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
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
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	SΣI	0..1	Reference(US Core Practitioner Profile)	Practitioner that is able to provide the defined services for the organization
organization	SΣI	0..1	Reference(US Core Organization Profile)	Organization where the roles are available
code	SΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible)
location	SΣI	0..*	Reference(Location)	The location(s) at which this practitioner provides care
healthcareService	I	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SΣI	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	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣI	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	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
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	SI	0..*	Reference(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	I	0..*	PractitionerRole	Roles/organizations the practitioner is associated with pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
practitioner	ΣI	0..1	Reference(US Core Practitioner Profile)	Practitioner that is able to provide the defined services for the organization
organization	ΣI	0..1	Reference(US Core Organization Profile)	Organization where the roles are available
code	Σ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
specialty	Σ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible)
location	ΣI	0..*	Reference(Location)	The location(s) at which this practitioner provides care
telecom	ΣI	0..*	ContactPoint	Contact details that are specific to the role/location/service
system	ΣI	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	1..1	string	The actual contact point details
endpoint	I	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

This structure is derived from PractitionerRole

Summary

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

Structures

This structure refers to these other structures:

• http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
• http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization

Differential View

This structure is derived from PractitionerRole

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	I	0..*	PractitionerRole	Roles/organizations the practitioner is associated with pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
practitioner	SI	0..1	Reference(US Core Practitioner Profile)	Practitioner that is able to provide the defined services for the organization
organization	SI	0..1	Reference(US Core Organization Profile)	Organization where the roles are available
code	S	0..*	CodeableConcept	Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
specialty	S	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible)
location	SI	0..*	Reference(Location)	The location(s) at which this practitioner provides care
healthcareService	I	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SI	0..*	ContactPoint	Contact details that are specific to the role/location/service
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
endpoint	SI	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	I	0..*	PractitionerRole	Roles/organizations the practitioner is associated with pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
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
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	SΣI	0..1	Reference(US Core Practitioner Profile)	Practitioner that is able to provide the defined services for the organization
organization	SΣI	0..1	Reference(US Core Organization Profile)	Organization where the roles are available
code	SΣ	0..*	CodeableConcept	Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
specialty	SΣ	0..*	CodeableConcept	Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible)
location	SΣI	0..*	Reference(Location)	The location(s) at which this practitioner provides care
healthcareService	I	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SΣI	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	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣI	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	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
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	SI	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile’s information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

• The syntax used to describe the interactions is described here.
• See the General Guidance section for additional rules and expectations when a server requires status parameters.
• See the General Guidance section for additional guidance on searching for multiple patients.

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

1. SHALL support searching practitioner role by specialty using the specialty search parameter:

   • including optional support for these _include parameters: PractitionerRole:endpoint,PractitionerRole:practitioner

   GET [base]/PractitionerRole?specialty={system|}[code]

   Example:

   1. GET [base]/PractitionerRole?specialty=http://nucc.org/provider-taxonomy|208D0000X

   Implementation Notes: Fetches a bundle containing PractitionerRole resources matching the specialty (how to search by token)

2. SHALL support searching practitioner role by practitioner name and identifier using chained parameters using the practitioner search parameter:

   • including support for these chained parameters: practitioner.identifier,practitioner.name
   • including optional support for these _include parameters: PractitionerRole:endpoint,PractitionerRole:practitioner

   GET [base]/PractitionerRole?practitioner={Type/}[id]

   Example:

   1. GET [base]/PractitionerRole?practitioner.identifier=http://hl7.org/fhir/sid/us-npi|97860456&_include=PractitionerRole:practitioner&_include=PractitionerRole?endpoint
   2. GET [base]/PractitionerRole?practitioner.name=Henry&_include=PractitionerRole:practitioner&_include=PractitionerRole?endpoint

   Implementation Notes: Fetches a bundle containing PractitionerRole resources matching the chained parameter practitioner.name or practitioner.identifier. SHOULD support the _include for PractionerRole.practitioner and PractitionerRole.endpoint. (how to search by reference)