HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.0 - STU 2 US

This page is part of the electronic Case Reporting (eCR) (v2.1.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: US Public Health Practitioner Role

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-practitionerrole Version: 2.1.0
Active as of 2022-08-31 Computable Name: USPublicHealthPractitionerRole

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:

Formal Views of Profile Content

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

This structure is derived from USCorePractitionerRoleProfile

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*USCorePractitionerRoleProfileUS Public Health PracitionerRole
... identifier S1..1IdentifierBusiness Identifiers that are specific to a role/location
... practitioner 1..1Reference(US Core Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization S0..1Reference(US Public Health Organization)Organization where the roles are available
... telecom S1..*ContactPointContact details that are specific to the role/location/service

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*USCorePractitionerRoleProfileUS Public Health PracitionerRole
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierBusiness Identifiers that are specific to a role/location
... active Σ0..1booleanWhether this practitioner role record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣI1..1Reference(US Core Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization SΣI0..1Reference(US Public Health Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles 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..*CodeableConceptSpecific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
... location SΣI0..*Reference(US Public Health Location)The location(s) at which this practitioner provides care
... healthcareService I0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣI1..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint SI0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*USCorePractitionerRoleProfileUS Public Health PracitionerRole
... identifier Σ1..1IdentifierBusiness Identifiers that are specific to a role/location
... practitioner ΣI1..1Reference(US Core Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization ΣI0..1Reference(US Public Health Organization)Organization where the roles are available
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
... location ΣI0..*Reference(US Public Health Location)The location(s) at which this practitioner provides care
... telecom ΣI1..*ContactPointContact details that are specific to the role/location/service
.... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ1..1stringThe actual contact point details
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

This structure is derived from USCorePractitionerRoleProfile

Differential View

This structure is derived from USCorePractitionerRoleProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*USCorePractitionerRoleProfileUS Public Health PracitionerRole
... identifier S1..1IdentifierBusiness Identifiers that are specific to a role/location
... practitioner 1..1Reference(US Core Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization S0..1Reference(US Public Health Organization)Organization where the roles are available
... telecom S1..*ContactPointContact details that are specific to the role/location/service

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*USCorePractitionerRoleProfileUS Public Health PracitionerRole
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..1IdentifierBusiness Identifiers that are specific to a role/location
... active Σ0..1booleanWhether this practitioner role record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣI1..1Reference(US Core Practitioner Profile)Practitioner that is able to provide the defined services for the organization
... organization SΣI0..1Reference(US Public Health Organization)Organization where the roles are available
... code SΣ0..*CodeableConceptRoles 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..*CodeableConceptSpecific specialty of the practitioner
Binding: Healthcare Provider Taxonomy (extensible)
... location SΣI0..*Reference(US Public Health Location)The location(s) at which this practitioner provides care
... healthcareService I0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom SΣI1..*ContactPointContact details that are specific to the role/location/service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint SI0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Max Binding: AllLanguages
PractitionerRole.codeextensibleUSCoreProviderRoleNucc
PractitionerRole.specialtyextensibleHealthcareProviderTaxonomy
PractitionerRole.telecom.systemrequiredContactPointSystem
PractitionerRole.telecom.userequiredContactPointUse
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePathDetailsRequirements
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()
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
ele-1errorPractitionerRole.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPractitionerRole.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPractitionerRole.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPractitionerRole.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPractitionerRole.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.practitionerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.organizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.specialtyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.healthcareServiceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.telecom.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPractitionerRole.telecom.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPractitionerRole.telecom.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.telecom.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.telecom.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.telecom.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.telecom.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.availableTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.availableTime.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPractitionerRole.availableTime.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPractitionerRole.availableTime.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPractitionerRole.availableTime.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPractitionerRole.availableTime.daysOfWeekAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.availableTime.allDayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.availableTime.availableStartTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.availableTime.availableEndTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.notAvailableAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.notAvailable.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPractitionerRole.notAvailable.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPractitionerRole.notAvailable.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPractitionerRole.notAvailable.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPractitionerRole.notAvailable.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.notAvailable.duringAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.availabilityExceptionsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPractitionerRole.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())