Visit the HL7 website
Visit the FHIR website

Pan-Canadian Patient Summary (PS-CA) CI Build

current   Canada flag
  • Index
  • Home
  • Business Context
    • Use Cases
    • Requirements
    • Privacy and Security Guidance
    • Relationship to Other Specifications
  • Technical Context
    • Overview
    • Sequence Diagrams
    • Core Interoperability Specification Requirements
    • Conformance and Specification Guidance
    • General Principles & Design
  • FHIR Artifacts
    • FHIR Artifacts
    • PS-CA Library of Profiles
    • Bundle (PS-CA)
    • Composition (PS-CA)
    • Patient (PS-CA)
    • Medication (PS-CA)
    • MedicationRequest (PS-CA)
    • MedicationStatement (PS-CA)
    • AllergyIntolerance (PS-CA)
    • Condition (PS-CA)
    • Procedure (PS-CA)
    • Immunization (PS-CA)
    • DiagnosticReport (PS-CA)
    • ImagingStudy (PS-CA)
    • Organization-Lab (PS-CA)
    • Practitioner-Lab (PS-CA)
    • PractitionerRole-Lab (PS-CA)
    • Observation Laboratory/Pathology (PS-CA)
    • Observation Radiology (PS-CA)
    • Observation Social History (PS-CA)
    • Observation Alcohol Use (PS-CA)
    • Observation Tobacco Use (PS-CA)
    • Family Member History (PS-CA)
    • Data Type Profiles
    • Extensions
    • Examples
    • Terminology
    • Downloads
  • Change Log
    1. Index
    2. FHIR Artifacts
    3. PractitionerRole-Lab (PS-CA)

CI Build - For a full list of available versions, see the Directory of published versions

PractitionerRole-Lab (PS-CA)

Links

Profile

practitionerrole-lab-ca-ps

Derived from

http://hl7.org/fhir/StructureDefinition/PractitionerRole

Examples

Description

This profile represents the constraints applied to the PractitionerRole resource by the PS-CA project to represent a practitioner in a role acting as an observer for observation results for a specified organization. It is informed by the constraints of the PractitionerRole IPS-UV profile and the Canadian Baseline Profile to allow for cross-border and cross-jurisdiction sharing of details that support Diagnostic Result Information.

References to this resource

DiagnosticReportPSCA, ObservationResultsLaboratoryPathologyPSCA, ObservationResultsRadiologyPSCA

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
PractitionerRoleLabPSCA (PractitionerRole)CPractitionerRole
There are no (further) constraints on this element
Element id
PractitionerRole
Short description

Roles/organizations the practitioner is associated with

Definition

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Data type

PractitionerRole

Constraints
  • 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()
Mappings
  • rim: Entity. Role, or Act
  • v2: PRD (as one example)
  • rim: Role
  • servd: ServiceSiteProvider
idΣ0..1string
There are no (further) constraints on this element
Element id
PractitionerRole.id
Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

Data type

string

metaΣ0..1Meta
There are no (further) constraints on this element
Element id
PractitionerRole.meta
Short description

Metadata about the resource

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.

Data type

Meta

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
PractitionerRole.implicitRules
Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
language0..1codeBinding
There are no (further) constraints on this element
Element id
PractitionerRole.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

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).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
text0..1Narrative
There are no (further) constraints on this element
Element id
PractitionerRole.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and 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.

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.

Data type

Narrative

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
PractitionerRole.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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.

Data type

Resource

Mappings
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
PractitionerRole.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. 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.

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.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
modifierExtension?! C0..*Extension
There are no (further) constraints on this element
Element id
PractitionerRole.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
identifierΣ0..*IdentifierCABaselineElement id
PractitionerRole.identifier
Short description

An identifier intended for computation

Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Requirements

Often, specific identities are assigned for the agent.

Data type

IdentifierCABaseline

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: PRD-7 (or XCN.1)
  • rim: .id
  • servd: ./Identifiers
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
activeΣ0..1boolean
There are no (further) constraints on this element
Element id
PractitionerRole.active
Short description

Whether this practitioner role record is in active use

Definition

Whether this practitioner role record is in active use.

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 when missing

This resource is generally assumed to be active if no value is provided for the active element

Data type

boolean

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • v2: STF-7
  • rim: .statusCode
periodΣ0..1Period
There are no (further) constraints on this element
Element id
PractitionerRole.period
Short description

The period during which the practitioner is authorized to perform in these role(s)

Definition

The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

Requirements

Even after the agencies is revoked, the fact that it existed must still be recorded.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.done[x]
  • v2: PRD-8/9 / PRA-5.4
  • rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime
  • servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)
practitionerΣ0..1Reference(PractitionerLabPSCA)Element id
PractitionerRole.practitioner
Short description

Practitioner that is able to provide the defined services for the organization

Definition

Practitioner that is able to provide the defined services for the organization.

Data type

Reference(PractitionerLabPSCA)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .player
organizationΣ0..1Reference(OrganizationLabPSCA)Element id
PractitionerRole.organization
Short description

Organization where the roles are available

Definition

The organization where the Practitioner performs the roles associated.

Comments

While IPS-UV considers PractitionerRole.organization a Must Support element, a number of jurisdictional systems may not capture the organization the practitioner is performing that role for, in the scope of a practitioner that is the performer of an observation or diagnostic report. Further feedback is required on whether these systems are still expected to be able to demonstrate they can construct this element when developing a patient summary instance that includes diagnostic result information.

Data type

Reference(OrganizationLabPSCA)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .scoper
codeΣ0..*CodeableConceptPSCABindingElement id
PractitionerRole.code
Short description

Concept - reference to a terminology or just text

Definition

Roles which this practitioner is authorized to perform for the organization.

Requirements

Need to know what authority the practitioner has - what can they do?

Comments

For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text.

Data type

CodeableConceptPSCA

Binding

A role type that is used to categorize an entity that delivers health care in an expected and professional manner to an entity in need of health care services. Examples: Registered Nurse, Chiropractor, Physician, Custodial Care Clinic.

HealthcareProviderRoleType (preferred)

Additional bindings
  • HealthcareProfessionalRolesUvIps (candidate)

    Healthcare professional role codes from International Standard Classification of Occupations (ISCO) utilized in IPS. While not the preferred terminology for broader pan-Canadian exchange use cases, this additional binding is surfaced to socialize the value sets that are proposed for international exchange in IPS. Where multiple codings can be supplied, it is encouraged to supply the original coding alongside the pan-Canadian preferred terminology.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17
  • rim: .code
  • servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
specialtyΣ0..*CodeableConceptElement id
PractitionerRole.specialty
Short description

PractitionerSpecialty

Definition

Specific specialty of the practitioner.

Comments

Work is underway to define the pan-Canadian terminology that will be preferred and/or socialized for PractitionerRole.specialty

Data type

CodeableConcept

Binding

Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient.

PractitionerSpecialty (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PRA-5
  • rim: .player.HealthCareProvider[@classCode = 'PROV'].code
  • servd: ./Specialty
locationΣ0..*Reference(Location)
There are no (further) constraints on this element
Element id
PractitionerRole.location
Short description

The location(s) at which this practitioner provides care

Definition

The location(s) at which this practitioner provides care.

Data type

Reference(Location)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.where[x]
  • rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']
  • servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)
healthcareService0..*Reference(HealthcareService)
There are no (further) constraints on this element
Element id
PractitionerRole.healthcareService
Short description

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).

Data type

Reference(HealthcareService)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: EDU-2 / AFF-3
  • rim: .player.QualifiedEntity[@classCode = 'QUAL'].code
telecomΣ0..*ContactPoint
There are no (further) constraints on this element
Element id
PractitionerRole.telecom
Short description

Contact details that are specific to the role/location/service

Definition

Contact details that are specific to the role/location/service.

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.

Data type

ContactPoint

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .telecom
availableTime0..*BackboneElement
There are no (further) constraints on this element
Element id
PractitionerRole.availableTime
Short description

Times the Service Site is available

Definition

A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

Comments

More detailed availability information may be provided in associated Schedule/Slot resources.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
id0..1string
There are no (further) constraints on this element
Element id
PractitionerRole.availableTime.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
PractitionerRole.availableTime.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the 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.

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.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
PractitionerRole.availableTime.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
daysOfWeek0..*codeBinding
There are no (further) constraints on this element
Element id
PractitionerRole.availableTime.daysOfWeek
Short description

mon | tue | wed | thu | fri | sat | sun

Definition

Indicates which days of the week are available between the start and end Times.

Data type

code

Binding

The days of the week.

DaysOfWeek (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
allDay0..1boolean
There are no (further) constraints on this element
Element id
PractitionerRole.availableTime.allDay
Short description

Always available? e.g. 24 hour service

Definition

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

Data type

boolean

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
availableStartTime0..1time
There are no (further) constraints on this element
Element id
PractitionerRole.availableTime.availableStartTime
Short description

Opening time of day (ignored if allDay = true)

Definition

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

Comments

The timezone is expected to be for where this HealthcareService is provided at.

Data type

time

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
availableEndTime0..1time
There are no (further) constraints on this element
Element id
PractitionerRole.availableTime.availableEndTime
Short description

Closing time of day (ignored if allDay = true)

Definition

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

Comments

The timezone is expected to be for where this HealthcareService is provided at.

Data type

time

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
notAvailable0..*BackboneElement
There are no (further) constraints on this element
Element id
PractitionerRole.notAvailable
Short description

Not available during this time due to provided reason

Definition

The practitioner is not available or performing this role during this period of time due to the provided reason.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
id0..1string
There are no (further) constraints on this element
Element id
PractitionerRole.notAvailable.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
PractitionerRole.notAvailable.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the 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.

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.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
PractitionerRole.notAvailable.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
description1..1string
There are no (further) constraints on this element
Element id
PractitionerRole.notAvailable.description
Short description

Reason presented to the user explaining why time not available

Definition

The reason that can be presented to the user as to why this time is not available.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
during0..1Period
There are no (further) constraints on this element
Element id
PractitionerRole.notAvailable.during
Short description

Service not available from this date

Definition

Service is not available (seasonally or for a public holiday) from this date.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
availabilityExceptions0..1string
There are no (further) constraints on this element
Element id
PractitionerRole.availabilityExceptions
Short description

Description of availability exceptions

Definition

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

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime
endpoint0..*Reference(Endpoint)
There are no (further) constraints on this element
Element id
PractitionerRole.endpoint
Short description

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.

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.

Data type

Reference(Endpoint)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
PractitionerRoleLabPSCA (PractitionerRole)PractitionerRole
There are no (further) constraints on this element
Data type

PractitionerRole

identifierIdentifierCABaseline
There are no (further) constraints on this element
Element id
PractitionerRole.identifier
Data type

IdentifierCABaseline

practitionerReference(PractitionerLabPSCA)
There are no (further) constraints on this element
Element id
PractitionerRole.practitioner
Data type

Reference(PractitionerLabPSCA)

organizationReference(OrganizationLabPSCA)
There are no (further) constraints on this element
Element id
PractitionerRole.organization
Comments

While IPS-UV considers PractitionerRole.organization a Must Support element, a number of jurisdictional systems may not capture the organization the practitioner is performing that role for, in the scope of a practitioner that is the performer of an observation or diagnostic report. Further feedback is required on whether these systems are still expected to be able to demonstrate they can construct this element when developing a patient summary instance that includes diagnostic result information.

Data type

Reference(OrganizationLabPSCA)

codeCodeableConceptPSCABinding
There are no (further) constraints on this element
Element id
PractitionerRole.code
Definition

Roles which this practitioner is authorized to perform for the organization.

Data type

CodeableConceptPSCA

Binding

A role type that is used to categorize an entity that delivers health care in an expected and professional manner to an entity in need of health care services. Examples: Registered Nurse, Chiropractor, Physician, Custodial Care Clinic.

HealthcareProviderRoleType (preferred)

Additional bindings
  • HealthcareProfessionalRolesUvIps (candidate)

    Healthcare professional role codes from International Standard Classification of Occupations (ISCO) utilized in IPS. While not the preferred terminology for broader pan-Canadian exchange use cases, this additional binding is surfaced to socialize the value sets that are proposed for international exchange in IPS. Where multiple codings can be supplied, it is encouraged to supply the original coding alongside the pan-Canadian preferred terminology.

specialty
There are no (further) constraints on this element
Element id
PractitionerRole.specialty
Short description

PractitionerSpecialty

Comments

Work is underway to define the pan-Canadian terminology that will be preferred and/or socialized for PractitionerRole.specialty

Binding

Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient.

PractitionerSpecialty (example)

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="practitionerrole-lab-ca-ps" />
<url value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/practitionerrole-lab-ca-ps" />
<name value="PractitionerRoleLabPSCA" />
<title value="PractitionerRole - Lab (PS-CA)" />
<status value="draft" />
<experimental value="false" />
<date value="2023-12-06T00:00:00-08:00" />
<description value="This profile represents the constraints applied to the PractitionerRole resource by the PS-CA project to represent a practitioner in a role acting as an observer for observation results for a specified organization. It is informed by the constraints of the [PractitionerRole IPS-UV profile](http://hl7.org/fhir/uv/ips/StructureDefinition-PractitionerRole-uv-ips.html) and the [Canadian Baseline Profile](http://build.fhir.org/ig/HL7-Canada/ca-baseline/branches/master/StructureDefinition-profile-practitionerrole.html) to allow for cross-border and cross-jurisdiction sharing of details that support Diagnostic Result Information." />
<copyright value="Copyright © 2024+ 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)." />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="PractitionerRole" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" />
<derivation value="constraint" />
<differential>
<element id="PractitionerRole.identifier">
<path value="PractitionerRole.identifier" />
<type>
<code value="Identifier" />
<profile value="http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-identifier" />
</type>
</element>
<element id="PractitionerRole.practitioner">
<path value="PractitionerRole.practitioner" />
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/practitioner-lab-ca-ps" />
</type>
</element>
<element id="PractitionerRole.organization">
<path value="PractitionerRole.organization" />
<comment value="While IPS-UV considers PractitionerRole.organization a Must Support element, a number of jurisdictional systems may not capture the organization the practitioner is performing that role for, in the scope of a practitioner that is the performer of an observation or diagnostic report. Further feedback is required on whether these systems are still expected to be able to demonstrate they can construct this element when developing a patient summary instance that includes diagnostic result information." />
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/organization-lab-ca-ps" />
</type>
</element>
<element id="PractitionerRole.code">
<path value="PractitionerRole.code" />
<definition value="Roles which this practitioner is authorized to perform for the organization." />
<type>
<code value="CodeableConcept" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps" />
</type>
<binding>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/additional-binding">
<extension url="purpose">
<valueCode value="candidate" />
</extension>
<extension url="valueSet">
<valueCanonical value="http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips" />
</extension>
<extension url="documentation">
<valueMarkdown value="Healthcare professional role codes from International Standard Classification of Occupations (ISCO) utilized in IPS. While not the preferred terminology for broader pan-Canadian exchange use cases, this additional binding is surfaced to socialize the value sets that are proposed for international exchange in IPS. Where multiple codings can be supplied, it is encouraged to supply the original coding alongside the pan-Canadian preferred terminology." />
</extension>
</extension>
<strength value="preferred" />
<description value="A role type that is used to categorize an entity that delivers health care in an expected and professional manner to an entity in need of health care services. Examples: Registered Nurse, Chiropractor, Physician, Custodial Care Clinic." />
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/healthcareproviderroletype" />
</binding>
</element>
<element id="PractitionerRole.specialty">
<path value="PractitionerRole.specialty" />
<short value="PractitionerSpecialty" />
<comment value="Work is underway to define the pan-Canadian terminology that will be preferred and/or socialized for PractitionerRole.specialty" />
<binding>
<strength value="example" />
<description value="Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient." />
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/practitionerspecialty" />
</binding>
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "practitionerrole-lab-ca-ps",
"url": "http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/practitionerrole-lab-ca-ps",
"name": "PractitionerRoleLabPSCA",
"title": "PractitionerRole - Lab (PS-CA)",
"status": "draft",
"experimental": false,
"date": "2023-12-06T00:00:00-08:00",
"description": "This profile represents the constraints applied to the PractitionerRole resource by the PS-CA project to represent a practitioner in a role acting as an observer for observation results for a specified organization. It is informed by the constraints of the [PractitionerRole IPS-UV profile](http://hl7.org/fhir/uv/ips/StructureDefinition-PractitionerRole-uv-ips.html) and the [Canadian Baseline Profile](http://build.fhir.org/ig/HL7-Canada/ca-baseline/branches/master/StructureDefinition-profile-practitionerrole.html) to allow for cross-border and cross-jurisdiction sharing of details that support Diagnostic Result Information.",
"copyright": "Copyright © 2024+ 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).",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "PractitionerRole",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "PractitionerRole.identifier",
"path": "PractitionerRole.identifier",
"type": [
{
"code": "Identifier",
"profile": [
"http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-identifier"
]
}
]
},
{
"id": "PractitionerRole.practitioner",
"path": "PractitionerRole.practitioner",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/practitioner-lab-ca-ps"
]
}
]
},
{
"id": "PractitionerRole.organization",
"path": "PractitionerRole.organization",
"comment": "While IPS-UV considers PractitionerRole.organization a Must Support element, a number of jurisdictional systems may not capture the organization the practitioner is performing that role for, in the scope of a practitioner that is the performer of an observation or diagnostic report. Further feedback is required on whether these systems are still expected to be able to demonstrate they can construct this element when developing a patient summary instance that includes diagnostic result information.",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/organization-lab-ca-ps"
]
}
]
},
{
"id": "PractitionerRole.code",
"path": "PractitionerRole.code",
"definition": "Roles which this practitioner is authorized to perform for the organization.",
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps"
]
}
],
"binding": {
"extension": [
{
"extension": [
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips"
},
{
"url": "documentation",
"valueMarkdown": "Healthcare professional role codes from International Standard Classification of Occupations (ISCO) utilized in IPS. While not the preferred terminology for broader pan-Canadian exchange use cases, this additional binding is surfaced to socialize the value sets that are proposed for international exchange in IPS. Where multiple codings can be supplied, it is encouraged to supply the original coding alongside the pan-Canadian preferred terminology."
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
}
],
"strength": "preferred",
"description": "A role type that is used to categorize an entity that delivers health care in an expected and professional manner to an entity in need of health care services. Examples: Registered Nurse, Chiropractor, Physician, Custodial Care Clinic.",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/healthcareproviderroletype"
}
},
{
"id": "PractitionerRole.specialty",
"path": "PractitionerRole.specialty",
"short": "PractitionerSpecialty",
"comment": "Work is underway to define the pan-Canadian terminology that will be preferred and/or socialized for PractitionerRole.specialty",
"binding": {
"strength": "example",
"description": "Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient.",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/practitionerspecialty"
}
}
]
}
}

Terminology bindings (Differential)

PathConformanceValueSet
PractitionerRole.codepreferredhttps://fhir.infoway-inforoute.ca/ValueSet/healthcareproviderroletype
PractitionerRole.specialtyexamplehttps://fhir.infoway-inforoute.ca/ValueSet/practitionerspecialty

Terminology bindings (Snapshot)

Constraints

Key Differences between the IPS-UV and PS-CA

Must Support Differences:

  • PS-CA removed a Must Support flag to PractitionerRole.organization

Note: Systems that do support these elements are encouraged to include it in generated Patient Summary documents, and support it when received

Cardinality Differences:

There are no cardinality differences between this profile and IPS-UV

Vocabulary Differences:

  • PractitionerRole.code

    • additionalBindings added for:
      • Healthcare Professional Role codes ISCO HealthcareProfessionalRolesUvIps
  • PractitionerRole.speciality

    • Practitioner Speciality https://fhir.infoway-inforoute.ca/ValueSet/practitionerspecialty indicated as preferred Note: Work is underway to define a pan-Canadian valueset for specialty.

Other differences between the IPS and PS-CA Include:

  • Data type profiles (e.g., CodeableConcept) and reference targets (e.g., Practitioner) replaced with PS-CA equivalents when appropriate

Note: Additionally, the use of CA Baseline Pratitioner, PractitionerRole, Organization profiles will be superseded by the CA Core profiles (or profiles that impose the CA Core) in future releases but the current usage of CA Baseline profiles will be maintained until a further stabilized CA Core profile (or further Patient Summary requirements) exist.

IG © based on FHIR R4 | Package project:PS-CA-R1
HL7® and FHIR® are the registered trademarks of Health Level Seven International