CA Core+ v1.1.0 DFT-preBallot
1.1.0-DFT-preBallot 
DFT-preBallot - The specification is a DFT-preBallot version of CA Core+ for collecting community feedback. For a full list of available versions, see the Directory of published versions
PractitionerRole (CA-Core)
Links
Profile
Derived from
http://hl7.org/fhir/StructureDefinition/PractitionerRole
Examples
example-practitionerrole-ca-core, example-practitionerrole-ca-core-2, example-practitionerrole-ca-core-3
Description
This profile applies constraints to the PractitionerRole resource for CA Core+ to support assignment of providers to roles, specialties, and organizations in the pan-Canadian context.
References to this resource
AllergyIntoleranceCACore, CommunicationCACore, ConditionCACore, DiagnosticReportCACore, DocumentReferenceCACore, EncounterCACore, ExampleProcedureProfile, ImmunizationCACore, ObservationLaboratoryPathologyResultCACore, PatientCACore, ServiceRequestCACore, TaskCACoreeRec
CFMM: 2
Resource Content
| PractitionerRoleCACore (PractitionerRole) | C | PractitionerRole | |
| id | Σ | 0..1 | string |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | O Σ | 0..* | Identifier |
| active | Σ | 0..1 | boolean |
| period | Σ | 0..1 | Period |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| start | Σ C | 0..1 | dateTime |
| end | Σ C | 0..1 | dateTime |
| practitioner | Σ | 0..1 | Reference(PractitionerCACore | Practitioner) |
| organization | Σ | 0..1 | Reference(OrganizationCACore | Organization) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ | 0..1 | Period |
| assigner | Σ | 0..1 | Reference(Organization) |
| display | Σ | 0..1 | string |
| code | Σ | 0..* | CodeableConceptBinding |
| specialty | Σ | 0..* | CodeableConceptBinding |
| location | Σ | 0..* | Reference(Location) |
| healthcareService | 0..* | Reference(HealthcareService) | |
| telecom | Σ | 0..* | ContactPoint |
| availableTime | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| daysOfWeek | 0..* | codeBinding | |
| allDay | 0..1 | boolean | |
| availableStartTime | 0..1 | time | |
| availableEndTime | 0..1 | time | |
| notAvailable | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| description | 1..1 | string | |
| during | 0..1 | Period | |
| availabilityExceptions | 0..1 | string | |
| endpoint | 0..* | Reference(Endpoint) |
| PractitionerRoleCACore (PractitionerRole) | C | PractitionerRole | |
| id | Σ | 0..1 | string |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | O Σ | 0..* | Identifier |
| active | Σ | 0..1 | boolean |
| period | Σ | 0..1 | Period |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| start | Σ C | 0..1 | dateTime |
| end | Σ C | 0..1 | dateTime |
| practitioner | Σ | 0..1 | Reference(PractitionerCACore | Practitioner) |
| organization | Σ | 0..1 | Reference(OrganizationCACore | Organization) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ | 0..1 | Period |
| assigner | Σ | 0..1 | Reference(Organization) |
| display | Σ | 0..1 | string |
| code | Σ | 0..* | CodeableConceptBinding |
| specialty | Σ | 0..* | CodeableConceptBinding |
| location | Σ | 0..* | Reference(Location) |
| healthcareService | 0..* | Reference(HealthcareService) | |
| telecom | Σ | 0..* | ContactPoint |
| availableTime | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| daysOfWeek | 0..* | codeBinding | |
| allDay | 0..1 | boolean | |
| availableStartTime | 0..1 | time | |
| availableEndTime | 0..1 | time | |
| notAvailable | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| description | 1..1 | string | |
| during | 0..1 | Period | |
| availabilityExceptions | 0..1 | string | |
| endpoint | 0..* | Reference(Endpoint) |
</extension>
<url value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core" />
</telecom>
</telecom>
</contact>
<description value="This profile applies constraints to the PractitionerRole resource for CA Core+ to support assignment of providers to roles, specialties, and organizations in the pan-Canadian context." />
</jurisdiction>
<copyright value="Copyright © 2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
</mapping>
<definition value="A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time." />
</base>
<human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" />
</constraint>
<human value="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" />
<expression value="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()" />
<xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))" />
</constraint>
<human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" />
<xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" />
</constraint>
<human value="If a resource is contained in another resource, it SHALL NOT have a security label" />
</constraint>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation">
<valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." />
</extension>
</constraint>
<source value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core" />
</constraint>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</element>
<definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." />
<comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." />
</base>
</extension>
</type>
</element>
<definition value="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." />
</base>
</type>
</constraint>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
<isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" />
</element>
<comment value="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)." />
</base>
</type>
</constraint>
</extension>
</extension>
</extension>
</binding>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</mapping>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<definition value="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 and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="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." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
</base>
</type>
</constraint>
</constraint>
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" />
</mapping>
</element>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</mapping>
</element>
<comment value="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." />
<requirements value="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." />
</base>
</type>
<meaningWhenMissing value="This resource is generally assumed to be active if no value is provided for the active element" />
</constraint>
</mapping>
</mapping>
</mapping>
</element>
<short value="The period during which the practitioner is authorized to perform in these role(s)" />
<definition value="The period during which the person is authorized to act as a practitioner in these role(s) for the organization." />
<requirements value="Even after the agencies is revoked, the fact that it existed must still be recorded." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
<map value="(ServD maps Practitioners and Organizations via another entity, so this concept is not available)" />
</mapping>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
</discriminator>
</slicing>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<comment value="If the low element is missing, the meaning is that the low boundary is not known." />
</base>
</type>
</constraint>
</mapping>
</mapping>
<map value="Health Care Provider-as-Affiliate Type.Health Care Provider-as-Affiliate Type Effective Date" />
</mapping>
</element>
<definition value="The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time." />
<comment value="The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03." />
</base>
</type>
<meaningWhenMissing value="If the end of the period is missing, it means that the period is ongoing" />
</constraint>
</mapping>
</mapping>
<map value="Health Care Provider-as-Affiliate Type.Health Care Provider-as-Affiliate Type Expiry Date" />
</mapping>
</element>
<definition value="Practitioner that is able to provide the defined services for the organization." />
<comment value="pCHDCF modelling for care team concepts (including provider/practitionerRole/organization linking) is still underway. The requirements to support a linkage to provider details on practitionerRole for various use cases is still undefined. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF." />
</base>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core" />
</type>
</constraint>
</mapping>
</element>
<comment value="pCHDCF modelling for care team concepts (including provider/practitionerRole/organization linking) is still underway. The requirements to support a linkage to organization details on practitionerRole for various use cases is still undefined. For this reason, application of obligations and further constraints towards this element are not currently expressed in this profile. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF." />
</base>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core" />
</type>
</constraint>
</mapping>
</mapping>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
</discriminator>
</slicing>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<definition value="A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources." />
<comment value="Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources)." />
<comment value="This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified." />
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</element>
<definition value="An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference." />
<comment value="When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any)." />
</base>
</type>
</constraint>
</mapping>
<map value="Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Employee Identifier" />
</mapping>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
</discriminator>
</slicing>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<comment value="Applications can assume that an identifier is permanent unless it explicitly says that it is temporary." />
<requirements value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers." />
</base>
</type>
</constraint>
<isModifierReason value="This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one." />
</extension>
</binding>
</mapping>
</mapping>
</element>
<definition value="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose." />
<comment value="This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type." />
<requirements value="Allows users to make use of identifiers when the identifier system is not known." />
</base>
</type>
</constraint>
</extension>
</extension>
<description value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose." />
</binding>
</mapping>
</mapping>
</element>
<definition value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique." />
<requirements value="There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers." />
</base>
</type>
</example>
</constraint>
</mapping>
</mapping>
</mapping>
</element>
<definition value="The portion of the identifier typically relevant to the user and which is unique within the context of the system." />
<comment value="If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe." />
</base>
</type>
</example>
</constraint>
</mapping>
<map value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" />
</mapping>
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
<map value="Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Effective Date" />
</mapping>
<map value="Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Expiry Date" />
</mapping>
</element>
<comment value="The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization." />
</base>
</type>
</constraint>
</mapping>
<map value="II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" />
</mapping>
</mapping>
</element>
</extension>
<definition value="Plain text narrative that identifies the resource in addition to the resource reference." />
<comment value="This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it." />
</base>
</type>
</constraint>
</mapping>
</element>
<comment value="pCHDCF modelling for care team concepts is still underway. The requirements to support specialty and expertise details on practitionerRole for various use cases are still undefined. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF." />
</base>
</type>
</constraint>
</extension>
</binding>
<map value="PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17" />
</mapping>
</mapping>
<map value="(ServD maps Practitioners and Organizations via another entity, so this concept is not available)" />
</mapping>
</mapping>
</element>
<comment value="pCHDCF modelling for care team concepts is still underway. The requirements to support specialty and expertise details on practitionerRole for various use cases are still undefined. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF." />
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</mapping>
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</mapping>
<map value="(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)" />
</mapping>
</mapping>
</element>
<short value="The list of healthcare services that this worker provides for this role's Organization/Location(s)" />
<definition value="The list of healthcare services that this worker provides for this role's Organization/Location(s)." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</element>
<comment value="Although the provider phone number and provider email concepts are expressed in the pCHDCF materials, their current definition does not distinctly identify the resource target(s) where it has to be applied (e.g., Practitioner vs PractitionerRole). Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients." />
<requirements value="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." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="A collection of times the practitioner is available or performing this role at the location and/or healthcareservice." />
<comment value="More detailed availability information may be provided in associated Schedule/Slot resources." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<definition value="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 and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="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." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
</base>
</type>
</constraint>
</constraint>
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
</mapping>
</element>
<definition value="Indicates which days of the week are available between the start and end Times." />
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="The opening time of day. Note: If the AllDay flag is set, then this time is ignored." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="The closing time of day. Note: If the AllDay flag is set, then this time is ignored." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="The practitioner is not available or performing this role during this period of time due to the provided reason." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<definition value="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 and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="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." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." />
</base>
</type>
</constraint>
</constraint>
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
</mapping>
</element>
<definition value="The reason that can be presented to the user as to why this time is not available." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="Service is not available (seasonally or for a public holiday) from this date." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="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." />
</base>
</type>
</constraint>
</mapping>
</element>
<short value="Technical endpoints providing access to services operated for the practitioner with this role" />
<definition value="Technical endpoints providing access to services operated for the practitioner with this role." />
<requirements value="Organizations have multiple systems that provide various services and ,ay also be different for practitioners too.\n\nSo the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose." />
</base>
</type>
</constraint>
</mapping>
</element>
</snapshot>
<source value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core" />
</constraint>
</mapping>
</element>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</element>
<map value="Health Care Provider-as-Affiliate Type.Health Care Provider-as-Affiliate Type Effective Date" />
</mapping>
</element>
<map value="Health Care Provider-as-Affiliate Type.Health Care Provider-as-Affiliate Type Expiry Date" />
</mapping>
</element>
<comment value="pCHDCF modelling for care team concepts (including provider/practitionerRole/organization linking) is still underway. The requirements to support a linkage to provider details on practitionerRole for various use cases is still undefined. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF." />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core" />
</type>
</element>
<comment value="pCHDCF modelling for care team concepts (including provider/practitionerRole/organization linking) is still underway. The requirements to support a linkage to organization details on practitionerRole for various use cases is still undefined. For this reason, application of obligations and further constraints towards this element are not currently expressed in this profile. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF." />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core" />
</type>
</mapping>
</element>
<map value="Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Employee Identifier" />
</mapping>
</element>
<map value="Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Effective Date" />
</mapping>
<map value="Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Expiry Date" />
</mapping>
</element>
<comment value="pCHDCF modelling for care team concepts is still underway. The requirements to support specialty and expertise details on practitionerRole for various use cases are still undefined. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF." />
</binding>
</mapping>
</element>
<comment value="pCHDCF modelling for care team concepts is still underway. The requirements to support specialty and expertise details on practitionerRole for various use cases are still undefined. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF." />
</binding>
</element>
</mapping>
</element>
<comment value="Although the provider phone number and provider email concepts are expressed in the pCHDCF materials, their current definition does not distinctly identify the resource target(s) where it has to be applied (e.g., Practitioner vs PractitionerRole). Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients." />
</element>
</differential>
</StructureDefinition>
{
],
{
{
},
{
}
]
}
],
"description": "This profile applies constraints to the PractitionerRole resource for CA Core+ to support assignment of providers to roles, specialties, and organizations in the pan-Canadian context.",
],
"copyright": "Copyright © 2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
],
{
"definition": "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.",
},
{
},
{
"human": "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",
"expression": "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()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
},
{
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
},
{
},
{
{
},
{
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
},
{
}
],
{
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
},
{
{
}
],
}
],
},
{
"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.",
},
],
{
}
],
},
{
"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.",
"comment": "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.",
},
],
{
}
],
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
},
{
"comment": "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).",
},
],
{
}
],
{
},
{
},
{
}
],
}
},
{
"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.",
"comment": "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.",
"narrative",
"html",
"xhtml",
"display"
],
},
],
{
}
],
]
},
{
"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.",
"comment": "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.",
"inline resources",
"anonymous resources",
"contained resources"
],
},
],
]
},
{
"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.",
"comment": "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.",
"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 and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"extensions",
"user content"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
]
},
{
{
{
},
{
}
],
},
{
{
},
{
}
],
}
],
},
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"comment": "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.",
"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.",
},
],
"meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element",
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.",
"requirements": "Even after the agencies is revoked, the fact that it existed must still be recorded.",
},
],
{
}
],
{
},
{
},
{
},
{
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
},
],
"per-1"
],
{
}
],
{
},
{
},
{
"map": "Health Care Provider-as-Affiliate Type.Health Care Provider-as-Affiliate Type Effective Date"
}
]
},
{
"definition": "The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.",
},
],
"per-1"
],
{
}
],
{
},
{
},
{
}
]
},
{
"comment": "pCHDCF modelling for care team concepts (including provider/practitionerRole/organization linking) is still underway. The requirements to support a linkage to provider details on practitionerRole for various use cases is still undefined. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF.",
},
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core",
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
{
}
],
]
},
{
"comment": "pCHDCF modelling for care team concepts (including provider/practitionerRole/organization linking) is still underway. The requirements to support a linkage to organization details on practitionerRole for various use cases is still undefined. For this reason, application of obligations and further constraints towards this element are not currently expressed in this profile. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF.",
},
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core",
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
{
}
],
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
},
],
"ref-1"
],
{
}
],
]
},
{
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
},
],
{
}
],
{
}
],
},
]
},
{
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
},
],
{
}
],
{
},
{
"map": "Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Employee Identifier"
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
},
],
{
}
],
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
{
}
],
},
]
},
{
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
},
],
{
}
],
{
},
{
}
],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
},
{
},
{
}
]
},
{
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
},
],
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
},
],
],
{
}
],
{
},
{
},
{
}
]
},
{
},
],
{
}
],
{
},
{
},
{
},
{
"map": "Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Effective Date"
},
{
"map": "Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Expiry Date"
}
]
},
{
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
},
{
}
],
{
}
],
{
},
{
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
}
]
},
{
{
}
],
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
},
],
{
}
],
]
},
{
"comment": "pCHDCF modelling for care team concepts is still underway. The requirements to support specialty and expertise details on practitionerRole for various use cases are still undefined. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF.",
},
],
{
}
],
{
}
],
},
{
},
{
},
{
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
},
{
}
]
},
{
"comment": "pCHDCF modelling for care team concepts is still underway. The requirements to support specialty and expertise details on practitionerRole for various use cases are still undefined. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF.",
},
],
{
}
],
{
}
],
},
{
},
{
},
{
}
]
},
{
},
],
{
}
],
{
},
{
},
{
"map": "(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)"
},
{
}
]
},
{
"short": "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).",
},
{
"http://hl7.org/fhir/StructureDefinition/HealthcareService"
]
}
],
{
}
],
{
},
{
}
]
},
{
"comment": "Although the provider phone number and provider email concepts are expressed in the pCHDCF materials, their current definition does not distinctly identify the resource target(s) where it has to be applied (e.g., Practitioner vs PractitionerRole). Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients.",
"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.",
},
],
{
}
],
]
},
{
"definition": "A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.",
"comment": "More detailed availability information may be provided in associated Schedule/Slot resources.",
},
],
{
}
],
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
"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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"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 and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
},
],
{
}
],
{
}
],
},
]
},
{
},
],
{
}
],
]
},
{
"definition": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.",
},
],
{
}
],
]
},
{
"definition": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.",
},
],
{
}
],
]
},
{
"definition": "The practitioner is not available or performing this role during this period of time due to the provided reason.",
},
],
{
}
],
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
"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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"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 and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
},
],
{
}
],
]
},
{
},
],
{
}
],
]
},
{
"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.",
},
],
{
}
],
]
},
{
"short": "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.",
"requirements": "Organizations have multiple systems that provide various services and ,ay also be different for practitioners too.\n\nSo the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.",
},
],
{
}
],
]
}
]
},
{
{
}
],
]
},
{
{
{
},
{
}
],
},
{
{
},
{
}
],
}
],
},
{
{
"map": "Health Care Provider-as-Affiliate Type.Health Care Provider-as-Affiliate Type Effective Date"
}
]
},
{
{
}
]
},
{
"comment": "pCHDCF modelling for care team concepts (including provider/practitionerRole/organization linking) is still underway. The requirements to support a linkage to provider details on practitionerRole for various use cases is still undefined. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF.",
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core",
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
]
},
{
"comment": "pCHDCF modelling for care team concepts (including provider/practitionerRole/organization linking) is still underway. The requirements to support a linkage to organization details on practitionerRole for various use cases is still undefined. For this reason, application of obligations and further constraints towards this element are not currently expressed in this profile. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF.",
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core",
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
]
},
{
{
"map": "Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Employee Identifier"
}
]
},
{
{
"map": "Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Effective Date"
},
{
"map": "Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Expiry Date"
}
]
},
{
"comment": "pCHDCF modelling for care team concepts is still underway. The requirements to support specialty and expertise details on practitionerRole for various use cases are still undefined. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF.",
},
]
},
{
"comment": "pCHDCF modelling for care team concepts is still underway. The requirements to support specialty and expertise details on practitionerRole for various use cases are still undefined. Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients. The profile will continue to evolve as care team details undergo data modelling in the pCHDCF.",
}
},
{
]
},
{
"comment": "Although the provider phone number and provider email concepts are expressed in the pCHDCF materials, their current definition does not distinctly identify the resource target(s) where it has to be applied (e.g., Practitioner vs PractitionerRole). Reviewers are encouraged to provide feedback on the potential impact of applying a 'no-error' obligation on this element for clients."
}
]
}
}
Terminology bindings
| Path | Conformance | ValueSet |
|---|---|---|
| PractitionerRole.code | preferred | https://fhir.infoway-inforoute.ca/ValueSet/healthcareproviderrolecode |
| PractitionerRole.specialty | preferred | https://fhir.infoway-inforoute.ca/ValueSet/healthcareproviderspecialtycode |
Additional Terminology Bindings
These bindings may be used in lieu of the primary bindings in the table above.
Mappings to CACDI
The following tables list how the data elements from CA Core+ map to CACDI. For more information visit Mapping Logic.
| FHIR Profile Element | CACDI Element(s) |
|---|---|
| PractitionerRole | Health Care Provider-as-Affiliate Type |
| PractitionerRole.period.start | Health Care Provider-as-Affiliate Type.Health Care Provider-as-Affiliate Type Effective Date |
| PractitionerRole.period.end | Health Care Provider-as-Affiliate Type.Health Care Provider-as-Affiliate Type Expiry Date |
| PractitionerRole.organization | Health Care Provider Organization Affiliation |
| PractitionerRole.organization.identifier | Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Employee Identifier |
| PractitionerRole.organization.identifier.period | Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Effective Date, Health Care Provider Organization Affiliation.Health Care Provider Organization Affiliation Expiry Date |
| PractitionerRole.code | Health Care Provider Type |
| PractitionerRole.location | Health Care Provider Organization Location Affiliation |