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 Views 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⁴

^1,2,3,4 see guidance below

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

• ¹At least one of the following elements must be present:
  • PractitionerRole.practitioner
  • PractitionerRole.organization
  • PractitionerRole.healthcareService
  • PractitionerRole.location
• Due to implementer feedback, some US Core Profiles reference the PractitionerRole resource instead of the US Core PractitionerRole Profile. However, the US Core PractitionerRole Profile SHOULD be used as the default profile if referenced by another US Core profile.^§ See this guidance on Referencing US Core Profiles.
• ⁴A Direct address can be represented in the telecom element using the US Core Direct email Extension or in a referenced Endpoint as a "direct-project" endpoint connection type.
• ²When selecting role codes
  • implementers SHOULD choose the code that reflects the specific duties performed within that role rather than the specialty unless the individual's professional specialization characterizes the role.^§
  • Systems that primarily rely on NUCC codes instead of SNOMED CT to represent role codes can use the Da Vinci HRex NUCC to SNOMED CT Mappings to aid in translations.
• ³Unless exchanging legacy or text-only data, medical specialty codes SHOULD be taken from NUCC or SNOMED CT.^§
• Clients can request Servers return the Practitioner and Endpoint resources using _include. See the Quick Start section below for further guidance.

Changes since version 9.0.0:

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole	C	0..*	PractitionerRole	Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13
PractitionerRole.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
PractitionerRole.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
PractitionerRole.practitioner	S This element must be supported. Σ This element is included in summaries. C	0..1	Reference(US Core Practitioner Profile)	Practitioner that is able to provide the defined services for the organization
PractitionerRole.organization	S This element must be supported. Σ This element is included in summaries. C	0..1	Reference(US Core Organization Profile)	Organization where the roles are available
PractitionerRole.code	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
PractitionerRole.specialty	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Specific specialty of the practitioner Binding: US Core Practitioner Role Specialty Codes (extensible)
PractitionerRole.location	S This element must be supported. Σ This element is included in summaries. C	0..*	Reference(US Core Location Profile)	The location(s) at which this practitioner provides care
PractitionerRole.healthcareService	C	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
PractitionerRole.telecom	S This element must be supported. Σ This element is included in summaries. C	0..*	ContactPoint	Contact details that are specific to the role/location/service
PractitionerRole.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
PractitionerRole.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
PractitionerRole.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
PractitionerRole.endpoint	S This element must be supported. C	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PractitionerRole.code	Base	extensible	Care Team Member Function	⏿20240605	tx.fhir.org
PractitionerRole.specialty	Base	extensible	US Core Practitioner Role Specialty Codes	📦10.0.0-ballot	This IG
PractitionerRole.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
PractitionerRole.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
pd-1	error	PractitionerRole	SHALL have contact information or a reference to an Endpoint	telecom.exists() or endpoint.exists()
us-core-13	error	PractitionerRole	SHALL have a practitioner, an organization, a healthcare service, or a location.	practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

This structure is derived from PractitionerRole

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole	C	0..*	PractitionerRole	Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13
PractitionerRole.practitioner	S This element must be supported. C	0..1	Reference(US Core Practitioner Profile)	Practitioner that is able to provide the defined services for the organization
PractitionerRole.organization	S This element must be supported. C	0..1	Reference(US Core Organization Profile)	Organization where the roles are available
PractitionerRole.code	S This element must be supported.	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
PractitionerRole.specialty	S This element must be supported.	0..*	CodeableConcept	Specific specialty of the practitioner Binding: US Core Practitioner Role Specialty Codes (extensible)
PractitionerRole.location	S This element must be supported. C	0..*	Reference(US Core Location Profile)	The location(s) at which this practitioner provides care
PractitionerRole.healthcareService	C	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
PractitionerRole.telecom	S This element must be supported. C	0..*	ContactPoint	Contact details that are specific to the role/location/service
PractitionerRole.telecom.system	S This element must be supported.	1..1	code	phone | fax | email | pager | url | sms | other
PractitionerRole.telecom.value	S This element must be supported.	1..1	string	The actual contact point details
PractitionerRole.endpoint	S This element must be supported. C	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
PractitionerRole.code	Base	extensible	Care Team Member Function	⏿20240605	tx.fhir.org
PractitionerRole.specialty	Base	extensible	US Core Practitioner Role Specialty Codes	📦10.0.0-ballot	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
pd-1	error	PractitionerRole	SHALL have contact information or a reference to an Endpoint	telecom.exists() or endpoint.exists()
us-core-13	error	PractitionerRole	SHALL have a practitioner, an organization, a healthcare service, or a location.	practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole	C	0..*	PractitionerRole	Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13
PractitionerRole.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
PractitionerRole.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
PractitionerRole.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
PractitionerRole.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
PractitionerRole.contained		0..*	Resource	Contained, inline Resources
PractitionerRole.extension		0..*	Extension	Additional content defined by implementations
PractitionerRole.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
PractitionerRole.identifier	Σ This element is included in summaries.	0..*	Identifier	Business Identifiers that are specific to a role/location
PractitionerRole.active	Σ This element is included in summaries.	0..1	boolean	Whether this practitioner role record is in active use
PractitionerRole.period	Σ This element is included in summaries.	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
PractitionerRole.practitioner	S This element must be supported. Σ This element is included in summaries. C	0..1	Reference(US Core Practitioner Profile)	Practitioner that is able to provide the defined services for the organization
PractitionerRole.organization	S This element must be supported. Σ This element is included in summaries. C	0..1	Reference(US Core Organization Profile)	Organization where the roles are available
PractitionerRole.code	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
PractitionerRole.specialty	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Specific specialty of the practitioner Binding: US Core Practitioner Role Specialty Codes (extensible)
PractitionerRole.location	S This element must be supported. Σ This element is included in summaries. C	0..*	Reference(US Core Location Profile)	The location(s) at which this practitioner provides care
PractitionerRole.healthcareService	C	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
PractitionerRole.telecom	S This element must be supported. Σ This element is included in summaries. C	0..*	ContactPoint	Contact details that are specific to the role/location/service
PractitionerRole.telecom.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
PractitionerRole.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
PractitionerRole.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
PractitionerRole.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
PractitionerRole.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
PractitionerRole.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
PractitionerRole.availableTime		0..*	BackboneElement	Times the Service Site is available
PractitionerRole.availableTime.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.availableTime.extension		0..*	Extension	Additional content defined by implementations
PractitionerRole.availableTime.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
PractitionerRole.availableTime.daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
PractitionerRole.availableTime.allDay		0..1	boolean	Always available? e.g. 24 hour service
PractitionerRole.availableTime.availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
PractitionerRole.availableTime.availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
PractitionerRole.notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
PractitionerRole.notAvailable.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.notAvailable.extension		0..*	Extension	Additional content defined by implementations
PractitionerRole.notAvailable.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
PractitionerRole.notAvailable.description		1..1	string	Reason presented to the user explaining why time not available
PractitionerRole.notAvailable.during		0..1	Period	Service not available from this date
PractitionerRole.availabilityExceptions		0..1	string	Description of availability exceptions
PractitionerRole.endpoint	S This element must be supported. C	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PractitionerRole.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
PractitionerRole.code	Base	extensible	Care Team Member Function	⏿20240605	tx.fhir.org
PractitionerRole.specialty	Base	extensible	US Core Practitioner Role Specialty Codes	📦10.0.0-ballot	This IG
PractitionerRole.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
PractitionerRole.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
PractitionerRole.availableTime.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
pd-1	error	PractitionerRole	SHALL have contact information or a reference to an Endpoint	telecom.exists() or endpoint.exists()
us-core-13	error	PractitionerRole	SHALL have a practitioner, an organization, a healthcare service, or a location.	practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole	C	0..*	PractitionerRole	Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13
PractitionerRole.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
PractitionerRole.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
PractitionerRole.practitioner	S This element must be supported. Σ This element is included in summaries. C	0..1	Reference(US Core Practitioner Profile)	Practitioner that is able to provide the defined services for the organization
PractitionerRole.organization	S This element must be supported. Σ This element is included in summaries. C	0..1	Reference(US Core Organization Profile)	Organization where the roles are available
PractitionerRole.code	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
PractitionerRole.specialty	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Specific specialty of the practitioner Binding: US Core Practitioner Role Specialty Codes (extensible)
PractitionerRole.location	S This element must be supported. Σ This element is included in summaries. C	0..*	Reference(US Core Location Profile)	The location(s) at which this practitioner provides care
PractitionerRole.healthcareService	C	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
PractitionerRole.telecom	S This element must be supported. Σ This element is included in summaries. C	0..*	ContactPoint	Contact details that are specific to the role/location/service
PractitionerRole.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
PractitionerRole.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
PractitionerRole.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
PractitionerRole.endpoint	S This element must be supported. C	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PractitionerRole.code	Base	extensible	Care Team Member Function	⏿20240605	tx.fhir.org
PractitionerRole.specialty	Base	extensible	US Core Practitioner Role Specialty Codes	📦10.0.0-ballot	This IG
PractitionerRole.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
PractitionerRole.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
pd-1	error	PractitionerRole	SHALL have contact information or a reference to an Endpoint	telecom.exists() or endpoint.exists()
us-core-13	error	PractitionerRole	SHALL have a practitioner, an organization, a healthcare service, or a location.	practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

Differential View

This structure is derived from PractitionerRole

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole	C	0..*	PractitionerRole	Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13
PractitionerRole.practitioner	S This element must be supported. C	0..1	Reference(US Core Practitioner Profile)	Practitioner that is able to provide the defined services for the organization
PractitionerRole.organization	S This element must be supported. C	0..1	Reference(US Core Organization Profile)	Organization where the roles are available
PractitionerRole.code	S This element must be supported.	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
PractitionerRole.specialty	S This element must be supported.	0..*	CodeableConcept	Specific specialty of the practitioner Binding: US Core Practitioner Role Specialty Codes (extensible)
PractitionerRole.location	S This element must be supported. C	0..*	Reference(US Core Location Profile)	The location(s) at which this practitioner provides care
PractitionerRole.healthcareService	C	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
PractitionerRole.telecom	S This element must be supported. C	0..*	ContactPoint	Contact details that are specific to the role/location/service
PractitionerRole.telecom.system	S This element must be supported.	1..1	code	phone | fax | email | pager | url | sms | other
PractitionerRole.telecom.value	S This element must be supported.	1..1	string	The actual contact point details
PractitionerRole.endpoint	S This element must be supported. C	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
PractitionerRole.code	Base	extensible	Care Team Member Function	⏿20240605	tx.fhir.org
PractitionerRole.specialty	Base	extensible	US Core Practitioner Role Specialty Codes	📦10.0.0-ballot	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
pd-1	error	PractitionerRole	SHALL have contact information or a reference to an Endpoint	telecom.exists() or endpoint.exists()
us-core-13	error	PractitionerRole	SHALL have a practitioner, an organization, a healthcare service, or a location.	practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
PractitionerRole	C	0..*	PractitionerRole	Roles/organizations the practitioner is associated with Constraints: pd-1, us-core-13
PractitionerRole.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
PractitionerRole.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
PractitionerRole.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
PractitionerRole.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
PractitionerRole.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
PractitionerRole.contained		0..*	Resource	Contained, inline Resources
PractitionerRole.extension		0..*	Extension	Additional content defined by implementations
PractitionerRole.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
PractitionerRole.identifier	Σ This element is included in summaries.	0..*	Identifier	Business Identifiers that are specific to a role/location
PractitionerRole.active	Σ This element is included in summaries.	0..1	boolean	Whether this practitioner role record is in active use
PractitionerRole.period	Σ This element is included in summaries.	0..1	Period	The period during which the practitioner is authorized to perform in these role(s)
PractitionerRole.practitioner	S This element must be supported. Σ This element is included in summaries. C	0..1	Reference(US Core Practitioner Profile)	Practitioner that is able to provide the defined services for the organization
PractitionerRole.organization	S This element must be supported. Σ This element is included in summaries. C	0..1	Reference(US Core Organization Profile)	Organization where the roles are available
PractitionerRole.code	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Roles which this practitioner may perform Binding: Care Team Member Function (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
PractitionerRole.specialty	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Specific specialty of the practitioner Binding: US Core Practitioner Role Specialty Codes (extensible)
PractitionerRole.location	S This element must be supported. Σ This element is included in summaries. C	0..*	Reference(US Core Location Profile)	The location(s) at which this practitioner provides care
PractitionerRole.healthcareService	C	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
PractitionerRole.telecom	S This element must be supported. Σ This element is included in summaries. C	0..*	ContactPoint	Contact details that are specific to the role/location/service
PractitionerRole.telecom.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
PractitionerRole.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
PractitionerRole.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
PractitionerRole.telecom.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
PractitionerRole.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
PractitionerRole.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
PractitionerRole.availableTime		0..*	BackboneElement	Times the Service Site is available
PractitionerRole.availableTime.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.availableTime.extension		0..*	Extension	Additional content defined by implementations
PractitionerRole.availableTime.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
PractitionerRole.availableTime.daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
PractitionerRole.availableTime.allDay		0..1	boolean	Always available? e.g. 24 hour service
PractitionerRole.availableTime.availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
PractitionerRole.availableTime.availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
PractitionerRole.notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
PractitionerRole.notAvailable.id		0..1	string	Unique id for inter-element referencing
PractitionerRole.notAvailable.extension		0..*	Extension	Additional content defined by implementations
PractitionerRole.notAvailable.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
PractitionerRole.notAvailable.description		1..1	string	Reason presented to the user explaining why time not available
PractitionerRole.notAvailable.during		0..1	Period	Service not available from this date
PractitionerRole.availabilityExceptions		0..1	string	Description of availability exceptions
PractitionerRole.endpoint	S This element must be supported. C	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
PractitionerRole.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
PractitionerRole.code	Base	extensible	Care Team Member Function	⏿20240605	tx.fhir.org
PractitionerRole.specialty	Base	extensible	US Core Practitioner Role Specialty Codes	📦10.0.0-ballot	This IG
PractitionerRole.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
PractitionerRole.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
PractitionerRole.availableTime.​daysOfWeek	Base	required	DaysOfWeek	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
pd-1	error	PractitionerRole	SHALL have contact information or a reference to an Endpoint	telecom.exists() or endpoint.exists()
us-core-13	error	PractitionerRole	SHALL have a practitioner, an organization, a healthcare service, or a location.	practitioner.exists() or organization.exists() or healthcareService.exists() or location.exists()

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:

• US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner)
• US Core Organization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization)
• US Core Location Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-location)

Maturity: 5

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.

• See the Scopes Format section for a description of the SMART scopes syntax.
• See the Search Syntax section for a description of the US Core search syntax.
• See the General Requirements 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.

US Core Scopes

Servers providing access to practitioner role data SHALL support these US Core SMART Scopes:

• resource level scopes: <patient|user|system>/PractitionerRole.rs ^§

Mandatory Search Parameters:

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

1. 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,name

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

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

   Examples:

   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 US Core PractitionerRole Profile resources matching the chained parameter practitioner.name or practitioner.identifier. SHOULD support the _include parameters ( see how to search by reference).

2. 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|}[search_code]

   Example:

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

   Implementation Notes: Fetches a bundle containing US Core PractitionerRole Profile resources matching the specialty ( see how to search by token).