This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions

## StructureDefinition: CRD PractitionerRole - Detailed Descriptions

Definitions for the profile-practitionerrole-r4 Profile.

PractitionerRole
Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
Control | 0..*
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If 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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.div.exists())
PractitionerRole.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
PractitionerRole.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
PractitionerRole.implicitRules
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Comments | 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
PractitionerRole.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | A human language. The codes SHOULD be taken from Common Languages
Type | code
Comments | 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).
PractitionerRole.text
Definition | A human-readable narrative that contains a summary of the resource and can 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.
Control | 0..1
Type | Narrative
Alternate Names | narrative, html, xhtml, display
Comments | 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 information is added later.
PractitionerRole.contained
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.
Control | 0..*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
Comments | 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
PractitionerRole.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | 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.
PractitionerRole.modifierExtension
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. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensions, user content
Comments | 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.
PractitionerRole.identifier
Definition | Business Identifiers that are specific to a role/location.
Note | This is a business identifer, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Requirements | Often, specific identities are assigned for the agent.
PractitionerRole.active
Definition | Whether this practitioner role record is in active use.
Control | 0..1
Type | boolean
Requirements | Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.
Comments | If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element
PractitionerRole.period
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
Control | 0..1
Type | Period
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded.
PractitionerRole.practitioner
Definition | Practitioner that is able to provide the defined services for the organization.
Control | 1..1
Type | Reference(CRD Practitioner)
Must Support | true
PractitionerRole.organization
Definition | The organization where the Practitioner performs the roles associated.
Control | 0..1
Type | Reference(CRD Organization)
Must Support | true
PractitionerRole.code
Definition | Roles which this practitioner is authorized to perform for the organization.
Control | 0..*
Binding | The role a person plays representing an organization. For example codes, see PractitionerRole
Type | CodeableConcept
Must Support | true
Requirements | Need to know what authority the practitioner has - what can they do?
Comments | A person may have more than one role.
PractitionerRole.specialty
Definition | Specific specialty of the practitioner.
Control | 0..*
Binding | Specific specialty associated with the agency. The codes SHOULD be taken from PracticeSettingCodeValueSet
Type | CodeableConcept
Must Support | true
PractitionerRole.location
Definition | The location(s) at which this practitioner provides care.
Control | 0..*
Type | Reference(CRD Location)
Must Support | true
PractitionerRole.healthcareService
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s).
Control | 0..*
Type | Reference(HealthcareService)
Must Support | true
PractitionerRole.telecom
Definition | Contact details that are specific to the role/location/service.
Control | 0..*
Type | ContactPoint
Requirements | 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.
PractitionerRole.availableTime
Definition | A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
Control | 0..*
Type | BackboneElement
Comments | More detailed availability information may be provided in associated Schedule/Slot resources.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
PractitionerRole.availableTime.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
PractitionerRole.availableTime.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | 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.
PractitionerRole.availableTime.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensions, user content, modifiers
Comments | 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.
PractitionerRole.availableTime.daysOfWeek
Definition | Indicates which days of the week are available between the start and end Times.
Control | 0..*
Binding | The days of the week. The codes SHALL be taken from DaysOfWeek
Type | code
PractitionerRole.availableTime.allDay
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Control | 0..1
Type | boolean
PractitionerRole.availableTime.availableStartTime
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
Control | 0..1
Type | time
Comments | The timezone is expected to be for where this HealthcareService is provided at.
PractitionerRole.availableTime.availableEndTime
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Control | 0..1
Type | time
Comments | The timezone is expected to be for where this HealthcareService is provided at.
PractitionerRole.notAvailable
Definition | The practitioner is not available or performing this role during this period of time due to the provided reason.
Control | 0..*
Type | BackboneElement
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
PractitionerRole.notAvailable.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
PractitionerRole.notAvailable.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Comments | 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.
PractitionerRole.notAvailable.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Alternate Names | extensions, user content, modifiers
Comments | 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.
PractitionerRole.notAvailable.description
Definition | The reason that can be presented to the user as to why this time is not available.
Control | 1..1
Type | string
PractitionerRole.notAvailable.during
Definition | Service is not available (seasonally or for a public holiday) from this date.
Control | 0..1
Type | Period
PractitionerRole.availabilityExceptions
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.
Control | 0..1
Type | string
PractitionerRole.endpoint
Definition | Technical endpoints providing access to services operated for the practitioner with this role.
Control | 0..*
Type | Reference(Endpoint)
Requirements | 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.