For a full list of available versions, see the Directory of published versions
The EHR Implementation Guide defines a shared set of base profiles and terminology that is consumed by multiple domain-specific IGs - clinical documents, medical imaging, drug repository, immunization repository, and others. For data-out (query response) scenarios, domain-specific IGs currently reference EHR profiles directly rather than defining their own derived profiles. For data-in (submission) scenarios, each domain IG defines its own submission profiles with actor-specific obligations, as illustrated by the BDP submission profile conformance approach.
This arrangement raises a structural challenge for adopting actor-specific Obligations: while the EHR profiles represent a common data model, the behavioural expectations placed on producers and consumers may legitimately vary across domains. The question is therefore not whether to declare obligations in the EHR IG, but how to structure them so that they are meaningful at the EHR level without inadvertently over-constraining or misrepresenting domain-specific requirements.
The following sections describe the available options, their trade-offs, and a recommended approach aligned with the direction established by CA Core+ and IPA.
CA Core+ is the pan-Canadian Core FHIR Profile set published by Canada Health Infoway. It defines a shared foundational layer of R4-based profiles, terminology, and conformance expectations for Canadian digital health. The EHR IG aims to align with CA Core+ wherever possible. CA Core+ defines two primary actors - Producer and Consumer - whose roles align with how obligations are specified across the guide, and uses the FHIR Obligation extension (backported from R5) to declare actor-specific conformance expectations.
The International Patient Access (IPA) Implementation Guide is published by HL7 International / Patient Care. IPA defines a minimal, globally applicable set of FHIR R4-based profiles specifically intended to be used as-is, or to be built upon by countries or jurisdictions looking to enable patient access and patient-facing applications accessing data via a RESTful FHIR API. IPA is a foundational building block for national or regional FHIR base or patient access specifications and is one of the most mature published examples of the Obligation extension applied in an R4-based IG.
IPA defines two actors: an IPA Server (the clinical records system responding to queries) and an IPA Client (the application acting on behalf of a patient). IPA applies SHALL:populate-if-known to servers for MustSupport elements and SHALL:handle to clients, requiring that client applications be capable of processing resource instances containing MustSupport data elements without generating an error or causing the application to fail.
Before declaring obligations, the actor model must be defined. The EHR IG and its dependent domain IGs collectively involve the following actors:
| Actor | Description |
|---|---|
| EHR Producer | A system (hospital, clinic, or health information system) that creates and makes EHR-conformant resources available. Equivalent to CA Core+ Producer. |
| EHR Consumer | A system (EMR, patient-facing application, care coordination platform) that retrieves and acts on EHR-conformant resources. Equivalent to CA Core+ Consumer. |
| Domain Repository | A system that receives, stores, and serves domain-specific data (e.g. the acCDR, miCDR, immunization repository). Acts as both consumer (receiving submissions) and producer (serving query responses). Declared at the domain IG level. |
The Domain Repository - Producer and EHR Consumer are the two actors relevant to EHR profile obligations. Domain-specific actors (e.g. MI Contributor, MI Repository) are declared in their respective IGs and may extend EHR obligations in derived profiles.
This actor model aligns with CA Core+, which defines Producer and Consumer as its two primary actors whose roles align with how obligations are specified across the guide. The EHR IG may reference or align its actor canonical URIs with CA Core+ actor definitions where possible, to support eventual alignment with the pan-Canadian standard.
Under this option the EHR IG retains the current mustSupport-only approach. Each domain IG creates its own data-out profiles derived from the corresponding EHR profiles, and all actor-specific obligations are declared in those derived profiles. No structural changes are permitted in the derived profiles - they add obligations only.
Pros
Cons
Verdict: Does not meet stated requirements and carries high transition cost. Not recommended as a standalone approach, but the derived-profile layer concept embedded in this option is valuable and should be considered as a complementary pattern (see Option 3 and Recommendation).
Under this option the EHR IG declares obligations on all MustSupport elements using a conservative, domain-agnostic set of obligation codes that can reasonably be assumed to apply across all current and future domain IGs. Domain IGs continue to reference EHR profiles directly for data-out scenarios without creating derived profiles.
The proposed obligation tiers are:
| Element category | Domain Repository Producer obligation | EHR Consumer obligation |
|---|---|---|
| All MustSupport elements | SHALL:populate-if-known |
SHALL:no-error |
Critical MustSupport elements (e.g. Patient.identifier, Patient.name, Immunization.vaccineCode, Composition.type) |
SHALL:populate-if-known |
SHALL:handle |
This approach mirrors the CA Core+ model, where Obligations describe what each actor is expected to do when producing or consuming CA Core+ conformant content, and where a Producer is expected to meet only the obligations for the CA Core+ profiles it claims. It also parallels IPA conformance approach, where the vast majority of server obligations use SHALL:populate-if-known and clients are assigned SHALL:handle for MustSupport elements.
Pros
SHALL:no-error, SHALL:populate-if-known) are unlikely to conflict with any domain-specific consumer requirements - they set a floor, not a ceiling.Cons
SHALL:display for a patient-facing imaging IG, or SHALL:persist for a repository-facing consumer). These cannot be declared at the EHR level without potentially misrepresenting the obligations for domains where those stronger obligations do not apply.SHALL:no-error) and "critical MS elements" (SHALL:handle) requires a shared, explicit rationale for what constitutes a "critical" element - this must be documented and maintained as profiles evolve.Verdict: Feasible and meets requirements. Best suited as the baseline layer, particularly when combined with an optional derived-profile pattern for domains that need stronger obligations.
This option combines the baseline EHR obligations from Option 2 with a recommended (but not mandated) pattern for domain IGs that need to declare stronger or more specific consumer obligations. Domain IGs that require additional obligations create a thin derived profile - structurally identical to the parent EHR profile, adding only obligation extensions - and use that derived profile as their data-out profile instead of the EHR profile directly.
This pattern is explicitly recommended for new IGs going forward and is optional (transitional) for existing released or in-flight IGs.
Obligation layering example for Patient:
| Actor | EHR Patient profile (baseline) | Domain-derived Patient profile (example: imaging IG) |
|---|---|---|
| Domain Repository - Producer | SHALL:populate-if-known on all MS |
Inherits; no change needed |
| Consumer | SHALL:no-error on all MS |
Inherits + SHALL:display on Patient.name, Patient.birthDate |
| Consumer | SHALL:handle on Patient.identifier, Patient.name |
Inherits; already set |
Pros
Cons
Verdict: Recommended approach. Balances EHR-level consistency with domain-level flexibility, is non-breaking for existing IGs, and provides a principled upgrade path.
Under this option the EHR IG maintains two profile layers per resource: a structural profile (current EHR profiles, unchanged) and a parallel obligation profile (a derived StructureDefinition that adds only the Obligation extension). Domain IGs reference the obligation profile, not the structural profile directly.
This is the pattern used by the HL7 Europe Laboratory Report IG.
Pros
Cons
Verdict: Not recommended for the current phase. May be reconsidered in the future if tooling matures significantly.
| Consideration | Option 1 | Option 2 | Option 3 (Recommended) | Option 4 |
|---|---|---|---|---|
| EHR IG declares obligations | ❌ | ✅ | ✅ | ✅ (obligation profiles) |
| No Breaking change for existing domain IGs | ❌ (high) | ✅ | ✅ | ❌ (high) |
| Domain-specific obligations expressible | ✅ | ❌ | ✅ | ✅ |
| Consistent baseline across all domains | ❌ | ✅ | ✅ | ✅ |
| Profile count increase | High | None | Low (new IGs only) | High |
| Aligned with CA Core+ model | Partial | ✅ | ✅ | Partial |
| Tooling maturity risk | Low | Low | Low | Medium |
| Transition complexity | High | Low | Low–Medium | High |
Adopt Option 3.
Declare a conservative, domain-agnostic set of obligations directly on EHR profiles for all MustSupport elements. No structural changes; no changes to cardinality, terminology, or invariants. All existing domain IG references to EHR profiles remain valid.
Apply the following obligation tiers uniformly:
| Element category | Domain Repository - Producer | EHR Consumer |
|---|---|---|
| All MustSupport elements | SHALL:populate-if-known |
SHALL:no-error |
| Critical MustSupport elements | SHALL:populate-if-known |
SHALL:handle |
The designation of "critical" elements should be documented explicitly in the EHR IG conformance page and reviewed by the Standards team. As a starting point, critical elements are those where a consumer silently ignoring the value would constitute a clinically meaningful failure - patient identity elements (Patient.identifier, Patient.name, Patient.birthDate), resource type discriminators (Composition.type, DiagnosticReport.code), and domain-specific key coded elements (Immunization.vaccineCode, MedicationStatement.medication[x]).
The producer obligation SHALL:populate-if-known aligns with both CA Core+ and IPA and correctly expresses that a system is not required to obtain data it does not hold, but must include data it does hold.
The consumer obligations SHALL:no-error (floor) and SHALL:handle (critical elements) align with CA Core+ Consumer and IPA Client semantics. They set a baseline without dictating display, persistence, or workflow behaviour - aspects that legitimately vary across domains.
Establish as the preferred pattern for new domain IGs that need consumer obligations stronger than the EHR baseline (e.g. SHALL:display, SHALL:persist, SHOULD:display). These IGs create a thin derived profile per EHR profile - adding only Obligation extensions, with no structural changes - and declare it as their data-out conformance target.
Existing released or in-flight domain IGs may adopt this pattern at the next major version milestone. Until then, they inherit the EHR baseline obligations and document in their own conformance pages any additional behavioural expectations in narrative form (preserving the current approach while the derived-profile pattern is established).
The following principles should govern obligation declarations across the EHR IG and all dependent domain IGs:
The BDP submission profile conformance page illustrates a mature, well-structured application of the obligations pattern for data-in scenarios, with three distinct obligation tiers (required MS, optional MS, and optional metadata) and clear narrative explaining the semantics of each code. The EHR obligations approach for data-out should adopt the same documentation standard: a summary table on the conformance page defining the obligation tiers, the codes applied, and a prose explanation of what each code requires of each actor. This ensures that the IG ecosystem presents a consistent conformance experience regardless of whether an implementer is reading a submission profile or a query-response profile.
Critical element designation: What is the agreed list of elements that warrant SHALL:handle (rather than SHALL:no-error) in EHR profiles? Should this list be maintained as a documented table on the conformance page?
CA Core+ alignment: The EHR IG uses SHALL:populate-if-known for Domain Repositories - producers and SHALL:no-error / SHALL:handle for consumers. CA Core+ uses the same Producer codes but only SHALL:no-error for Consumer (not SHALL:handle). Should the EHR IG align fully with CA Core+ Consumer codes, or maintain the SHALL:handle tier for critical elements as a domain-justified extension?
Domain IG transition timeline: For existing released domain IGs that do not yet have derived data-out profiles, should there be a target version milestone by which the derived-profile pattern must be adopted, or should it remain indefinitely optional?
SHALL:display and SHALL:persist: Should any EHR-level consumer obligations use these stronger codes, or should they remain exclusively at the domain IG derived-profile level? If the latter, are there any elements (e.g. Patient.name) where a universal SHALL:display obligation could be considered at the EHR level across all current domains?