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. Practitioner-Lab (PS-CA)

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

Practitioner-Lab (PS-CA)

Links

Profile

practitioner-lab-ca-ps

Derived from

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

Examples

Description

This profile represents the constraints applied to the Practitioner resource by the PS-CA project to represent a practitioner acting as observer for diagnostic results. It is informed by the constraints of the Practitioner IPS-UV profile and the Canadian Baseline Profile to allow for cross-border and cross-jurisdiction sharing of details that support Diagnostic Result Information. This profile may be underpinned by a CA Core profile in the future. There is a possibility it will be replaced entirely by a CA Core profile if the requirements for use in lab are aligned to expectations for generic use.

References to this resource

DiagnosticReportPSCA, ObservationResultsLaboratoryPathologyPSCA, ObservationResultsRadiologyPSCA, PractitionerRoleLabPSCA

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
PractitionerLabPSCA (Practitioner)CPractitioner
There are no (further) constraints on this element
Element id
Practitioner
Short description

A person with a formal responsibility in the provisioning of healthcare or related services

Definition

A person who is directly or indirectly involved in the provisioning of healthcare.

Data type

Practitioner

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: Provider
idΣ0..1string
There are no (further) constraints on this element
Element id
Practitioner.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
Practitioner.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
Practitioner.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
Practitioner.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
Practitioner.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
Practitioner.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
Practitioner.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
Practitioner.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..*Identifier
There are no (further) constraints on this element
Element id
Practitioner.identifier
Short description

An identifier for the person as this agent

Definition

An identifier that applies to this person in this role.

Requirements

Often, specific identities are assigned for the agent.

Data type

Identifier

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
activeΣ0..1boolean
There are no (further) constraints on this element
Element id
Practitioner.active
Short description

Whether this practitioner's record is in active use

Definition

Whether this practitioner's record is in active use.

Requirements

Need to be able to mark a practitioner record as not to be used because it was created in error.

Comments

If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.

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
  • rim: ./statusCode
nameS Σ C1..*HumanNameElement id
Practitioner.name
Short description

The name(s) associated with the practitioner

Definition

The name(s) associated with the practitioner.

Requirements

The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.

Comments

The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate.

In general, select the value to be used in the ResourceReference.display based on this:

  1. There is more than 1 name
  2. Use = usual
  3. Period is current to the date of the usage
  4. Use = official
  5. Other order as decided by internal business rules.
Data type

HumanName

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • psca-pract-1: Practitioner.name.given or Practitioner.name.family or both SHALL be present
    family.exists() or given.exists()
Mappings
  • v2: XCN Components
  • rim: ./name
  • servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
id0..1string
There are no (further) constraints on this element
Element id
Practitioner.name.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
Practitioner.name.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

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

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
useΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
Practitioner.name.use
Short description

usual | official | temp | nickname | anonymous | old | maiden

Definition

Identifies the purpose for this name.

Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Comments

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Data type

code

Binding

The use of a human name.

NameUse (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XPN.7, but often indicated by which field contains the name
  • rim: unique(./use)
  • servd: ./NamePurpose
textΣ0..1string
There are no (further) constraints on this element
Element id
Practitioner.name.text
Short description

Text representation of the full name

Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: implied by XPN.11
  • rim: ./formatted
familyS Σ0..1string
There are no (further) constraints on this element
Element id
Practitioner.name.family
Short description

Family name (often called 'Surname')

Alternate names

surname

Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XPN.1/FN.1
  • rim: ./part[partType = FAM]
  • servd: ./FamilyName
givenS Σ0..*string
There are no (further) constraints on this element
Element id
Practitioner.name.given
Short description

Given names (not always 'first'). Includes middle names

Alternate names

first name, middle name

Definition

Given name.

Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XPN.2 + XPN.3
  • rim: ./part[partType = GIV]
  • servd: ./GivenNames
prefixΣ0..*string
There are no (further) constraints on this element
Element id
Practitioner.name.prefix
Short description

Parts that come before the name

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XPN.5
  • rim: ./part[partType = PFX]
  • servd: ./TitleCode
suffixΣ0..*string
There are no (further) constraints on this element
Element id
Practitioner.name.suffix
Short description

Parts that come after the name

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XPN/4
  • rim: ./part[partType = SFX]
periodΣ0..1Period
There are no (further) constraints on this element
Element id
Practitioner.name.period
Short description

Time period when name was/is in use

Definition

Indicates the period of time when this name was valid for the named person.

Requirements

Allows names to be placed in historical context.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XPN.13 + XPN.14
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
telecomΣ0..*ContactPointElement id
Practitioner.telecom
Short description

A contact detail for the practitioner (that apply to all roles)

Definition

A contact detail for the practitioner, e.g. a telephone number or an email address.

Requirements

Need to know how to reach a practitioner independent to any roles the practitioner may have.

Comments

While IPS-UV considers Practitioner.telecom a Must Support element, a number of jurisdictional systems may not capture telecom for practitioner today, even in the scope of a practitioner that is the performer of an observation or diagnostic report. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content.

Data type

ContactPoint

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PRT-15, STF-10, ROL-12
  • rim: ./telecom
  • servd: ./ContactPoints
addressΣ0..*AddressElement id
Practitioner.address
Short description

Address(es) of the practitioner that are not role specific (typically home address)

Definition

Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.

Requirements

The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.

Comments

IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content.

Data type

Address

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: ORC-24, STF-11, ROL-11, PRT-14
  • rim: ./addr
  • servd: ./Addresses
genderΣ0..1codeBinding
There are no (further) constraints on this element
Element id
Practitioner.gender
Short description

male | female | other | unknown

Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Requirements

Needed to address the person correctly.

Data type

code

Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: STF-5
  • rim: ./administrativeGender
  • servd: ./GenderCode
birthDateΣ0..1date
There are no (further) constraints on this element
Element id
Practitioner.birthDate
Short description

The date on which the practitioner was born

Definition

The date of birth for the practitioner.

Requirements

Needed for identification.

Data type

date

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: STF-6
  • rim: ./birthTime
  • servd: (not represented in ServD)
photo0..*Attachment
There are no (further) constraints on this element
Element id
Practitioner.photo
Short description

Image of the person

Definition

Image of the person.

Requirements

Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.

Data type

Attachment

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: ./subjectOf/ObservationEvent[code="photo"]/value
  • servd: ./ImageURI (only supports the URI reference)
qualification0..*BackboneElement
There are no (further) constraints on this element
Element id
Practitioner.qualification
Short description

Certification, licenses, or training pertaining to the provision of care

Definition

The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CER?
  • rim: .playingEntity.playingRole[classCode=QUAL].code
  • servd: ./Qualifications
id0..1string
There are no (further) constraints on this element
Element id
Practitioner.qualification.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
Practitioner.qualification.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
Practitioner.qualification.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
identifier0..*Identifier
There are no (further) constraints on this element
Element id
Practitioner.qualification.identifier
Short description

An identifier for this qualification for the practitioner

Definition

An identifier that applies to this person's qualification in this role.

Requirements

Often, specific identities are assigned for the qualification.

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .playingEntity.playingRole[classCode=QUAL].id
code1..1CodeableConcept
There are no (further) constraints on this element
Element id
Practitioner.qualification.code
Short description

Coded representation of the qualification

Definition

Coded representation of the qualification.

Data type

CodeableConcept

Binding

Specific qualification the practitioner has to provide a service.

v2.0360.2.7 (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .playingEntity.playingRole[classCode=QUAL].code
  • servd: ./Qualifications.Value
period0..1Period
There are no (further) constraints on this element
Element id
Practitioner.qualification.period
Short description

Period during which the qualification is valid

Definition

Period during which the qualification is valid.

Requirements

Qualifications are often for a limited period of time, and can be revoked.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .playingEntity.playingRole[classCode=QUAL].effectiveTime
  • servd: ./Qualifications.StartDate and ./Qualifications.EndDate
issuer0..1Reference(Organization)
There are no (further) constraints on this element
Element id
Practitioner.qualification.issuer
Short description

Organization that regulates and issues the qualification

Definition

Organization that regulates and issues the qualification.

Data type

Reference(Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .playingEntity.playingRole[classCode=QUAL].scoper
communication0..*CodeableConceptBinding
There are no (further) constraints on this element
Element id
Practitioner.communication
Short description

A language the practitioner can use in patient communication

Definition

A language the practitioner can use in patient communication.

Requirements

Knowing which language a practitioner speaks can help in facilitating communication with patients.

Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Data type

CodeableConcept

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())
Mappings
  • v2: PID-15, NK1-20, LAN-2
  • rim: ./languageCommunication
  • servd: ./Languages.LanguageSpokenCode
PractitionerLabPSCA (Practitioner)Practitioner
There are no (further) constraints on this element
Data type

Practitioner

nameS C1..
There are no (further) constraints on this element
Element id
Practitioner.name
Constraints
  • psca-pract-1: Practitioner.name.given or Practitioner.name.family or both SHALL be present
    family.exists() or given.exists()
familyS
There are no (further) constraints on this element
Element id
Practitioner.name.family
givenS
There are no (further) constraints on this element
Element id
Practitioner.name.given
telecom
There are no (further) constraints on this element
Element id
Practitioner.telecom
Comments

While IPS-UV considers Practitioner.telecom a Must Support element, a number of jurisdictional systems may not capture telecom for practitioner today, even in the scope of a practitioner that is the performer of an observation or diagnostic report. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content.

address
There are no (further) constraints on this element
Element id
Practitioner.address
Comments

IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content.

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="practitioner-lab-ca-ps" />
<url value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/practitioner-lab-ca-ps" />
<name value="PractitionerLabPSCA" />
<title value="Practitioner - 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 Practitioner resource by the PS-CA project to represent a practitioner acting as observer for diagnostic results. It is informed by the constraints of the [Practitioner IPS-UV profile](http://hl7.org/fhir/uv/ips/StructureDefinition-Practitioner-uv-ips.html) and the [Canadian Baseline Profile](http://build.fhir.org/ig/HL7-Canada/ca-baseline/branches/master/StructureDefinition-profile-practitioner.html) to allow for cross-border and cross-jurisdiction sharing of details that support Diagnostic Result Information. This profile may be underpinned by a CA Core profile in the future. There is a possibility it will be replaced entirely by a CA Core profile if the requirements for use in lab are aligned to expectations for generic use." />
<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="Practitioner" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
<derivation value="constraint" />
<differential>
<element id="Practitioner.name">
<path value="Practitioner.name" />
<min value="1" />
<constraint>
<key value="psca-pract-1" />
<severity value="error" />
<human value="Practitioner.name.given or Practitioner.name.family or both SHALL be present" />
<expression value="family.exists() or given.exists()" />
<xpath value="f:given or f:family" />
</constraint>
<mustSupport value="true" />
</element>
<element id="Practitioner.name.family">
<path value="Practitioner.name.family" />
<mustSupport value="true" />
</element>
<element id="Practitioner.name.given">
<path value="Practitioner.name.given" />
<mustSupport value="true" />
</element>
<element id="Practitioner.telecom">
<path value="Practitioner.telecom" />
<comment value="While IPS-UV considers Practitioner.telecom a Must Support element, a number of jurisdictional systems may not capture telecom for practitioner today, even in the scope of a practitioner that is the performer of an observation or diagnostic report. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content." />
</element>
<element id="Practitioner.address">
<path value="Practitioner.address" />
<comment value="IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content." />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "practitioner-lab-ca-ps",
"url": "http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/practitioner-lab-ca-ps",
"name": "PractitionerLabPSCA",
"title": "Practitioner - Lab (PS-CA)",
"status": "draft",
"experimental": false,
"date": "2023-12-06T00:00:00-08:00",
"description": "This profile represents the constraints applied to the Practitioner resource by the PS-CA project to represent a practitioner acting as observer for diagnostic results. It is informed by the constraints of the [Practitioner IPS-UV profile](http://hl7.org/fhir/uv/ips/StructureDefinition-Practitioner-uv-ips.html) and the [Canadian Baseline Profile](http://build.fhir.org/ig/HL7-Canada/ca-baseline/branches/master/StructureDefinition-profile-practitioner.html) to allow for cross-border and cross-jurisdiction sharing of details that support Diagnostic Result Information. This profile may be underpinned by a CA Core profile in the future. There is a possibility it will be replaced entirely by a CA Core profile if the requirements for use in lab are aligned to expectations for generic use.",
"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": "Practitioner",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Practitioner",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Practitioner.name",
"path": "Practitioner.name",
"min": 1,
"constraint": [
{
"key": "psca-pract-1",
"severity": "error",
"human": "Practitioner.name.given or Practitioner.name.family or both SHALL be present",
"expression": "family.exists() or given.exists()",
"xpath": "f:given or f:family"
}
],
"mustSupport": true
},
{
"id": "Practitioner.name.family",
"path": "Practitioner.name.family",
"mustSupport": true
},
{
"id": "Practitioner.name.given",
"path": "Practitioner.name.given",
"mustSupport": true
},
{
"id": "Practitioner.telecom",
"path": "Practitioner.telecom",
"comment": "While IPS-UV considers Practitioner.telecom a Must Support element, a number of jurisdictional systems may not capture telecom for practitioner today, even in the scope of a practitioner that is the performer of an observation or diagnostic report. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content."
},
{
"id": "Practitioner.address",
"path": "Practitioner.address",
"comment": "IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content."
}
]
}
}

Terminology bindings (Differential)

Terminology bindings (Snapshot)

Constraints

PathIdGradeDetailsExpression
Practitioner.namepsca-pract-1errorPractitioner.name.given or Practitioner.name.family or both SHALL be presentfamily.exists() or given.exists()

Key Differences between the IPS-UV and PS-CA

Must Support Differences:

  • PS-CA removed a Must Support flag to Practitioner.telecom
  • PS-CA removed a Must Support flag to Practitioner.address

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:

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

Other differences between the IPS and PS-CA Include:

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

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