|
| Provider UML Documentation |
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 |
"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 |
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 |
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 |
"The list of healthcare services that this worker provides for this role's Organization/Location(s)." - HL7 FHIR, PractitionerRole.healthcareService
|
| «II» Id | identifier |
"Business Identifiers that are specific to a role/location." - HL7 FHIR, PractitionerRole.identifier
|
| 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
|
| 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 |
"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 |
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 |
"Roles which this practitioner is authorized to perform for the organization." - HL7 FHIR, PractitionerRole.code
|
| 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 |
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 |
"Contact details that are specific to the role/location/service." - HL7 FHIR, PractitionerRole.telecom
|
Properties:
| Alias | |
| Classifier Behavior | |
| Is Abstract | false |
| Is Active | false |
| Is Leaf | false |
| Keywords | |
| Name | ProviderRole |
| Name Expression | |
| Namespace | Provider |
| Owned Template Signature | |
| Owner | Provider |
| Owning Template Parameter | |
| Package | Provider |
| Qualified Name | FHIM::Provider::ProviderRole |
| Representation | |
| Stereotype | |
| Template Parameter | |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | ProviderRole |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | availabilityExceptions |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::availabilityExceptions |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | providerRole_availableTime |
| Association End | |
| Class | ProviderRole |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | * |
| Name | availableTime |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::availableTime |
| Stereotype | |
| Template Parameter | |
| Type | AvailableTime |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | providerRole_endPoint |
| Association End | |
| Class | ProviderRole |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | * |
| Name | endpoint |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::endpoint |
| Stereotype | |
| Template Parameter | |
| Type | ElectronicServiceEndpoint |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | providerRole_healthcareService |
| Association End | |
| Class | ProviderRole |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | * |
| Name | healthcareService |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::healthcareService |
| Stereotype | |
| Template Parameter | |
| Type | HealthcareService |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
identifier
Public «II» Id identifier
-
"Business Identifiers that are specific to a role/location." - HL7 FHIR, PractitionerRole.identifier
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | ProviderRole |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | * |
| Name | identifier |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::identifier |
| Stereotype | |
| Template Parameter | |
| Type | «II» Id |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | ProviderRole |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | isActive |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::isActive |
| Stereotype | |
| Template Parameter | |
| Type | Boolean |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | providerRole_notAvailable |
| Association End | |
| Class | ProviderRole |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | * |
| Name | notAvailable |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::notAvailable |
| Stereotype | |
| Template Parameter | |
| Type | NotAvailable |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | ProviderRole |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | period |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::period |
| Stereotype | |
| Template Parameter | |
| Type | «IVL_TS» Period |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | providerRole_providerAffiliation |
| Association End | |
| Class | ProviderRole |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | providerAffiliation |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::providerAffiliation |
| Stereotype | |
| Template Parameter | |
| Type | ProviderAffiliation |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
roleCode
Public «CS» Code roleCode
-
"Roles which this practitioner is authorized to perform for the organization." - HL7 FHIR, PractitionerRole.code
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | ProviderRole |
| Terminologies | [
HL7_FHIR_R4 Practitioner role http://hl7.org/fhir/ValueSet/practitioner-role
] |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | 0..1 |
| Name | roleCode |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::roleCode |
| Stereotype | ValueSetConstraints |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | providerRole_serviceDeliveryLocation |
| Association End | |
| Class | ProviderRole |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | * |
| Name | serviceDeliveryLocation |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::serviceDeliveryLocation |
| Stereotype | |
| Template Parameter | |
| Type | ServiceDeliveryLocation |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
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:
-
| Aggregation | None |
| Alias | |
| Association | providerRole_specialty |
| Association End | |
| Class | ProviderRole |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | * |
| Name | specialty |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::specialty |
| Stereotype | |
| Template Parameter | |
| Type | Specialty |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
telecom
Public «TEL» ContactPoint telecom
-
"Contact details that are specific to the role/location/service." - HL7 FHIR, PractitionerRole.telecom
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | ProviderRole |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | false |
| Is Derived Union | false |
| Is Leaf | false |
| Is Ordered | false |
| Is Read Only | false |
| Is Static | false |
| Is Unique | true |
| Keywords | |
| Lower | 0 |
| Lower Value | (0) |
| Multiplicity | * |
| Name | telecom |
| Name Expression | |
| Namespace | ProviderRole |
| Opposite | |
| Owner | ProviderRole |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Provider::ProviderRole::telecom |
| Stereotype | |
| Template Parameter | |
| Type | «TEL» ContactPoint |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
|
| Provider UML Documentation |