| PractitionerRole | I | | http://hl7.org/fhir/StructureDefinition/DomainResource | Element idShort description Roles/organizations the practitioner is associated with Definition A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
http://hl7.org/fhir/StructureDefinition/DomainResource Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.empty() - dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
- rim: Entity. Role, or Act
- v2: PRD (as one example)
- rim: Role
- servd: ServiceSiteProvider
- w5: administrative.individual
|
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idShort description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
id |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idShort description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Meta |
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPractitionerRole.implicitRules A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
uri |
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitionerRole.language Language of the resource content Definition The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
code Binding A human language. ?? (extensible) |
| text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idShort description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
Narrative Mappings |
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idPractitionerRole.contained Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
Resource Mappings |
| extension | | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension Additional Content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings |
| modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.modifierExtension Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings |
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPractitionerRole.identifier Business Identifiers that are specific to a role/location Definition Business Identifiers that are specific to a role/location.
Often, specific identities are assigned for the agent.
Identifier Mappings- v2: PRD-7 (or XCN.1)
- rim: .id
- servd: ./Identifiers
- w5: id
|
| active | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idShort description Whether this practitioner's record is in active use Definition Whether this practitioner's record is in active use.
Need to be able to mark a practitioner record as not to be used because it was created in error.
Default is true.
If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.
boolean Default value Mappings- v2: STF-7
- rim: .statusCode
- w5: status
|
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idShort description The period during which the practitioner is authorized to perform in these role(s) Definition The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
Even after the agencies is revoked, the fact that it existed must still be recorded.
Period Mappings- v2: PRD-8/9 / PRA-5.4
- rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime
- servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)
- w5: when.done
|
| practitioner | Σ | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Practitioner) | There are no (further) constraints on this element Element idPractitionerRole.practitioner Practitioner that is able to provide the defined services for the organation Definition Practitioner that is able to provide the defined services for the organation.
Reference(http://hl7.org/fhir/StructureDefinition/Practitioner) Mappings |
| organization | Σ | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Organization) | There are no (further) constraints on this element Element idPractitionerRole.organization Organization where the roles are available Definition The organization where the Practitioner performs the roles associated.
Reference(http://hl7.org/fhir/StructureDefinition/Organization) Mappings |
| code | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idShort description Roles which this practitioner may perform Definition Roles which this practitioner is authorized to perform for the organization.
Need to know what authority the practitioner has - what can they do?
A person may have more than one role. At least one role is required.
CodeableConcept Binding The role a person plays representing an organization ?? (example)Mappings- v2: PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17
- rim: .code
- servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)
|
| specialty | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitionerRole.specialty Specific specialty of the practitioner Definition Specific specialty of the practitioner.
CodeableConcept Binding Specific specialty associated with the agency ?? (preferred)Mappings- v2: PRA-5
- rim: .player.HealthCareProvider[@classCode = 'PROV'].code
- servd: ./Specialty
|
| location | Σ | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/Location) | There are no (further) constraints on this element Element idPractitionerRole.location The location(s) at which this practitioner provides care Definition The location(s) at which this practitioner provides care.
Reference(http://hl7.org/fhir/StructureDefinition/Location) Mappings- rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']
- servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)
- w5: where
|
| healthcareService | | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/HealthcareService) | There are no (further) constraints on this element Element idPractitionerRole.healthcareService The list of healthcare services that this worker provides for this role's Organization/Location(s) Definition The list of healthcare services that this worker provides for this role's Organization/Location(s).
Reference(http://hl7.org/fhir/StructureDefinition/HealthcareService) Mappings- v2: EDU-2 / AFF-3
- rim: .player.QualifiedEntity[@classCode = 'QUAL'].code
|
| telecom | Σ | 0..* | ContactPoint | There are no (further) constraints on this element Element idShort description Contact details that are specific to the role/location/service Definition Contact details that are specific to the role/location/service.
Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.
ContactPoint Mappings |
| availableTime | | 0..* | BackboneElement | There are no (further) constraints on this element Element idPractitionerRole.availableTime Times the Service Site is available Definition A collection of times that the Service Site is available.
More detailed availability information may be provided in associated Schedule/Slot resources.
BackboneElement Mappings |
| notAvailable | | 0..* | BackboneElement | There are no (further) constraints on this element Element idPractitionerRole.notAvailable Not available during this time due to provided reason Definition The HealthcareService is not available during this period of time due to the provided reason.
BackboneElement Mappings |
| availabilityExceptions | | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.availabilityExceptions Description of availability exceptions Definition 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.
string Mappings |
| endpoint | | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/Endpoint) | There are no (further) constraints on this element Element idPractitionerRole.endpoint Technical endpoints providing access to services operated for the practitioner with this role Definition Technical endpoints providing access to services operated for the practitioner with this role.
Organizations have multiple systems that provide various services and ,ay also be different for practitioners too.
So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.
Reference(http://hl7.org/fhir/StructureDefinition/Endpoint) Mappings |