Provider
Class ProviderRole

This class describes the services that an Individual Provider may provide at different locations within the context of his/her affiliation with an Organizational Provider. This class is called Provider Role because it is similarly named in FHIR, and because it describes the role the Individual Provider is playing at a particular Organizational Provider’s facility (i.e., Service Delivery Location). An Individual Provider may have multiple specialties but only be authorized to use a particular specialty at a particular location. In addition, because this class links an Individual Provider with a location, it is used to link to the providers schedule at that location and to provide a list of electronic endpoints at which the provider can be reached through electronic communications. Note that in FHIR, this resource is used to refer to a Provider without knowing in advance which individual will play this role (e.g, I need a Cardiologist that is associated with this hospital (i.e., it doesn't matter which cardiologist), or accepts my plan, etc.). Thus in FHIR, this resource points to an optional provider and an optional organization. In FHIM, the association between an IndividualProvider and an OrganizationProvider is handled through the NetworkAffiliation class. Thus, the FHIM includes an optional pointer to NetworkAffiliation rather than separate pointers to IndividualProvider and OrganizationProvider.
"A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time." - HL7 FHIR, PractitionerRole

Attributes
String availabilityExceptions availabilityExceptions

"A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times." - HL7 FHIR, PractitionerRole.availabilityExceptions

AvailableTime availableTime availableTime

Pointer to a list of times during which the Individual Provider is available at the specified location.
"A collection of times that the Service Site is available." - HL7 FHIR, PractitionerRole.availableTime

ElectronicServiceEndpoint endpoint endpoint

Pointer to information concerning electronic capabilities of the Healthcare Provider.
"Technical endpoints providing access to services operated for the practitioner with this role." - HL7 FHIR, PractitionerRole.endpoint

HealthcareService healthcareService healthcareService

"The list of healthcare services that this worker provides for this role's Organization/Location(s)." - HL7 FHIR, PractitionerRole.healthcareService

«II» Id identifier identifier

"Business Identifiers that are specific to a role/location." - HL7 FHIR, PractitionerRole.identifier

Boolean isActive isActive

This optional property indicates whether this Provider Role record is active.
"Whether this practitioner's record is in active use." - HL7 FHIR, PractitionerRole.active

NotAvailable notAvailable notAvailable

Pointer to a list of times during which the Individual Provider is not available at the specified location
"The HealthcareService is not available during this period of time due to the provided reason." - HL7 FHIR, PractitionerRole.notAvailable

«IVL_TS» Period period period

"The period during which the person is authorized to act as a practitioner in these role(s) for the organization." - HL7 FHIR, PractitionerRole.period

ProviderAffiliation providerAffiliation providerAffiliation

In FHIR, the PractitionerRole resource is used to refer to a Provider without knowing in advance which individual will play this role (e.g, I need a Cardiologist that is associated with this hospital, or accepts my plan, etc.). Thus this resource in FHIR points to an optional provider and an optional organization. In FHIM, the association between an IndividualProvider and an OrganizationProvider is handled through the NetworkAffiliation class. Thus, this property is an optional pointer to NetworkAffiliation rather than separate pointers to IndividualProvider and OrganizationProvider.
"Practitioner that is able to provide the defined services for the organization." - HL7 FHIR, PractitionerRole.practitioner
"The organization where the Practitioner performs the roles associated." - HL7 FHIR, PractitionerRole.organization

«CS» Code roleCode roleCode

"Roles which this practitioner is authorized to perform for the organization." - HL7 FHIR, PractitionerRole.code

ServiceDeliveryLocation serviceDeliveryLocation serviceDeliveryLocation

Pointer to the Service Delivery Locations with which the Individual Provider is associated due to his/her affiliation to the Practice.
"The location(s) at which this practitioner provides care." - HL7 FHIR, PractitionerRole.location

Specialty specialty specialty

Pointer to the medical Specialty which the Provider is authorized to practice as part of his/her affiliation with the Organizational Provider.
"Specific specialty of the practitioner." - HL7 FHIR, PractitionerRole.specialty

«TEL» ContactPoint telecom telecom

"Contact details that are specific to the role/location/service." - HL7 FHIR, PractitionerRole.telecom


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameProviderRole
Name Expression
NamespaceProvider
Owned Template Signature
OwnerProvider
Owning Template Parameter
PackageProvider
Qualified NameFHIM::Provider::ProviderRole
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 availabilityExceptions
Public String availabilityExceptions

"A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times." - HL7 FHIR, PractitionerRole.availabilityExceptions

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProviderRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameavailabilityExceptions
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::availabilityExceptions
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 availableTime
Public AvailableTime availableTime

Pointer to a list of times during which the Individual Provider is available at the specified location.
"A collection of times that the Service Site is available." - HL7 FHIR, PractitionerRole.availableTime

Constraints:
Properties:

AggregationNone
Alias
AssociationproviderRole_availableTime
Association End
ClassProviderRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameavailableTime
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::availableTime
Stereotype
Template Parameter
TypeAvailableTime
Upper*
Upper Value(*)
VisibilityPublic


 endpoint
Public ElectronicServiceEndpoint endpoint

Pointer to information concerning electronic capabilities of the Healthcare Provider.
"Technical endpoints providing access to services operated for the practitioner with this role." - HL7 FHIR, PractitionerRole.endpoint

Constraints:
Properties:

AggregationNone
Alias
AssociationproviderRole_endPoint
Association End
ClassProviderRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameendpoint
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::endpoint
Stereotype
Template Parameter
TypeElectronicServiceEndpoint
Upper*
Upper Value(*)
VisibilityPublic


 healthcareService
Public HealthcareService healthcareService

"The list of healthcare services that this worker provides for this role's Organization/Location(s)." - HL7 FHIR, PractitionerRole.healthcareService

Constraints:
Properties:

AggregationNone
Alias
AssociationproviderRole_healthcareService
Association End
ClassProviderRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamehealthcareService
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::healthcareService
Stereotype
Template Parameter
TypeHealthcareService
Upper*
Upper Value(*)
VisibilityPublic


 identifier
Public «II» Id identifier

"Business Identifiers that are specific to a role/location." - HL7 FHIR, PractitionerRole.identifier

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProviderRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameidentifier
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::identifier
Stereotype
Template Parameter
Type«II» Id
Upper*
Upper Value(*)
VisibilityPublic


 isActive
Public Boolean isActive

This optional property indicates whether this Provider Role record is active.
"Whether this practitioner's record is in active use." - HL7 FHIR, PractitionerRole.active

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProviderRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameisActive
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::isActive
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 notAvailable
Public NotAvailable notAvailable

Pointer to a list of times during which the Individual Provider is not available at the specified location
"The HealthcareService is not available during this period of time due to the provided reason." - HL7 FHIR, PractitionerRole.notAvailable

Constraints:
Properties:

AggregationNone
Alias
AssociationproviderRole_notAvailable
Association End
ClassProviderRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamenotAvailable
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::notAvailable
Stereotype
Template Parameter
TypeNotAvailable
Upper*
Upper Value(*)
VisibilityPublic


 period
Public «IVL_TS» Period period

"The period during which the person is authorized to act as a practitioner in these role(s) for the organization." - HL7 FHIR, PractitionerRole.period

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProviderRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameperiod
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::period
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper1
Upper Value(1)
VisibilityPublic


 providerAffiliation
Public ProviderAffiliation providerAffiliation

In FHIR, the PractitionerRole resource is used to refer to a Provider without knowing in advance which individual will play this role (e.g, I need a Cardiologist that is associated with this hospital, or accepts my plan, etc.). Thus this resource in FHIR points to an optional provider and an optional organization. In FHIM, the association between an IndividualProvider and an OrganizationProvider is handled through the NetworkAffiliation class. Thus, this property is an optional pointer to NetworkAffiliation rather than separate pointers to IndividualProvider and OrganizationProvider.
"Practitioner that is able to provide the defined services for the organization." - HL7 FHIR, PractitionerRole.practitioner
"The organization where the Practitioner performs the roles associated." - HL7 FHIR, PractitionerRole.organization

Constraints:
Properties:

AggregationNone
Alias
AssociationproviderRole_providerAffiliation
Association End
ClassProviderRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameproviderAffiliation
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::providerAffiliation
Stereotype
Template Parameter
TypeProviderAffiliation
Upper1
Upper Value(1)
VisibilityPublic


 roleCode
Public «CS» Code roleCode

"Roles which this practitioner is authorized to perform for the organization." - HL7 FHIR, PractitionerRole.code

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProviderRole
Terminologies[
HL7_FHIR_R4 Practitioner role http://hl7.org/fhir/ValueSet/practitioner-role
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameroleCode
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::roleCode
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 serviceDeliveryLocation
Public ServiceDeliveryLocation serviceDeliveryLocation

Pointer to the Service Delivery Locations with which the Individual Provider is associated due to his/her affiliation to the Practice.
"The location(s) at which this practitioner provides care." - HL7 FHIR, PractitionerRole.location

Constraints:
Properties:

AggregationNone
Alias
AssociationproviderRole_serviceDeliveryLocation
Association End
ClassProviderRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameserviceDeliveryLocation
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::serviceDeliveryLocation
Stereotype
Template Parameter
TypeServiceDeliveryLocation
Upper*
Upper Value(*)
VisibilityPublic


 specialty
Public Specialty specialty

Pointer to the medical Specialty which the Provider is authorized to practice as part of his/her affiliation with the Organizational Provider.
"Specific specialty of the practitioner." - HL7 FHIR, PractitionerRole.specialty

Constraints:
Properties:

AggregationNone
Alias
AssociationproviderRole_specialty
Association End
ClassProviderRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namespecialty
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::specialty
Stereotype
Template Parameter
TypeSpecialty
Upper*
Upper Value(*)
VisibilityPublic


 telecom
Public «TEL» ContactPoint telecom

"Contact details that are specific to the role/location/service." - HL7 FHIR, PractitionerRole.telecom

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassProviderRole
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nametelecom
Name Expression
NamespaceProviderRole
Opposite
OwnerProviderRole
Owning Association
Owning Template Parameter
Qualified NameFHIM::Provider::ProviderRole::telecom
Stereotype
Template Parameter
Type«TEL» ContactPoint
Upper*
Upper Value(*)
VisibilityPublic