Profiling Conventions & Approach

pCHDCF Translation Practices

This section will continue to expand in future iterations as content is further developed in the pan-Canadian Health Data Content Framework (pCHDCF). This version focuses on 1) mapping the data element definitions from the pCHDCF Data Content Standard, 2) outlining a potential logic for translating initial expectations into FHIR profiles, 3) initial introduction of terminology for select concepts.

Mappings to the Data Content Standard data elements are defined in-line within the profiles and can be found on each profile's page.

Translating Obligations

In line with General Principles & Design these profiles make use of an emerging a new (and evolving) mechanism in FHIR that provides a consistent and machine processable way for profiles to define their expectations for system behaviors. This mechanism is the Obligation Extension which is defined in the cross-version extension registry but has been recently expanded to support application. The updated definition can be found in the CI Build FHIR Extension Registry definition.

The Data Content Standard (DCS) does not currently include requirement strengths (e.g., mandatory, required if known, optional) but the following definitions have been proposed to convey the level of expectation for a concept in a given context:

  • M = Mandatory: where the data element is mandatory, and the process cannot be completed without the data element being present.
  • RK = Required if Known: where the data element is required to be provided if available or known to support the process.
  • O = Optional: where the data element is not required and may be provided to support the process.

These definitions and the approach in the Data Content Standard towards applying these requirements may continue to evolve.

In the meantime, the definitions above have been translated to the following obligation codes:

pCHDCF Strength Target for Expectation Obligation Code
Mandatory Resource Producer SHALL:populate
Mandatory Resource Consumer SHALL:handle
Required If Known Resource Producer SHALL:populate
Required If Known Resource Consumer SHALL:handle
Optional Resource Producer SHALL:able-to-populate
Optional Resource Consumer SHALL:no-error

Additional considerations:

  • Some expectations are expected to be nested/conditional; others will require the backbone element carries the same strength
  • Optional elements identified as stretch goals may not carry the SHALL:able-to-populate obligation (e.g., National Unique Health Identifier). These will be socialized with a comment until further is known about expectations for consumers/producers.

Note: Given the preliminary nature of the content in this release (see Scope of Guide), requirement strengths for the identified data elements are not in scope of this round of profiling. For this reason, the current profiles apply the minimum expectation strength (SHALL:able-to-populate/SHALL:no-error) to all elements that have been identified at this stage, with a few exceptions for elements identified by CIHI as stretch goals. Application of obligations will continue to be updated as the pCHDCF content is developed and refined.