preBallot - The specification is currently in ballot review and subject to change. . . . For a full list of available versions, see the Directory of published versions
Change Log
Guide Versions
| Version | Date | Description |
|---|---|---|
| 1.1.0 DFT-Ballot | 4/15/2025 | Incorporating feedback from 2025 Projectathon and Jurisdictional change requests |
| 1.0.3 DFT | 06/12/2024 | For the Feb 2025 Projectathon |
| 1.0.0 DFT-Ballot | 03/27/2024 | First published version of the Draft for ballot review |
Known Issues
- Introduced virtualService extension derived from an R5 element within the Appointment profile. A separate extension will be created for it after balloting is completed. For now, please focus attention on the patterning and use of the Appointment resource and how virtualService fits into it.
Note: virtualService extension has been removed from the profile and this issue therefore is resolved.
Any known issues found within the guide will be documented in the section provided here in future iterations of this guide. To provide your questions or concerns please message Canada Health Infoway on: interoperability@infoway-inforoute.ca.
Specifications Updates
| RELEASE | VERSION No. | DATE | SUMMARY OF CHANGE |
|---|---|---|---|
| CA:eReC v1.1.0 DFT-ballot | v1.1.0 | 4/15/2025 | - Using pan-Canadian Enterprise Template. Technical Context - Fixes to certain transactions in UC-4 Central Access and Triage (CAT), Select Alternate Flows Sequence Diagrams - Updated guidance for how Target Systems shall reference ServiceRequest received from Source systems - MessageTransaction Details: Indicating where focus is variable and appropriate changeReasonCode to use Examples - Adding Examples for all messaging events |
| CA:eReC v1.0.3 DFT | v1.0.3 | 12/06/2024 | Technical Errata - Removed package dependency on ca.on.oh-eReferral-eConsult 0.11.1-alpha1.0.12. - Fixed links pointing to previous ON eServices extensions, codesystems, and valuesets. |
| CA:eReC v1.0.2 DFT | v1.0.2 | 10/30/2024 | Technical Errata - Modified Bundle slicing discriminator from resource type to profile to improve validation capabilities. Fix typos on Messaging Compliance Table (in the Actors and Transactions section) for the following transactions: Notify data correction [eReCm-4] - Maturity Level should be L2 for eReC Requester Send communication from requester [eReCm-9] - Maturity Level should be L3 for eReC Performer Send communication from performer [eReCm-10] - Maturity Level should be L3 for eReC Performer |
| CA:eReC v1.0.1 DFT | v1.0.1 | 10/9/2024 | Technical Errata - Update to the canonical url for task-code. - Updated the profile pages to reflect the correct canonicals for each profile - Added linkage and description to the existing BusinessStatusReason extension in the extension table. |
| CA:eReC v1.0.0 DFT | v1.0.0 | 10/1/2024 | - Updated overall page hierarchy from ballot feedback Business Context - Added Business Models page to describe the people and systems that contribute to a service record in different eReferral and eConsult models supported by the specification. - Updated Use Cases page - Added a use case for Central Access and Triage in addition to Central Intake. Updated flow diagrams for simplicity and consistency with sequence diagrams. - Added Business Events page to describe events supporting eReferral/eConsult workflow associated with different levels of system maturity. Technical Context Updated MustSupport definition from ballot feedback - highlighted 'use case support' guidance on resource profiles. - Added Integration Patterns page to highlight the real-world architectures that support the business models to provide implementable technical specifications. - Updated technical actors, actor options and grouping. - Note: Addition of eReC Informer and eReC Recipient technical actors with updated eReC-m2: Notify new service record , and new eReC-m11: Notify update service record transactions. - Updated Messaging page with new actor definitions and transactions, re-framing transactions in context of maturity levels. Added requirements for reducing message size within a message bundle. - Updated Sequence diagrams with new/updated actors and transactions. Added a diagram to support the Central Access and Triage use case. - Updated Conformance Requirements tables with new/updated actors and transactions. Added a table to support Central Access and Triage use case. |
Resource Profile Updates
| PROFILE | VERSION No. | DATE | SUMMARY OF CHANGE |
|---|---|---|---|
| Task | 1.1.0 | 4/15/2025 | HealthcareService is an allowable reference in Task.owner Task.output can use String and Code as allowable data-types |
| Communication | 1.1.0 | 4/15/2025 | HealthcareService is an allowable reference in Communication.sender |
| ServiceRequest | 1.1.0 | 4/15/2025 | Every ServiceRequest SHALL have a single official business identifier where ServiceRequest.identifier.use = "official" Changed BindingStrength for ServiceRequest.category to preferred Added ServiceProviderPreference extension to ServiceRequest to indicate preference for provider or location Added ServiceRequesterDelegate extension to ServiceRequest to identify person or provider that is the delegate Added back RoutingOptions and ReferralIdentifier extensions Added back PerformerIdentifier extension to ServiceRequest.performer |
| Patient | 1.1.0 | 4/15/2025 | Patient.identifier is an optional, must-support element |
| MessageHeader | 1.1.0 | 4/15/2025 | MessageChangeReasonCode valueset has extensible binding with MessageHeader.reason to provide context on the trigger for ‘notify-update’ messages Added back RoutingOptions and ReferralIdentifier extensions |
| Bundle | 1.0.2 | 10/30/2024 | Technical Errata - Modified Bundle slicing discriminator from resource type to profile to improve validation capabilities |
| Task | 1.0.1 | 10/9/2024 | Technical Errata - Update to the canonical url for task-code |
| HealthcareService | 1.0.0 | 9/18/2024 | HealthcareService profile added from ballot feedback |
| Questionnaire | 1.0.0 | 9/18/2024 | Questionnaire profile removed from ballot feedback |
| Appointment, Bundle, Communication, DocumentReference, Location, MessageHeader, Organization, Patient, Practitioner, PractitionerRole, QuestionnaireResponse, ServiceRequest, and Task profiles | 1.0.0 | 9/18/2024 | Updated these profiles and version numbers based on ballot feedback |
| CommunicationBarrier, CopiedParticipants, DARC, DART, HCNV Code, PatientPresentLocation, PerformerIdentifier, ReasonForNoHCN, ReferralIdentifier, and RoutingOptions extensions | 1.0.0 | 9/18/2024 | Removed mustsupport and updated version numbers on these extensions |
| all profiles | .meta element The MustSupport flag on this element has been relaxed in this version until further confirmation of the use of meta.profile (outside of use for certain validation suites) and impact can be assessed by the working group. Please note that this relaxation is based on the IG Best Practices highlighted here of avoiding forcing the mustSupport constraint on .meta in profiles unless absolutely necessary. |
||
| all profiles | .coding Elements .coding.system and .coding.display have been relaxed, while the elements .coding and .coding.code will maintain their constraints as discussed within the eReferral interoperability working group, pending further discussion based on the mustSupport definition (TBC). |
Terminology Updates
| VALUE SET/CODE SYSTEM | VERSION No. | DATE | SUMMARY OF CHANGE |
|---|---|---|---|
| MessageChangeReasonCode | 1.1.0 | 4/15/2025 | Added MessageChangeReasonCode valueset to MessageHeader.reason to provide context on the trigger for ‘notify-update’ messages |
| PreferenceTypeCode | 1.1.0 | 4/15/2025 | Used with the ServiceProviderPreference extension to indicate a preference type |
| All valueSets | 9/18/2024 | ValueSets were refined to include correct canonicals, with Canada Health Infoway owned codesystems created for each valueSet (with exception of human-language valueSet). Version numbers were removed | |
| CommunicationBarrier | 0.1 | 11/28/2023 | Replaced eHealthOntario ValueSet Canonical with IGuide Canonical convention, still includes codes from https://ehealthontario.ca/fhir/CodeSystem/communication-barrier until further feedback from the eReferral Interoperability Working Group is collected to address the impact of changing the code system on production systems |
| CommunicationCategory | 0.1 | 11/28/2023 | Replaced eHealthOntario ValueSet Canonical with IGuide Canonical convention, still includes codes from https://ehealthontario.ca/fhir/CodeSystem/communication-category until further feedback from the eReferral Interoperability Working Group is collected to address the impact of changing the code system on production systems |
| DARC and DART Reasons | 0.1 | 11/28/2023 | Replaced eHealthOntario ValueSet Canonical with IGuide Canonical convention, still includes codes from https://ehealthontario.ca/fhir/CodeSystem/darc-dart-reason until further feedback from the eReferral Interoperability Working Group is collected to address the impact of changing the code system on production systems |
| eReferralIdentifierType | 0.1 | 11/28/2023 | Replaced eHealthOntario ValueSet Canonical with IGuide Canonical convention, still includes the code from http://ehealthontario.ca/fhir/CodeSystem/ereferral-identifier-type until further feedback from the eReferral Interoperability Working Group is collected to address the impact of changing the code system on production systems |
| HumanLanguage | 0.1 | 11/28/2023 | Replaced eHealthOntario ValueSet Canonical with IGuide Canonical convention |
| MessageEventCode | 0.1 | 11/28/2023 | Replaced eHealthOntario ValueSet Canonical with IGuide Canonical convention, still includes codes from https://ehealthontario.ca/fhir/CodeSystem/message-event-code until further feedback from the eReferral Interoperability Working Group is collected to address the impact of changing the code system on production systems |
| PatientContactRelationships | 0.1 | 11/28/2023 | Replaced eHealthOntario ValueSet Canonical with IGuide Canonical convention, still includes codes from http://ehealthontario.ca/fhir/CodeSystem/patient-contact-relationship until further feedback from the eReferral Interoperability Working Group is collected to address the impact of changing the code system on production systems. Note that these codes in particular may also evolve as part of the requirements for emergency contact relationship codes in the pan-Canadian Health Data Content Framework |
| TaskBusinessStatus | 0.1 | 11/28/2023 | Replaced eHealthOntario ValueSet Canonical with IGuide Canonical convention, still includes codes from https://ehealthontario.ca/fhir/CodeSystem/task-business-status until further feedback from the eReferral Interoperability Working Group is collected to address the impact of changing the code system on production systems |
| TaskCode | 0.1 | 11/28/2023 | Replaced eHealthOntario ValueSet Canonical with IGuide Canonical convention, still includes codes from https://ehealthontario.ca/fhir/CodeSystem/task-code until further feedback from the eReferral Interoperability Working Group is collected to address the impact of changing the code system on production systems |
Package Downloads
| Description | Guide | Package Details | TGZ |
|---|---|---|---|
| v1.0.3 DFT Projectathon | Zipped copy of HTML iGuide | ca.infoway.io.erec 1.0.3-dft-projectathon | ca.infoway.io.erec 1.0.3-dft-projectathon.tgz |