Change Log

Date	IG Version	Release Type	FHIR Version	Guide	Package
2026-09-30	HALO v2.0.0 DFT-preBallot	2.0.0 DFT-preBallot	4.0.1	Home Page	ca.infoway.io.halo 2.0.0-dft-preballot
2026-07-15	HALO v1.2.0 DFT	1.2.0 DFT	4.0.1	Home Page	ca.infoway.io.halo 1.2.0-dft
2026-03-27	HALO v1.2.0 DFT-preBallot	1.2.0 DFT-preballot	4.0.1	Home Page	ca.infoway.io.halo 1.2.0-dft-preballot
2025-10-31	HALO v1.1.1 DFT-preBallot	1.1.1 DFT-preBallot	4.0.1	Home Page	ca.infoway.io.halo 1.1.1-dft-preballot
2025-09-26	HALO v1.1.0 DFT-preBallot	1.1.0 DFT-preBallot	4.0.1	Home Page	ca.infoway.io.halo 1.1.0-dft-preballot
2025-04-11	HALO v1.0.0 DFT-preBallot	1.0.0 DFT-preBallot	4.0.1	Home Page	ca.infoway.io.halo 1.0.0-dft-preballot

v2.0.0 DFT-preBallot

• Backend Services
  • Added the Backend Services HALO Component, describing the use of SMART Backend Services (client credentials grant with asymmetric client authentication) for system-to-system integrations that operate without a user-driven app launch or active clinical session
  • Added onboarding and offboarding lifecycle operations $initiate-onboarding and $offboard, along with their corresponding FHIR OperationDefinitions and examples
  • Added the CA:BS – pan-Canadian Backend Services Integration Profile, defining the Onboarding Initiator and Onboarding Responder actors and the associated transactions
  • Updated the CA:SoF profile to support both the Authorization Code flow (EHR Launch) and the Client Credentials flow (Backend Services), and clarified that the Launch Initiator/Launch Responder actors do not participate in backend services scenarios
  • Added UC-05: Backend Service Discovery and Onboarding, UC-06: Backend Service Retrieves Patient Data from Point of Care Solution, and UC-07: Backend Service Writes Patient Data to Point of Care Solution, along with corresponding Interoperability Recommendations
  • Added Business Requirements R-007, IR-013 through IR-020, and SR-025 through SR-034 covering backend services support, discovery, registration, scopes, and security expectations
  • Added a Backend Service glossary entry
  • Updated the App Catalog to introduce the type field (distinguishing "smart-app" from "backend-service" entries), the onboardingEndpoint and offboardingEndpoint fields, client_credentials as an acceptable grantTypes value, and guidance for Hybrid Solutions combining a SMART App and a Backend Service
  • Updated Overall Architecture and Conformance Guidance pages to reflect Backend Services as a core HALO concept
• Design Considerations
  • Added a Responsible Data Access, Modification, and Review section covering shared responsibility, data minimization, FHIR write operations, auditing and traceability, provenance, consent, and additional considerations for Backend Services
• App Launch
  • Added a SMART Scope Versioning (v1 vs v2) section describing HALO's support for both SMART App Launch 1.0 and 2.x scope syntax
• Integration Profiles
  • Updated Integration Profile diagrams to use a consistent arrow/participant colour scheme (#AB2B10)
• Conformance Guidance
  • Replaced outdated PS-CA and CA:eReC links with current Simplifier.net references
• Diagrams
  • Replaced several inline architecture and sequence diagrams with rendered image references for improved maintainability
• Minor clarifications, grammar corrections, and link updates across App Catalog, App Launch, Subscriptions, Conformance Guidance, and Overall Architecture pages

v1.2.0 DFT

• Business Requirements
  • Added clarifications to Business Requirements IR-007, SR-005, SR-006
• App Catalog
  • ⁠Multilingual Support
    • Distinguished Catalog Metadata Translation (translation of application metadata in the catalog response) and Application Runtime Translation (translation of the application after launch) as separate, independent concepts, and clarified translation handling further
    • Clarified multilingual metadata field names by renaming lang to contentLanguage and langSupported to languagesSupported
  • Registration elements
    • Added registrationModes and preassignedCredentials elements holding the App registration details to support scalable registration with an Identity Provider (IdP)
  • Intents element
    • Added intents element to support UI contexts or workflows during a SMART launch.
• Design Considerations
  • Added App Registration and Authentication & Securing the App Catalog sections.
  • Renamed section Security, Authentication and Authorization to Federated Identity and Single Sign-On
  • Renamed sub-section title from Recommended SSO Approach: Federated Identity Sign-On to Recommended SSO Approach: Federated Single Sign-On
• Subscriptions
  • Updated the Subscriptions page to reflect that an active subscription is required for state-changing interactions only
• User Perspective Guides
  • Key HALO Sections - Added links to Design Considerations, Integration Profiles Overview, Interoperability Recommendations
  • Added clarification to the SMART App Developers User Perspective Guide that Apps are discoverable within the jurisdiction
• Operation:$set-context
  • Added State-changing Scopes section to the $set-context page
• Operation:$clear-context
  • Updated the Overview section on the $clear-context page to include SOFA recommendations.
• Minor spelling and grammar corrections

v1.2.0 DFT-preBallot

• Added Multilanguage App Catalog support
• Updated App Catalog endpoint
• Grammar, spelling and graphic corrections

v1.1.1 DFT-preBallot

• Corrected front page project description
• Corrected inconsistencies in diagrams for labelling and colouring
• Corrected description of fhiruser parameter in $set-context
• Updated descriptions of $events & $status outputs
• Removed slicing from Bundle profiles
• Corrected minor discrepancies within examples
• Minor spelling and grammar corrections

v1.1.0 DFT-preBallot

• Added Integration Profiles for the HALO framework (CA:AC, CA:SoF, CA:SoFA, CA:FSub)

• Added User Perspective Guides

• Business Requirements

  • Updated many requirements with clarifications from community feedback and fixed typos. Substantive changes are below:
  • R-002: updated requirement to support patient context where applicable, with consistent error handling
  • R-006: added requirement to address audit logging
  • IR-008 & IR-011
    • Fixed duplicate Business Requirements, Deprecated IR-011
    • Updated IR-008 with latest pan-Canadian specification releases and reduced requirement to use CA Core+ Profiles to SHOULD
  • IR-012: Reduced the requirement severity of the ability for SMART Apps to send discrete data back to POCs to SHOULD

• Overall Architecture

  • Updated HALO SMART on FHIR Accelerator Architecture diagram, added Pre-condition for PoC system to have registered a subscription to the SoFA topic
  • Clarified LoB Services are out-of-scope

• Design Considerations

  • Updated titles to Federated Single Sign-On -> Federated Single Sign-On (Recommended), Federated Sign-On (with Local Login) -> Federated Sign-On with Local Login

• App Catalog

  • removed references to CapabilityStatement
  • Updated section title to offline_access Scope

• App Launch

  • added clarifying language to resource retention limits

• Subscriptions

  • Clarified requested state in the Subscription Creation Section
  • Renamed “Event ID Tracking” section to “Event Number Tracking”
  • $get-ws-binding-token is changed from GET to POST

• SetContextTransactionBundle Profile

  • Removed unnecessary slices

• SetContextTransactionResponseBundle Profile

  • Removed unnecessary slices

• SetContextOutputParameters Profile

  • fixed broken section to profile

• Fixed typos and incorrect links throughout the guide

v1.0.0 DFT-preBallot

• Initial public release of the HALO specifications