US Public Health Profiles Library
2.0.0-ballot - STU 2 - Ballot United States of America flag

This page is part of the US Public Health Profiles Library (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: US Public Health PractitionerRole

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-practitionerrole Version: 2.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: USPublicHealthPractitionerRole
Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.44

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.

Represented USCDI+ Data Elements (in referenced US Core Practitioner)

Use Case Data Class Data Element Name
Case Reporting Care Team Member(s) Provider Address
Case Reporting Care Team Member(s) Provider Email
Case Reporting Care Team Member(s) Provider Fax
Case Reporting Care Team Member(s) Provider Name
Case Reporting Care Team Member(s) Provider NPI
Case Reporting Care Team Member(s) Provider Phone

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile US Public Health PractitionerRole
Constraints: pd-1, us-core-13
... 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
... 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: CareTeamMemberFunction (20240605) . (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: HealthcareProviderTaxonomy (20240606) . (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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30|20240605
PractitionerRole.specialtyextensibleHealthcareProviderTaxonomy .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066|20240606
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pd-1errorPractitionerRoleSHALL have contact information or a reference to an Endpoint
: telecom or endpoint
us-core-13errorPractitionerRoleSHALL have a practitioner, an organization, a healthcare service, or a location.
: practitioner or organization or healthcareService or location

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* USCorePractitionerRoleProfile US Public Health PractitionerRole
... identifier S 1..1 Identifier Business Identifiers that are specific to a role/location
... practitioner 1..1 Reference(US Core Practitioner Profile) (USCDI+) Provider Address, (USCDI+) Provider Email, (USCDI+) Provider Fax, (USCDI+) Provider Name, (USCDI+) Provider NPI, (USCDI+) Provider Phone (contained in referenced US Core Practitioner)
... organization 0..1 Reference(US Public Health Organization) Organization where the roles are available
... telecom 1..* ContactPoint Contact details that are specific to the role/location/service

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile US Public Health PractitionerRole
Constraints: pd-1, us-core-13
... 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
... 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
... 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) (USCDI+) Provider Address, (USCDI+) Provider Email, (USCDI+) Provider Fax, (USCDI+) Provider Name, (USCDI+) Provider NPI, (USCDI+) Provider Phone (contained in referenced US Core Practitioner)
... 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: CareTeamMemberFunction (20240605) . (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: HealthcareProviderTaxonomy (20240606) . (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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30|20240605
PractitionerRole.specialtyextensibleHealthcareProviderTaxonomy .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066|20240606
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pd-1errorPractitionerRoleSHALL have contact information or a reference to an Endpoint
: telecom or endpoint
us-core-13errorPractitionerRoleSHALL have a practitioner, an organization, a healthcare service, or a location.
: practitioner or organization or healthcareService or location

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile US Public Health PractitionerRole
Constraints: pd-1, us-core-13
... 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
... 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: CareTeamMemberFunction (20240605) . (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: HealthcareProviderTaxonomy (20240606) . (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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30|20240605
PractitionerRole.specialtyextensibleHealthcareProviderTaxonomy .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066|20240606
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pd-1errorPractitionerRoleSHALL have contact information or a reference to an Endpoint
: telecom or endpoint
us-core-13errorPractitionerRoleSHALL have a practitioner, an organization, a healthcare service, or a location.
: practitioner or organization or healthcareService or location

Differential View

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* USCorePractitionerRoleProfile US Public Health PractitionerRole
... identifier S 1..1 Identifier Business Identifiers that are specific to a role/location
... practitioner 1..1 Reference(US Core Practitioner Profile) (USCDI+) Provider Address, (USCDI+) Provider Email, (USCDI+) Provider Fax, (USCDI+) Provider Name, (USCDI+) Provider NPI, (USCDI+) Provider Phone (contained in referenced US Core Practitioner)
... organization 0..1 Reference(US Public Health Organization) Organization where the roles are available
... telecom 1..* ContactPoint Contact details that are specific to the role/location/service

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* USCorePractitionerRoleProfile US Public Health PractitionerRole
Constraints: pd-1, us-core-13
... 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
... 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
... 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) (USCDI+) Provider Address, (USCDI+) Provider Email, (USCDI+) Provider Fax, (USCDI+) Provider Name, (USCDI+) Provider NPI, (USCDI+) Provider Phone (contained in referenced US Core Practitioner)
... 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: CareTeamMemberFunction (20240605) . (extensible): Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.
... specialty SΣ 0..* CodeableConcept Specific specialty of the practitioner
Binding: HealthcareProviderTaxonomy (20240606) . (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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.codeextensibleCareTeamMemberFunction .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.30|20240605
PractitionerRole.specialtyextensibleHealthcareProviderTaxonomy .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066|20240606
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
From the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
From the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pd-1errorPractitionerRoleSHALL have contact information or a reference to an Endpoint
: telecom or endpoint
us-core-13errorPractitionerRoleSHALL have a practitioner, an organization, a healthcare service, or a location.
: practitioner or organization or healthcareService or location

 

Other representations of profile: CSV, Excel, Schematron