It’s Digital Health Week! Join the celebration. more >

Share this page:

Health Level Seven International (HL7)
Keep up to date and get involved in the latest from HL7 International, the HL7 Canada Constituency, the HL7 Canada Council, and the pan-Canadian messaging standards.
Members: 238
Contact: Joel Francis
Type: Open
Access: Public
Keep up to date and get involved in the latest from HL7 International, the HL7 Canada Constituency, the HL7 Canada Council, and the pan-Canadian messaging standards.

About

What is the HL7 Community?

The HL7 Community is a place to share lessons learned and learn about new and existing HL7 Standards implemented in Canada, such a version 2, version 3, CDA and FHIR.

This community is where requests to make changes to any of the pan-Canadian messages occur and where implementers come for OID requests in Canada or find Canadian OIDs in the HL7 OID Registry.

Canada is proud to have a thriving HL7 Canada Constituency and actively participates in HL7 Ballots.

To become a member of this community select Join Group in the Group Menu.

LEADER

Ron Parker - Chair, HL7 Canada

Parker Digital Health Consulting Inc

KEY RESOURCES

HL7 Artifacts (Standards, Release notes, Education etc)

Activity

The OIDs have now been deprecated. Igor/Cindy, 2.16.840.1.113883.3.239.13.17 has been registered - College of Chiropodists of Ontario
Dear Community members, Please join us on November 27 at 11:00 AM ET to learn about the subset maintenance process and contribute to the review and identification of subsets that may no longer be required for pan-Canadian use. This session will be of interest to the HL7, Health Terminologies and Public Health Communities as well as primary health care system users and those supporting an iEHR. A detailed description of the webinar and the Zoom/Teleconference details can be found here: https://infocentral.infoway-inforoute.ca/en/news-events/event-calendar/icalevent.detail/2018/11/27/708/-
Joel, please let us know when this change is done as we would also need to update the OID in the URI Registry: https://simplifier.net/canadianuriregistry/ca-on-registration-chiropodist
The linked PDF documents below contain announcements relevant to the upcoming regular-schedule January 2019 ballot cycle being held by HL7 International, before the upcoming January 2019 WGM running January 12-18 in San Antonio TX USA. This is in addition to the two specifications announced for an early 2019 January cycle, which is a closed pool. Deadline for Consensus Group and Review Groups signup Consensus Group Sign-Up Open Date: Monday, November 5, 2018 Consensus Group Sign-Up Close Date: Thursday, December 6, 2018 HL7 members and others interested in signing up for a consensus or review group in the January 2019 Ballot Cycle should be aware of the deadline for ballot pool sign up. For this cycle, the consensus or review group signup deadline is Thursday, December 6, 2018. This deadline also applies to non-members who wish to sign up for non-member participation in a ballot cycle. Ballot signup is now available on the HL7 Ballot Desktop at: http://www.hl7.org/ctl.cfm?action=ballots.home 1 - ANNOUNCEMENT OF THE FORMATION OF CONSENSUS GROUPS FOR THE HL7 JANUARY 2019 BALLOT CYCLE HL7 is pleased to announce the consensus groups and dates for ballot openings for the 2019 January Ballot Cycle. The candidate standards and other documents in the announcement are associated with the following standard classifications: • Clinical Document Architecture (CDA®) • HL7 Cross-Product Family Specifications, Domain Analysis Models and Implementation Guides • Electronic Health Records (EHR) • Fast Healthcare Interoperability Resources (FHIR®) • Version 2 Messaging • Version 3 Messaging Ballot Open Date: Friday, December 7, 2018 Ballot Close Date: Monday, January 7, 2019 For the full announcement, please download the PDF from the following link: http://www.hl7.org/documentcenter/public/ballots/2019JAN/Announcements/Formation%20of%20Consensus%20Groups%20for%202019%20January%20Ballot%20Cycle.pdf Please note that several of the document pools listed are contingent upon the completion of related reconciliation activities, in accordance with HL7 policy. In addition, the final names and/or ballot levels of several pools are contingent upon Technical Steering Committee approval. 2 - ANNOUNCEMENT OF THE FORMATION OF REVIEW GROUPS FOR REAFFIRMATION OF EXPIRING HL7 AMERICAN NATIONAL STANDARDS HL7 is pleased to announce the formation of review groups for the reaffirmation ballots of HL7 American National Standards (ANS): • Reaffirmation of HL7 Healthcare Privacy and Security Classification System, Release 1 • Reaffirmation of HL7 Service-Aware Interoperability Framework: Canonical Definition Specification, Release 2 • Reaffirmation of HL7 Version 3 Implementation Guide: Context-Aware Knowledge Retrieval Application (Infobutton), Release 4 • Reaffirmation of HL7 Version 3 Standard: Identification Service (IS), Release 1 • Reaffirmation of HL7 Version 3 Standard: Patient Registry, Release 1 • Reaffirmation of HL7 Version 3 Standard: Personnel Management, Release 1 • Reaffirmation of HL7 Version 3 Standard: Pharmacy CMETs, Release 1 • Reaffirmation of HL7 Version 3 Standard: Pharmacy; Medication CMET, Release 1 • Reaffirmation of HL7 Version 3 Standard: Pharmacy; Medication Dispense and Supply Event, Release 2 • Reaffirmation of HL7 Version 3 Standard: Pharmacy; Medication Order, Release 2 • Reaffirmation of HL7 Version 3 Standard: Privacy, Access and Security Services; Security Labeling Service, Release 1 • Reaffirmation of HL7 Version 3 Standard: Retrieve, Locate, and Update Service (RLUS), Release 1 • Reaffirmation of HL7 Version 3 Standard: Scheduling, Release 2 • Reaffirmation of HL7 Version 3 Standard: Security and Privacy Ontology, Release 1 • Reaffirmation of V3: Context-Aware Retrieval Application (Infobutton); Knowledge Request, Release 2 Per ANSI rules, any ANS subject to periodic maintenance should be revised, reaffirmed or withdrawn five years after its designation as an ANS. Accordingly, HL7 is seeking interested individuals to take part in the Reaffirmation ballots described in the linked document. Review Group Ballot Open Date: Friday, December 7, 2018 Review Group Ballot Close Date: Monday, January 7, 2019 For the full announcement, please download the PDF from the following link: http://www.hl7.org/documentcenter/public/ballots/2019JAN/Announcements/Formation%20of%20Reaffirmation%20Review%20Groups%20for%202019%20January%20Ballot%20Cycle.pdf 3 - ANNOUNCEMENT OF THE FORMATION OF REVIEW GROUPS FOR WITHDRAWAL OF EXPIRING HL7 AMERICAN NATIONAL STANDARDS HL7 is pleased to announce the formation of review groups for the withdrawal ballots of HL7 American National Standards (ANS): • Withdrawal of HL7 Version 3 Standard: hData Record Format, Release 1 • Withdrawal of IDMP - Dose Forms, Units of Presentation and Routes of Administration, Release 1 • Withdrawal of IDMP - Pharmaceutical Product Information, Release 1 • Withdrawal of IDMP - Regulated Medicinal Product Information, Release 1 • Withdrawal of IDMP - Substances, Release 1 • Withdrawal of IDMP - Units of Measure, Release 1 Per ANSI rules, any ANS subject to periodic maintenance should be revised, reaffirmed or withdrawn five years after its designation as an ANS. Accordingly, HL7 is seeking interested individuals to take part in the Withdrawal ballots described in the linked document. Withdrawal Review Group Ballot Open Date: Friday, December 7, 2018 Withdrawal Review Group Ballot Close Date: Monday, January 7, 2019 For the full announcement, please download the PDF from the following link: http://www.hl7.org/documentcenter/public/ballots/2019JAN/Announcements/Formation%20of%20Withdrawal%20Review%20Groups%20for%202019%20January%20Ballot%20Cycle.pdf
Hi Cindy, Yes, we can deprecate 2.16.840.1.113883.3.239.13.61 and register 2.16.840.1.113883.3.239.13.17. Please email standards@infoway-inforoute.ca accordingly. I would advise all those concerned to note the change and make necessary alterations to their systems. Thanks, Joel
Hi Joel, We noticed the other OID for College of Chiropodists of Ontario (2.16.840.1.113883.3.239.13.61) previously registered by eHealth Ontario has been deprecated in our local OID registry, and 2.16.840.1.113883.3.239.13.17 is used instead in eHealth Ontario assets as the assigning authority for the registration numbers issued by College of Chiropodists of Ontario. In addition to 2.16.840.1.113883.4.772 outlined below, can we please also deprecate 2.16.840.1.113883.3.239.13.61, and register 2.16.840.1.113883.3.239.13.17 for College of Chiropodists of Ontario? Thanks Cindy

Events



Upcoming events:
Tue Dec 04 @12:00PM - 01:00PM
HL7 Canada Community Call
Tue Jan 01 @12:00PM - 01:00PM
HL7 Canada Community Call
Tue Feb 05 @12:00PM - 01:00PM
HL7 Canada Community Call

Forum

More duplicate OIDs for deprecation 11/15/18
Thank you Joel!
More duplicate OIDs for deprecation 11/15/18
The OIDs have now been deprecated. Igor/Cindy, 2.16.840.1.113883.3.239.13.17 has been registered - College of Chiropodists of Ontario
Upcoming meeting on Nov 27, 2018 at 11am ET: Infoway Annual Subset Maintenance Review 11/09/18
Dear Community members, Please join us on November 27 at 11:00 AM ET to learn about the subset maintenance process and contribute to the review and identification of subsets that may no longer be required for pan-Canadian use. This session will...
More duplicate OIDs for deprecation 11/09/18
Joel, please let us know when this change is done as we would also need to update the OID in the URI Registry: https://simplifier.net/canadianuriregistry/ca-on-registration-chiropodist
HL7 International Announcement of Consensus Groups for January 2019 Ballot Cycle 11/07/18
The linked PDF documents below contain announcements relevant to the upcoming regular-schedule January 2019 ballot cycle being held by HL7 International, before the upcoming January 2019 WGM running January 12-18 in San Antonio TX USA. This is in add...
More duplicate OIDs for deprecation 11/07/18
Hi Cindy, Yes, we can deprecate 2.16.840.1.113883.3.239.13.61 and register 2.16.840.1.113883.3.239.13.17. Please email standards@infoway-inforoute.ca accordingly. I would advise all those concerned to note the change and make necessary alterations...
More duplicate OIDs for deprecation 11/07/18
Hi Joel, We noticed the other OID for College of Chiropodists of Ontario (2.16.840.1.113883.3.239.13.61) previously registered by eHealth Ontario has been deprecated in our local OID registry, and 2.16.840.1.113883.3.239.13.17 is used instead in e...
HL7 Sept 2018 Plenary and WG Report 11/06/18
Hello again everyone: You can find the presentation from our Nov 6th HL7 Meeting .... Ron Parker, HL7 Canada Affiliate Chair
Jan 2019 Ballot Comment Spreadsheet Templates 11/06/18
Hello everyone: There is a small ballot underway for Jan 2019 of 2 FHIR standards. Balloting begins Nov 6th and closes Dec 6th. Please see ... on the HL7 FHIR site for detailed information. You and find the Excel comments spreadsheet templa...
More duplicate OIDs for deprecation 11/05/18
Hi All, Following are more duplicate OIDs that will be deprecated. I urge the concerned parties to please make the necessary changes or raise any concerns as soon as possible: 2.16.840.1.113883.3.8024 - College of Dietitians of British Columbia...
Consolidated list of duplicated OIDs for decprecation 11/02/18
The OIDs have been retired
BC Synoptic Reporting Implementation Update: Nov 29 at noon ET 11/01/18
The Health Terminologies community will be hosting an update from BC on their implementation of synoptic reporting across the province. Everyone is welcome. Event details can be found here: https://infocentral.infoway-inforoute.ca/en/news-event...
Agenda for Nov 6th HL7 Canada Community Meeting 10/31/18
Hello everyone: Our next ... is at 12 noon Eastern time, November 6th. The proposed agenda is: Welcome and Agenda Review (Ron P. 5 min) Report on the HL7 Sept 2018 Plenary and Working Group Meeting in Baltimore (Ron P. 35 min) "Ear...
Consolidated list of duplicated OIDs for decprecation 10/30/18
Hi All, The following is a consolidated list of OIDs that were found to be duplicated and that will be deprecated in the HL7 OID Registry: 2.16.840.1.113883.4.746 - College of Alberta Psychologists 2.16.840.1.113883.3.8025 - College of Dietici...
HL7 OID and FHIR URI/Resource issues - need for formal governance processes 10/26/18
I second to add the review of OIDs request process in our next HL7 meeting agenda on November 6th.

Tasks


Tasks


Time Tracking


Gantt

Documents

Click Manage documents to:

  • view the complete list of documents or documents grouped by folder
  • upload a new document

Note: Group members are not currently notified when new documents are added. To notify others, you must post the URL to the new document in the forum. (Notification of document uploads is a feature in development.)

Manage documents You may need to login and/or be a member of the group to access this content.

Implementation ( 8 Documents )

Documents for implementers of HL7 v3. For context, see HL7 standards page.

Video

The PrescribeIT Stack: Implementation

Learn more about the resources and support available to PrescribeITTM implementers. This overview of the implementation guide for PrescribeITTM Presenters: Andrew Liu, Director, PrescribeITTM Service Management Dean Matthews, e-Prescribing Business Operations Lead

01/23/18

Solutions

  • Canadian FHIR Registry
  • Canadian URI Registry
  • FHIR Terminology Service API
  • HAPI FHIR
  • HAPI v2
  • HL7 Explorer
  • InfoRMS
  • Message Builder
  • Message ReMixer
  • Object Identifier (OID)
  • SNOMED CT Browser
  • Terminology Gateway
  • Terminology Service API
  • TermWorks
  • WebHook Notifications

The Canadian FHIR® Registry supports collaborative development in an effort to accelerate sustainable growth of FHIR, locally and internationally. The registry will be the home of national FHIR profiles recommended for use in Canada, including extensions, value sets, URIs and other useful, commonly used components. It is also host to a growing number of national, jurisdictional and locally shared FHIR projects, and is open to all Canadian implementers.

The Canadian FHIR Registry offers:

  • seamless integration of profile editing using Forge (free FHIR profile editor)
  • designated project space
  • supports project teams of up to 100 individuals
  • online authoring of implementation guides
  • integration with source control tools such as GitHub
  • version controlled environment

The Canadian FHIR Registry blends software development best practices with the requirements of modelling in FHIR, essential to delivering successful project requirements while having continuous access to structure validation, rendering and publishing.

All project artifacts are backed up weekly, on Sunday nights. Each snapshot will be retained for 10 days. The project owner can request an as-is snapshot containing all the necessary artifacts such as text, xml, json, md and image files by contacting This email address is being protected from spambots. You need JavaScript enabled to view it..

Organization projects can be viewed without logging in. To edit or request a new project, This email address is being protected from spambots. You need JavaScript enabled to view it. with the details.

View projects in the Canadian FHIR Registry

The Canadian URI Project is a repository of identifier and code system namespaces. Capturing key metadata as FHIR® NamingSystem resources provides an automatic mapping of OIDs to URIs or vice versa.

To make the discovery of these artifacts more flexible, the Canadian URI Registry (alpha) was developed to allow artifacts to be queried via plain text, OID, URI or their respective identifiers. These identifiers are created according to the URI guidelines and posted to the FHIR Solution Architecture Workstream for approval.

It is important to note that all searchable artifacts are to be curated via the Canadian URI Project in Simplifier. There are ongoing discussions with the FHIR Solution Architecture Stream to have a single representative manage data for their respective jurisdictions.

A scheduled task is run periodically, making all new or modified artifacts searchable after a 20 minute window.

Search the Canadian URI Registry (alpha)

FHIR web services used to access terminology data

FHIR Terminology Service APIs enable automated exchange of clinical terminology content and resources. It allows developers to easily implement healthcare applications that programmatically consume codes and subsets without requiring in-depth expertize in the fine details of terminology.

terminology gateway APIFHIR Terminology Service API

 

Open source integration tools useful for health IT integration projects

HAPI FHIR® is a simple-but-powerful library for adding FHIR messaging to applications. It is pure Java compatible and licensed under the business-friendly Apache Software License, version 2.0.

HAPI FHIR

 

External Solutions for API integration

Open source integration tools useful for health IT integration projects.

HAPI v2
 

HAPI for HL7 v2 messages is an open-source, object oriented HL7 v2.x parser developed for the Java platform

HAPI FHIR
 

HAPI FHIR is a simple-but-powerful library for adding FHIR messaging to your application. It is pure Java compatible and licensed under the business-friendly Apache Software License, version 2.0.

Open source integration tool useful for health IT integration projects

HAPI for HL7 v2 messages is an open-source, object oriented HL7 v2.x parser developed for the Java platform.

HAPI v2

Enhanced browsing of HL7 v3

Infoway HL7 Explorer is a powerful browser for HL7 v3 structures, vocabulary and references. Used in conjunction with the pan-Canadian releases, HL7 Explorer makes locating details and information more efficient.

In November 2017, the Canadian HL7 InfoCentral community determined that there was no longer any need to do further updates to the pan-Canadian Version 3 messages. As a result, the December 2012 releases of MR02.06.01 and CeRx 4.4.2 are the latest pan-Canadian publications of these standardized messages.

The HL7 Explorer, the Master Terminology Worksheet (MTW) and all other messaging related artifacts are aligned with the latest releases.

Overview
 

Learn about the features HL7 Explorer: search once, graphical representation, quick hints, etc.

MR 02.06
 

HL7 Explorer applied to the MR 02.06 HL7 v3 maintenance release

CeRx 4.4.2
 

HL7 Explorer applied to the CeRx 4.4.2 HL7 v3 maintenance release

 

 

Standards versions available for viewing in HL7 Explorer

Standard URL 
CA MR 02.06 https://infocentral.infoway-inforoute.ca/extra/ca/mr0206-html/html/search.html
CA MR 02.05.01 https://infocentral.infoway-inforoute.ca/extra/ca/mr020501-html/html/start.html
CA MR 02.05 https://infocentral.infoway-inforoute.ca/extra/ca/mr0205-html/html/start.html
CA MR 02.04.03 https://infocentral.infoway-inforoute.ca/extra/ca/mr020403-html/html/start.html
CA CeRx 4.4.2 https://infocentral.infoway-inforoute.ca/extra/ca/cerx442-html/html/search.html
CA CeRx 4.4.1 https://infocentral.infoway-inforoute.ca/extra/ca/cerx441-html/html/start.html 
CA CeRx 4.4 https://infocentral.infoway-inforoute.ca/extra/ca/cerx44-html/html/start.html
BC V02R04 https://infocentral.infoway-inforoute.ca/extra/bc/v02r04-html/html/start.html
NS CeRx 4.3 https://infocentral.infoway-inforoute.ca/extra/ns/cerx43-html/html/start.html
NS R02.04.03 https://infocentral.infoway-inforoute.ca/extra/ns/r020403-html/html/start.html
AB MR2007 https://infocentral.infoway-inforoute.ca/extra/ab/mr2007-html/html/start.html
AB R02.04.03 https://infocentral.infoway-inforoute.ca/extra/ab/r020403-html/html/start.html
AB R02.04.00 SHR https://infocentral.infoway-inforoute.ca/extra/ab/r020400-shr-html/html/start.html
AB R02.04.03 Imm https://infocentral.infoway-inforoute.ca/extra/ab/r020403-imm-html/html/start.html

Request Management Solution

InfoRMS (Infoway Request Management System) is Infoway's Request for Change Tool for SNOMED CT, pCLOCD/LOINC and pan-Canadian Subsets. Not sure if you have access to InfoRMS? Manage your InfoRMS Access in your user profile.
SNOMED CT
 

Prior to submitting a SNOMED CT request, it is the requestor's responsibility to:

  1. Validate that the content does not exist in either the International or Canadian editions of SNOMED CT
  2. Comply with the appropriate Editorial Guidelines

Submit or follow requests to SNOMED CT

pCLOCD/LOINC
 

Prior to submitting a pCLOCD/LOINC request, it is the requestor's responsibility to:

  1. Validate that the content does not exist in LOINC or the pCLOCD
  2. Comply with Regenstrief Editorial Guidelines (note: login required)

Submit or follow requests to pCLOCD/LOINC

pan-Canadian Subsets
 

Prior to submitting a Subset request, it is the requestor's responsibility to:

  1. Validate the content against the subsets in Terminology Gateway
  2. Comply with the appropriate proper terminology Editorial Guidelines

Submit or follow requests to pan-Canadian Subsets

 

Solution for API integration

Infoway Message Builder allows developers to focus on the business challenges of integrating their solutions with each electronic health record implementation by abstracting the differences between different versions of pan-Canadian HL7 messaging and supporting current implementation constraints. Developers can build interfaces in a familiar development environment, using the programming language of their choice*, while the Message Builder API fosters quick and easy creation, population and access to HL7v3 requests and responses.

Infoway Message Builder v2.0 and later is enhanced to generate JAVA APIs to create, validate, marshal/unmarshal CDA documents.

 Implementation and Exchange

 

Key features and benefits

Message Builder offers a number of key features and benefits:

  1. Abstracts the complexity of HL7v3 messages and greatly simplifies the work of the developer when implementing them;
  2. Reduces the impact on developers from implementation variations;
  3. Enables companies to achieve Infoway product certification with greater confidence and reduced time;
  4. Enables developers to incorporate future message versions without re-writing their products;
  5. Can be embedded in software applications due to its open source distribution under a commercial-friendly Apache 2.0 license.

Out of the box support

Infoway Message Builder comes with built-in runtime APIs that support a number of pan-Canadian specifications:

  • MR2009 (R02.04.02)
  • MR2007 (V02R02)
  • MR 2007 (V02R01)
  • CeRx (V01R04.3)

In addition, while developers can easily build custom transport mechanisms without affecting the core, Message Builder includes native support for SOAP and RESTful message transports. Developers can configure and extend the transport as desired.

Detailed product features

  • Provides the capability to configure and populate message values that are common to all messages—this allows developers to reuse common message data, shortening the time to configure and create an interoperable system.
  • Uses simplified data types that are natural and familiar to the programming language (e.g. String for ST) rather than directly exposing the sometimes complicated HL7v3 data types—yet still allowing access to HL7v3 data types when necessary.
  • Allows developers to focus on the business-aspect of a request/response, avoiding many of the complexities of HL7v3.
  • Code-generation algorithms merge identical and similar classes together to simplify the generated API—meaning less confusion in the resulting code and an increased ability to write generic handlers for certain types.
  • Converts populated objects into HL7v3 XML requests, and converts HL7v3 responses into populated objects.
  • Provides flexibility in configuring and performing terminology-code lookups, including code set and database-backed lookups (can mix and match).
  • Associations and attributes are strongly typed, given business names when provided, and contain code docs directly from the MIFs (see wiki.hl7.org/index.php?title=MIF).
  • The algorithms inline most classes that only have a small number of properties, further simplifying the API.
  • Offers both permissive and strict modes—permissive allows many common errors and generates appropriate error comments in the XML or result object.
  • A separate validation tool is provided to test ad-hoc messages—this tool reuses the same validation components that are executed during message marshaling and unmarshalling, ensuring consistent processing of the message whether during processing or during conformance validation.

Forward looking

The power of the Message Builder architecture is in its MIF-based generation of the specification API. With Message Builder, any MIF is supported—whether a future release of the pan-Canadian specifications or a modified (constrained) jurisdiction-specific release of an existing specification. 

 

How it works

Message Builder comprises two parts:

  1. Message Builder Generator—a tool used by Infoway to take input MIFs and create Message Sets for use by Message Builder Runtime;
  2. Message Builder Runtime—an API used by developers to allow their products to support multiple Message Sets without recoding.

Message Builder Generator

Used by Infoway, Message Builder Generator takes MIFs (as the source of truth for standards specifications) and converts them into a series of Java Classes. This is done by first converting the MIFs to an XML Message Set (a simplified representation of the information present in the original MIFs), then generating Java Classes that reference standard Java data types and use business-friendly names. In the process, groups of related elements are flattened and similar message parts are placed into a single class: these steps increase ease of use and reduce the complexity of the resulting Java Classes.

MBG process

Using Message Builder Generator, Infoway is able to create multiple Message Sets, each representing the MIFs used in a single jurisdiction, but all for the same HL7v3 version.

Message Builder Runtime

Message Builder Runtime allows developers to quickly adapt to implementations in multiple Jurisdictions: incoming messages are first examined to determine the corresponding source Message Set, once identified, a series of Java Objects that represent the message are instantiated. Next, the Java Objects are turned into an HL7 message for the HL7 version corresponding to the desired destination Message Set. 

MB process

Using Message Builder Runtime developers can accept messages over the wire and on-the-fly turn them into a different HL7 message version. Given the capability of Message Builder to support future versions of HL7 messages, developers can easily future proof their products with minimal effort.

 

*Developer friendly

The Message Builder libraries are available for Java and Microsoft .NET. In addition, a simplified XML message format is available with REST-based services for managing mapping to/from the simplified form to the target specification XML format.

 

CDA Support

Message Builder CDA API supports the following CDA and data type specifications:

Message Builder provides  JAVA and .NET APIs for CDA document creation, validation, marshalling/unmarshalling of the following CDA document types:

  • Continuity of Care Document (CCD) (Release 1.1)
  • Consultation Notes (Release 1.1)
  • Discharge Summary (Release 1.1)
  • Imaging Integration, and DICOM Diagnostic Imaging Reports (DIR) (Release 1)
  • History and Physical (H&P) (Release 1.1)
  • Operative Note (Release 1.1)
  • Progress Note (Release 1.1)
  • Procedure Note (Release 1)
  • Unstructured Documents (Release 1.1)
  • CDA documents using pan Canadian CDA header template

Clinical applications in JAVA or .NET can use the Message Builder CDA APIs to create, validate or parse above listed types of CDA documents. Potential use cases are document source or document consumer actors in IHE XDS profile, content creator/content consumer in any content module/profile, or report creator/viewer in RIS/PACS/EMR systems.

Message Builder is available for Java and .NET

Message Builder for Java

System Requirements

  • Java 1.5 or higher
  • Maven 3.0.3 or higher (can be removed after installing Message Builder if working with a non-Maven project)

Download

Message Builder is licensed under Apache License, Version 2.0. To use Message Builder, you will need

  1. Message Builder Core and
  2. one or more Message Builder API release(s)—depending on your implementation requirements.

Select a Message Builder Version:

 

Select one or more Message Builder API releases:

 

Optional Message Builder components:

Terminology Database Resolver
Message Builder Example

Message Builder pom.xml file:

 

Message Builder for .NET

System Requirements

  • .Net Framework 3.5 or higher

Download

Message Builder v2.1 for .NET

Message Builder is licensed under Apache License, Version 2.0. To use Message Builder:

  1. Download Message Builder .NET Core 2.1.0 setup
  2. Unzip and pull out the dll files that you need:
     \ → root location of required Message Builder core assemblies (Mandatory - required all)
     \releases\ → location of Message Builder release assemblies (Mandatory - choose one or more)
  3. Copy them to your .NET project 
  4. Download Message Builder .NET 3rd-Party libraries, unzip it, and copy the files to your .NET project

Message Builder v1.5.8.1 for .NET

Message Builder is licensed under Apache License, Version 2.0. To use Message Builder:

  1. Download Message Builder .NET Core 1.5.8.1 setup
  2. Unzip and pull out the dll files that you need:
     \ → root location of required Message Builder core assemblies (Mandatory - required all)
     \releases\ → location of Message Builder release assemblies (Mandatory - choose one or more)
  3. Copy them to your .NET project 
  4. Download Message Builder .NET 3rd-Party libraries, unzip it, and copy the files to your .NET project

Message Builder v1.4.6 for .NET

Message Builder is licensed under Apache License, Version 2.0. To use Message Builder, you will need

  1. Download Message Builder .NET Core 1.4.6 setup
  2. Unzip and run SetupCore.msi file
  3. Choose a installation location <install dir>.  The setup execution should place the following directories in <install dir>:
     \lib\ → location of required Message Builder core assemblies (Mandatory - required all)
      \releases\ → location of Message Builder release assemblies (Mandatory - choose one or more)
     \src\ → location of all source code and project files required to load them into visual studios
     \debug\ → location of debug symbol files
  4. Pull out files the dll files from the \lib\ and \releases\ folders, and copy them to your .NET project 
  5. Download Message Builder .NET 3rd-Party libraries, unzip it, and copy the files to your .NET project

Localization of pan-Canadian Standards

Infoway Message ReMixer is a web-based application that allows for the localization of pan-Canadian Standards (pCS) messages to meet jurisdictional requirements, all while maintaining the integrity of the original, standard message.

msg remixerAccess Message ReMixer Now

 Implementation and Exchange

Jurisdictional ReMixes

Pan-Canadian Standards use Object Identifiers (OIDs) to distinguish between objects by assigning a numeric string that enables other systems to understand the unique information that is being shared between various systems.

Canada Health Infoway has an arrangement in place with HL7 International that allows Infoway to submit OIDs to HL7 International on behalf of Canadian Implementers free of charge. There is a $250 USD fee per OID request if done directly with HL7 International.

To submit an OID, download the registration form that corresponds to your OID request. Email the completed form to This email address is being protected from spambots. You need JavaScript enabled to view it.

Browse International and Canadian Content

SNOMED International's SNOMED CT browser allows users to browse and search the SNOMED CT International Edition to explore concepts and relationships. It also provides access to browse national extensions from SNOMED International member countries including the Canadian Edition of SNOMED CT in English and French.

snomed browser Browse SNOMED CT Now

 General Documentation

Browse, download and leverage the terminology used in Canada

Terminology Gateway is a web based solution framework that enables the distribution and sharing of terminology concepts, subsets and concept maps, making them available for web browsing, download or real time query.

terminology gatewayBrowse Terminology Gateway Now

RESTful web services used to browse terminology data

Terminology Service RESTful APIs enable automated exchange of clinical terminology content and resources. It allows developers to easily implement healthcare applications that programmatically consume codes and subsets without requiring in-depth expertise in the details of terminology.

terminology gateway APITerminology Service API

 

Apelon’s TermWorks is an easy-to-use data mapping solution that is provided by request (free of charge) to individuals who have Standards Access. It brings powerful terminology capabilities directly to the desktop. TermWorks combines Microsoft® Excel® spreadsheet software with web services-based terminology processing to give organizations comprehensive mapping capability to SNOMED CT and the Canadian Edition of SNOMED CT.

 

knowing Learn More

  • This email address is being protected from spambots. You need JavaScript enabled to view it.
  • SNOMED CT Education
  • Apelon User Guide
  • Infoway User Installation Guide
  • How does TermWorks Work?
  • TermWorks FAQs

Automated notifications of new content in Terminology Gateway

A WebHook is an HTTP callback. When new content is published in the Terminology Gateway, a publishing event will be POSTed to each registered WebHook, notifying their respective owners about the publication.

WebHook registration

Individual users can register for WebHook notifications by sending an email to: This email address is being protected from spambots. You need JavaScript enabled to view it. and specifying the WebHook endpoint. Upon registration, a unique api_id will be assigned to the WebHook. Each notification POSTed by the Terminology Gateway will contain the api_id, allowing the endpoint to verify that the notification was indeed issued by the Terminology Gateway. The api_id must be echoed back by the WebHook endpoint in the body of the notification response.

WebHook interface

The WebHook endpoint must serve HTTP requests conforming to the following interface:

HTTP Request

{
  "api_id": "cb570e5a2748f349f9119431db836b3a23fdb6571afee34c0432d87220f2431b",
  "base_url": "https://termapi.infoway-inforoute.ca/rest/v1/",
  "notification_time": "2017110711:07:00",
  "targets": [
    {
      "id": "2.16.840.1.113883.2.20.6.1",
      "name": "Canadian Clinical Drug Data Set (CCDD)",
      "type": "package",
      "version": "20171016",
      "effective_date": "20171016",
      "publication_time": "2017103015:20:23",
      "message": "Monthly CCDD update for October 2017"
    },
    {
      "id": "2.16.840.1.113883.2.20.3.443",
      "name": "PrescribeIT",
      "type": "package",
      "version": "LPR2",
      "effective_date": "20171103",
      "publication_time": "2017110309:37:22",
      "message": "PrescriptionMedicinalCode version reflecting the October 2017 CCDD update"
    }
  ]
}
				
  • api_id: as previously mentioned, each notification POST contains the api_id granted at registration.
  • base_url: the base URL for the native REST API endpoint of the originating system. This can be used to call back the Terminology Gateway via APIs in order to programmatically download updated content.
  • notification_time: the timestamp of the WebHook notification in yyyyMMddHH:mm:ss format.
  • targets: list of updated targets. Each entry in this array corresponds to a Terminology Gateway artifact (subset, codesystem, map, package) that was updated and is therefore subject to the notification. The target list will only include artifacts for which the user has registered to receive notifications. Users can register to receive notifications about content updates using the Terminology Gateway User Interface or by invoking the native REST APIs.

    Each of the notification targets contains the following fields:
    • id: the artifact id, typically an OID
    • name: the artifact name
    • type: the artifact type: subset, codesystem, package or map
    • version: the published version id
    • effective_date: the effective date associated to the artifact version, in yyyyMMdd format
    • publication_time: the publication time in yyyyMMddHH:mm:ss format
    • message: optional message describing the published artifact version

HTTP Response

HTTP Response code: 200 for success, any other response code will be interpreted as an error
Sample HTTP Response Body:

{
  "api_id": "cb570e5a2748f349f9119431db836b3a23fdb6571afee34c0432d87220f2431b",
  "result": "success",
  "message": "Successful processing of the WebHook notification"
}
  • api_id: as previously mentioned, each notification response must echo back the api_id granted at registration.
  • result: success if the web hook notification was successful, any other value will be interpreted as an error.
  • message: optional response message.


Error handling

When receiving an error as a result of a WebHook notification, the Terminology Gateway will retry the notification four times at 15 minutes intervals. If still unsuccessful after four notification attempts, the system will drop the notification and will notify the user by email that the WebHook couldn't be invoked.

Sample code

Demo code for a sample WebHook endpoint can be found here: 

https://github.com/CanadaHealthInfoway/tgateway-webhook

Web Conference

Please login to acquire access to the InfoCentral web conferencing.

Members

Joel Francis
Canada Health Infoway
OFFLINE
Contact
Linda Monico
Canada Health Infoway
ONLINE
Admin
Andrea MacLean
Canada Health Infoway
OFFLINE
Admin
Kathleen McCaffrey
Interior Health
OFFLINE
Member
Parul Sinha
n/a
OFFLINE
Member
Lentic Li
University of Victoria
OFFLINE
Member
Deepti Razdan
cd-ed
OFFLINE
Member
Alvy Hou
Ryerson U
OFFLINE
Member
Anastazja Krawczyk
n/a
OFFLINE
Member
Adam Kepecs
n/a
OFFLINE
Member
Oneil Blair
University of Alberta Hospital
OFFLINE
Member
Pierre-Adelin Rucart
CHU Ste Justine, Montréal
OFFLINE
Member
Joe Mayer
Duality Professional Services
OFFLINE
Member
Brion Muldoon
NA
OFFLINE
Member
David Bissessar
N/a
OFFLINE
Member

Only 15 more minutes until the virtual screening of Falling Through the Cracks: Greg's Story. Make sure to access t… https://t.co/0UIjFwDgGA

by Infoway

logo 1

Improving the quality of patient care through the effective sharing of clinical information among health care organizations, clinicians and their patients.



Login Register