HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

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

Resource Profile: US Public Health Practitioner Role

This PractitionerRole profile represents the roles and organizations of the practitioner.

It is based on the US Core PractitionerRole profile with a further restriction of mandatory practitioner*, **identifier and telecom data elements and US Public Health Location and US Public Health Organization references.

Usage:

• Refer to this Resource Profile: RR Composition, US Public Health Composition, US Public Health Encounter and US Public Health Information Recipient Extension
• Examples for this Resource Profile: PractitionerRole/practitionerrole-henry-seven

Formal Views of Profile Content

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

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

This structure is derived from USCorePractitionerRoleProfile

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	USCorePractitionerRoleProfile(4.0.0)	US Public Health PracitionerRole
identifier	S	1..1	Identifier	Business Identifiers that are specific to a role/location
practitioner		1..1	Reference(US Core Practitioner Profile(4.0.0))	Practitioner that is able to provide the defined services for the organization
organization	S	0..1	Reference(US Public Health Organization)	Organization where the roles are available
location	S	0..*	Reference(US Public Health Location)	The location(s) at which this practitioner provides care
telecom	S	1..*	ContactPoint	Contact details that are specific to the role/location/service
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	C	0..*	USCorePractitionerRoleProfile(4.0.0)	US Public Health PracitionerRole 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.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	Business Identifiers that are specific to a role/location
practitioner	SΣC	1..1	Reference(US Core Practitioner Profile(4.0.0))	Practitioner that is able to provide the defined services for the organization
organization	SΣC	0..1	Reference(US Public Health Organization)	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ΣC	0..*	Reference(US Public Health Location)	The location(s) at which this practitioner provides care
telecom	SΣC	1..*	ContactPoint	Contact details that are specific to the role/location/service
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	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
endpoint	SC	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.code	extensible	USCoreProviderRoleNucc (a valid code from http://nucc.org/provider-taxonomy) http://hl7.org/fhir/us/core/ValueSet/us-core-provider-role
PractitionerRole.specialty	extensible	HealthcareProviderTaxonomy http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 from https://vsac.nlm.nih.gov
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pd-1	error	PractitionerRole	SHALL have contact information or a reference to an Endpoint : telecom or endpoint
us-core-13	error	PractitionerRole	SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner or organization or healthcareService or location

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	C	0..*	USCorePractitionerRoleProfile(4.0.0)	US Public Health PracitionerRole 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	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	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ΣC	1..1	Reference(US Core Practitioner Profile(4.0.0))	Practitioner that is able to provide the defined services for the organization
organization	SΣC	0..1	Reference(US Public Health Organization)	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ΣC	0..*	Reference(US Public Health Location)	The location(s) at which this practitioner provides care
healthcareService	C	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SΣC	1..*	ContactPoint	Contact details that are specific to the role/location/service
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	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	?!Σ	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	SC	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
PractitionerRole.code	extensible	USCoreProviderRoleNucc (a valid code from http://nucc.org/provider-taxonomy) http://hl7.org/fhir/us/core/ValueSet/us-core-provider-role
PractitionerRole.specialty	extensible	HealthcareProviderTaxonomy http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 from https://vsac.nlm.nih.gov
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pd-1	error	PractitionerRole	SHALL have contact information or a reference to an Endpoint : telecom or endpoint
us-core-13	error	PractitionerRole	SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner or organization or healthcareService or location

This structure is derived from USCorePractitionerRoleProfile

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• US Public Health Organization (http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-organization)
• US Public Health Location (http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-location)

Differential View

This structure is derived from USCorePractitionerRoleProfile

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole		0..*	USCorePractitionerRoleProfile(4.0.0)	US Public Health PracitionerRole
identifier	S	1..1	Identifier	Business Identifiers that are specific to a role/location
practitioner		1..1	Reference(US Core Practitioner Profile(4.0.0))	Practitioner that is able to provide the defined services for the organization
organization	S	0..1	Reference(US Public Health Organization)	Organization where the roles are available
location	S	0..*	Reference(US Public Health Location)	The location(s) at which this practitioner provides care
telecom	S	1..*	ContactPoint	Contact details that are specific to the role/location/service
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	C	0..*	USCorePractitionerRoleProfile(4.0.0)	US Public Health PracitionerRole 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.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	Business Identifiers that are specific to a role/location
practitioner	SΣC	1..1	Reference(US Core Practitioner Profile(4.0.0))	Practitioner that is able to provide the defined services for the organization
organization	SΣC	0..1	Reference(US Public Health Organization)	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ΣC	0..*	Reference(US Public Health Location)	The location(s) at which this practitioner provides care
telecom	SΣC	1..*	ContactPoint	Contact details that are specific to the role/location/service
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	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
endpoint	SC	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.code	extensible	USCoreProviderRoleNucc (a valid code from http://nucc.org/provider-taxonomy) http://hl7.org/fhir/us/core/ValueSet/us-core-provider-role
PractitionerRole.specialty	extensible	HealthcareProviderTaxonomy http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 from https://vsac.nlm.nih.gov
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pd-1	error	PractitionerRole	SHALL have contact information or a reference to an Endpoint : telecom or endpoint
us-core-13	error	PractitionerRole	SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner or organization or healthcareService or location

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
PractitionerRole	C	0..*	USCorePractitionerRoleProfile(4.0.0)	US Public Health PracitionerRole 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	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	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ΣC	1..1	Reference(US Core Practitioner Profile(4.0.0))	Practitioner that is able to provide the defined services for the organization
organization	SΣC	0..1	Reference(US Public Health Organization)	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ΣC	0..*	Reference(US Public Health Location)	The location(s) at which this practitioner provides care
healthcareService	C	0..*	Reference(HealthcareService)	The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom	SΣC	1..*	ContactPoint	Contact details that are specific to the role/location/service
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	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	?!Σ	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	SC	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
PractitionerRole.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
PractitionerRole.code	extensible	USCoreProviderRoleNucc (a valid code from http://nucc.org/provider-taxonomy) http://hl7.org/fhir/us/core/ValueSet/us-core-provider-role
PractitionerRole.specialty	extensible	HealthcareProviderTaxonomy http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 from https://vsac.nlm.nih.gov
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	PractitionerRole	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	PractitionerRole	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	PractitionerRole	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	PractitionerRole	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pd-1	error	PractitionerRole	SHALL have contact information or a reference to an Endpoint : telecom or endpoint
us-core-13	error	PractitionerRole	SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner or organization or healthcareService or location

This structure is derived from USCorePractitionerRoleProfile

Summary

Mandatory: 3 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• US Public Health Organization (http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-organization)
• US Public Health Location (http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-location)

Other representations of profile: CSV, Excel, Schematron