Share this page:

Integrating the Healthcare Enterprise (IHE)


Health care and health information professionals collaborating to improve information sharing between health care technology systems.
Members: 210
Contact: Derek Ritz
Type: Open
Access: Public
Health care and health information professionals collaborating to improve information sharing between health care technology systems.

About

What is IHE?

Unlike HL7 (or ISO, or SNOMED, or WHO, etc.), IHE is not a health informatics standards development body. Rather, IHE is a standards profiling body. IHE Profiles are implementation guides – they make standards digestible, usable, and implementable. They describe, at a conformance-testable level of detail, how a portfolio of underlying standards will be employed to address the ecosystem-wide interoperability issues associated with a specific set of healthcare use cases. IHE Profiles create re-usable, digital health building blocks by “packaging up” the 5C’s:

  • Care context
  • Content specs
  • Coding specs
  • Communications specs
  • Confidentiality and security specs

The target audience for an IHE profile is the entire care delivery network. This especially includes the jurisdictional governance entities that are tasked with operationalizing plug-and-play interoperability between disparate network participants. IHE is focused on taking digital health interoperability to scale and to mitigating the risks inherent in such an effort.

What is the IHE Community?

The IHE Community is a place where health care professionals and the health information industry collaborate to improve the way health care technologies and systems share information.

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

If you have an idea for a community, working group or project that will drive interoperability forward, let us know! Send your suggestions

LEADER

Derek Ritz, P.Eng., CPHIMS-CA
ecGroup Inc.

KEY RESOURCES

IHE Resources

Activity

Bonjour, J'ai traduit en français la vidéo originale ( anglais ... ) de Derek Ritz. Maintenant on a une vidéo équivalente en français : ... . Cette vidéo d'introduction permet de facilement partager ce qu'est IHE Canada. Cordialement, Daniel

David Anderson joined a group

Integrating the Healthcare Enterprise (IHE) Logo
Health care and health information professionals collaborating to improve information sharing between health care technology systems.

Philippe Léger joined a group

Integrating the Healthcare Enterprise (IHE) Logo
Health care and health information professionals collaborating to improve information sharing between health care technology systems.
Hello Everyone, Just a reminder that the webinar is tomorrow (September 23) at 12pm EST.
Hi all -- and happy autumn! I hope everyone had a good summer and is re-charged for the resumption of activities (including in-person meetings, again)! B) News FLASH: On September 10, IHE International published its new 2022 Strategic Plan! IHE's new strategy is pretty big news and will have important implications for Canada. I'm proud to say that, as IHE Canada Liaison, I was on the IHE Board subcommittee that drafted this new strategic plan. I had a chance to provide input regarding the things that are important to supporting Canada's uptake of the IHE Methodology and our adoption of Gazelle-supported Projectathons as both an instrument of INNOVATION and, eventually, as an instrument of GOVERNANCE. I'm happy to report that Canada's views and our national ambitions are well served by this new strategy. Please, it is a short read, so take a moment and look at what's new for IHE. The IHE Strategic Plan document can be found on IHE's website, ... I also prepared a short "bite-sized video" that explains the new plan in 300 seconds or less. The video is found.... I'll be hosting a webinar next Monday -- Sep-26, at noon EDT. The webinar will review and discuss the new IHE Strategy plus provide a short read-out of the Canadian delegation's activities at the IHE European Connectathon held last week in Montreux, Switzerland. At this event, bilateral meetings were held with the Swiss and Dutch delegations as well as informal meetings with UK, French, Czech and Belgian delegates. An enlightening "Future of Gazelle" meeting was also hosted by IHE Catalyst. Register for the webinar, here: https://infoway-inforoute.zoom.us/meeting/register/tZclc-6hrTMoHdGeiHWwAGtIirmHzcxQVjCJ I know it is short notice, but I hope many of you can attend the webinar. The strategy discussion and Connectathon readout will both be, I think, very relevant to our national digital health agenda and goals we have for pan-Canadian interoperability. See you Monday, :) Derek

IHE's new 2022 Strategic Plan - Monday Sep-26 noon EDT
Monday, September 26, 2022 12:00pm - 01:00pm

IHE Strategic Plan review webinar: Monday Sep-26 noon EDT This webinar will describe IHE's 2022 Strategic Plan and its implications for Canada and our national digiatl health agenda. Specific topics will include: Projectathon support Evidence-based care Value based health services Sustaining IHE's global public goods There will also be a short read-out of activities and discussions arising from the Canadian delegation's participation at the IHE European Connectathon, which was held last week in Montreux, Switzerland. At this event, bilateral meetings were held with the Swiss and Dutch delegations as well as informal meetings with UK, French, Czech and Belgian delegates. An enlightening "Future of Gazelle" meeting was also hosted by IHE Catalyst. Register for the webinar, here: https://infoway-inforoute.zoom.us/meeting/register/tZclc-6hrTMoHdGeiHWwAGtIirmHzcxQVjCJ

Richard Mutezintare joined a group

Integrating the Healthcare Enterprise (IHE) Logo
Health care and health information professionals collaborating to improve information sharing between health care technology systems.

Events



Upcoming events:

No events

Forum

Vidéo en français: Introduction à IHE en 300 secondes 10/01/22

Bonjour, J'ai traduit en français la vidéo originale ( anglais ... ) de Derek Ritz. Maintenant on a une vidéo équivalente en français : ... . Cette vidéo d'introduction permet de facilement partager ce qu'est IHE Canada. Cordialement, Dan...

Imaging AI and Its Impact in Real Life Webinar Friday September 23 09/22/22

Hello Everyone, Just a reminder that the webinar is tomorrow (September 23) at 12pm EST.

IHE has published a new Strategic Plan... and it has important implications. 09/20/22

Hi all -- and happy autumn! I hope everyone had a good summer and is re-charged for the resumption of activities (including in-person meetings, again)! B) News FLASH: On September 10, IHE International published its new 2022 Strategic Plan! IHE...

Imaging AI and Its Impact in Real Life Webinar Friday September 23 09/13/22

Dear Colleagues, Welcome back to a new season of Enterprise Imaging webinars. Upcoming webinar on the topic of 'Imaging AI and its Impact in Real Life". The webinar is scheduled for September 23 @ 12pm EST. Artificial intelligence (AI) in diagn...

What You Must Know about Cybersecurity for Healthcare and Imaging Webinar - May 13, 2022 04/29/22

Hi Everyone, The Canada Health Infoway EI Community will be having our final webinar series for this season. Our next webinar is on Friday May 13, 2022 12:00 PM Eastern Time (US and Canada) on the topic: "What You Must Know about Cybersecurity for...

Wed, Apr-20 noon ET: Review the draft IHE Canada annual report 04/27/22

Hi everyone -- this is to update the community regarding our 2022 IHE Canada annual report to the IHE International Board. The final version of the report is found, here: ... As an important note regarding this final version -- a small edit has...

Webinar This Week: "Privacy and Patient Health Data: Public Health and Big Data Perspectives" 04/21/22

Hi Everyone, Just a reminder that our next webinar is tomorrow on Friday April 22nd @ 12pm EST on the topic “Privacy and Patient Health Data: Public Health and Big Data Perspectives” Topic: Privacy and Patient Health Data #3 – Public Health and B...

Webinar This Week: "Privacy and Patient Health Data: Public Health and Big Data Perspectives" 04/21/22

Hi Everyone, Just a reminder that our next webinar is tomorrow on Friday April 22nd @ 12pm EST on the topic “Privacy and Patient Health Data: Public Health and Big Data Perspectives” Topic: Privacy and Patient Health Data #3 – Public Health and B...

Wed, Apr-20 noon ET: Review the draft IHE Canada annual report 04/20/22

Andrea -- thanks for the shout-out. I completely agree... there has been some really important progress this year and I truly will enjoy reporting on our IHE Canada community's great work to the IHE International Board. Thank you -- everyone -- for a...

Wed, Apr-20 noon ET: Review the draft IHE Canada annual report 04/20/22

Derek, my congratulations to the IHE Canada community on all of the accomplishments and great work listed in this years report. Each of those line items represents so much hard work, dedication and meaningful progress What a great celebratory rea...

pan-Canadian Health Data Strategy 04/20/22

Hello everyone, Eric Sutherland will be speaking on PHAC's pan-Canadian Health Data Strategy on our Enterprise Imaging Webinar: Privacy and Patient Health Data – Public Health and Big Data Perspectives on Friday. You may find the PHAC pan-Canadian H...

Wed, Apr-20 noon ET: Review the draft IHE Canada annual report 04/20/22

Hi all... this is a quick reminder of the IHE Canada draft review meeting coming up in an hour (noon ET, Apr-20). :) You can register to attend, .... A copy of the draft is available, here: ....

Webinar This Week: "Privacy and Patient Health Data: Public Health and Big Data Perspectives" 04/18/22

Hi Everyone, Just a reminder that our next webinar is this week on Friday April 22nd @ 12pm EST on the topic “Privacy and Patient Health Data: Public Health and Big Data Perspectives” Topic: Privacy and Patient Health Data #3 – Public Health and...

Wed, Apr-20 noon ET: Review the draft IHE Canada annual report 04/13/22

Hi all -- I hope everyone is starting to enjoy a bit of spring weather (and sorry, friends in Manitoba, to hear that you're not). It's time, again, for the IHE Canada annual report to the IHE International Board. A community meeting is set f...

Privacy and Patient Health Data Webinar Videos Posted 04/04/22

Hi Everyone, For those that may have missed our Enterprise Imaging webinars, recorded videos from our previous Privacy and Patient Health Data webinars have been posted. The first webinar on: Privacy and Patient Health Data - Legal and Legislativ...

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.

Archive ( 4 Documents )

2022 IHE Canada Report (final)

Published on Apr 27, 2022 by Derek Ritz

pan-Canadian Projectathon overview

Published on Feb 14, 2022 by Attila Farkas

IHE Canada 2020-2021 Activity Report to the IHE Board

Published on Apr 22, 2021 by Derek Ritz

2020 FHIR North Presentation -- IHE QRPH CCG Update

Published on Apr 18, 2021 by Derek Ritz

Consolidated "Life of the Lamberts" Use Case Stories

Published on May 31, 2020 by Derek Ritz

IHE Canada 2019-2020 Annual Report (final)

Published on May 05, 2020 by Derek Ritz

IHE Canada Liaison Election Information for 2020-23

Published on Apr 29, 2020 by Andrea MacLean

2020 IHE Canada Liaison Nomination Form

Published on Apr 23, 2020 by Derek Ritz

2020 IHE Canada Liaison Role Description and TOR

Published on Apr 23, 2020 by Derek Ritz

Draft for comment -- IHE Canada 2020 Report

Published on Apr 22, 2020 by Derek Ritz

CCG update for InfoCentral Terminology Community

Published on Mar 17, 2020 by Derek Ritz

IHE 101

Published on Mar 04, 2020 by Derek Ritz

An IHE Survey - The past the present and the future of IHE

Published on Mar 04, 2020 by Derek Ritz

IHE North America Connectathon 2020 Report

Published on Mar 02, 2020 by Linda Monico

Draft for comment -- IHE Canada 2019 Report

Published on Apr 23, 2019 by Derek Ritz

IHE Canada Liaison Role Description

Published on Jul 19, 2018 by Andrea MacLean

Video

IHE Community Meeting (2022-09-26)

This is a video recording of the IHE Community Meeting held Sep-26 2022 to review activities at the 2022 IHE Connectathon and to review and discuss the newly published IHE Strategic Plan.

09/30/22
Une introduction à IHE

Cette vidéo présente IHE Canada... en 300 secondes ou moins.

09/30/22

Solutions

  • Canadian FHIR Registry
  • Canadian URI Registry
  • FHIR Terminology Service API
  • FHIR Uniform Resource Identifier (URI)
  • HAPI FHIR
  • HAPI v2
  • InfoRMS
  • Object Identifier (OID)
  • SNOMED CT Browser
  • Terminology Gateway
  • Terminology Service API
  • Webhook Notifications

The Canadian FHIR® Registry supports collaborative development in an effort to accelerate sustainable growth of FHIR, locally and internationally. The registry is 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 at no cost 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
  • a sandbox project where users are encouraged to test the different features of the tool before officially requesting a new project 

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.

There is an expectation that all projects in the Canadian FHIR Registry will be public, to promote Pan-Canadian interoperability, and so that others can see what is being worked on across Canada. Please note that ‘public’ does not mean ‘published’. Project owners are encouraged to use the Description and/or Subtitle properties to indicate the status of their projects (ie. Draft, For Internal Use).

Organization projects can be viewed without logging in.

How to Request a New Project

Please email This email address is being protected from spambots. You need JavaScript enabled to view it., please use Subject: Requesting Simplifier.net Project

In addition, please provide

  1. Name of Organization requesting the project
  2. Project title
  3. Brief Project Description
  4. Version of FHIR for project
  5. Registered email addresse(s) of project administrator(s) (To register on Simplifier.net, please sign up here - https://simplifier.net/signup)
  6. Status of the project - Private/Public (please note that a new project can be in private status for 2 to 3 weeks after which it will be made public. This enables promotion of re-use and interoperability.

How to Request Access to Sandbox

Please email This email address is being protected from spambots. You need JavaScript enabled to view it., please use Subject: Requesting Access to Sandbox

In addition, please provide

  1. Name of Organization requesting the project
  2. Version of FHIR for project
  3. Registered email addresse(s) of indvidual(s) to be added to sandbox (To register on Simplifier.net, please sign up here - https://simplifier.net/signup)
  4. Duration (in days) you intend to test, after which your reservation will be recycled for other users

View projects in the Canadian FHIR Registry

Service Level Agreement and Business Continuity

Simplifier.net should not be used in a production setting, as 24/7 support is not provided by Infoway or Firely®.

A project created in the Canadian FHIR Registry can be linked to an existing GitHub account. GitHub serves as a secondary backup and can sync the content in the project accordingly. Read details on how to set this up

Users of the Canadian FHIR Registry on the Simplifier platform can expect the following response time from the Firely team for any issue encountered.

Issue Premium Support Description
High Priority
  • Response time < 4 hours
  • Resolution time < 8 hours
Work halts and affects a large number of users
Medium Priority
  • Response time < 4 hours
  • Resolution time < 16 hours
Able to continue working but affects a small number of users
Low Priority
  • Response time < 4 hours
  • Resolution time < 24 hours
Able to continue work and affects a couple of users
Tickets
  • Unlimited
Able to influence the product’s road map

Read an overview of the Service Level Agreement between Infoway and Simplifier.net.

All project artifacts are backed up weekly at midnight on Sundays. 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..

Forge License Agreement

As per the statement issued on the Firely blog,  Securing the future of Forge, the free version of Forge will be licensed for non-commercial use only starting January 1, 2020. To continue using Forge, users will need to be part of a paid plan on Simplifer.net. The current contract between Infoway and Firely for Simplifier.net allows for an unlimited number of users of Forge. Infoway has received confirmation from Firely that this will remain unaffected until December 31, 2021. If the authors in Simplifier.net belong to projects that are part of the Canadian FHIR Registry, they will be given rights through the administration processes of the platform conducted by Infoway.

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

 

A Uniform Resource Identifier (URI) is a globally unique string of characters that provides a simple and extensible means for identifying a resource. URIs are used to identify a namespace or the location of a resource. URIs are human-readable and offer the potential for resolvability. The HL7 FHIR® specification recommends using URIs to have all resources resolvable and to comply with the FHIR RESTful paradigm.

URI Registration Process

  1. Requestor shall first check that the URI does not already exist in the Canadian URI Project, Jurisdictional Registry (if exists) or HL7 FHIR Specification
  2. FHIR URIs must not be proposed for Subsets to be published on the Terminology Gateway as they will be generated automatically.
  3. Requestor shall contact the owner or respresentative for either:
  4. Forum posts shall have the following format:

    Subject: New URI Request
    • Description: “A description of the URI”
    • Responsible Body & Contact Information
    • Proposed FHIR URI: URI as per URI Guidelines
    • Existing OID (if exists)
    • To be published (optional): Jurisidictional repository/ Canadian URI Registry
  5. There will be a wait period of five business days for the communities to react to the forum post with comments, questions or requests for clarification.
  6. Update Forum post will be updated with the new URI.
  7. Publishing the URI in the Canadian URI Registry and Jurisdictional Registry. This is highly recommended to prevent any misuse or duplication of URIs but it is optional.

See a flowchart of the FHIR URI Registration Process (pdf).

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

Request Management Solution

Infoway Request Management System (InfoRMS) is Infoway's Request for Change (RFC) 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 SNOMED CT

In order to ensure that SNOMED CT RFCs are addressed in an efficient and timely manner, it is the requestor's responsibility to:

  1. Ensure that the content does not exist in either the International or Canadian Editions of SNOMED CT;
  2. Ensure that the request conforms with the most recent Editorial Guidelines;
  3. Provide the date of implementation;
  4. Provide reference material that is publicly available, authoritative, recent and relevant to the request (Wikipedia is not considered appropriate);
  5. Support the request with a clear justification for the change and an appropriate use case for context;
  6. Ensure all mandatory InfoRMS fields have been completed prior to submission.

Login to submit or follow requests to SNOMED CT 

 

pCLOCD leaf symbol pCLOCD/LOINC

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

  1. Ensure that the content does not exist in LOINC or the pCLOCD;
  2. Ensure that a similar or equivalent term has not already been requested, by way of searching the online LOINC Submissions Queue; and pCLOCD Submission Queue
  3. Ensure that a similar or equivalent term has not already been accepted and under development for the next official release, by way of searching LOINC Pre-release terms;
  4. Comply with Regenstrief Editorial Guidelines (note: login required).

Login to submit or follow requests to pCLOCD/LOINC 

 

subsets magnifying glass on monitor 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.

Login to submit or follow requests to pan-Canadian Subsets

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 (Infoway), as the HL7 Canada Affiliate, has an arrangement in place with HL7 International that allows Infoway to submit OIDs to HL7 International free of charge, on behalf of Canadian Implementers who are members of the HL7 Canada Affiliate. There is a $500 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.

  • For Infoway owned subsets, email the completed form to This email address is being protected from spambots. You need JavaScript enabled to view it.
  • For all non-jurisdictional requests, please follow the instructions below
  • All other requests must be sent to the Jurisdictional Representatives for OIDs

OID submission guidelines

  1. Jurisdictional Teams require 5-7 business days to process each request. It will be incumbent on the requestor to reply within this time frame to any questions and follow up as required. Any failure to do so will result in an automatic rejection and require resubmitting the request.
  2. The Requestor must post the OID requests on the following forums ONLY after consulting with the Jurisdiction/Infoway SME:
  3. Forum posts shall have the following format:

    Subject: New Namespace/CodeSystem/Subset OID Request
    • OID Description: “A description of the OID”
    • OID Symbolic name: Symbolic name guidelines
    • Responsible Body & Contact Information
    • Proposed FHIR URI: URI as per URI Guidelines
    • To be published: Canadian URI Registry/Terminology Gateway

    • Subject: Edit Namespace/CodeSystem/Subset OID Request
      • OID: “The actual OID ex. 2.16.840.1.113883.x.xxxx”
      • Responsible Body & Contact Information
      • Description of Requested Change

      • Subject: Deprecate Namespace/CodeSystem/Subset OID Request
        • OID: “The actual OID ex. 2.16.840.1.113883.x.xxxx”
        • Responsible Body & Contact Information
        • Reason for Deprecation
        • Superseded by OID, if any: The OID that should be used instead. Ex. 2.16.840.1.113883.x.xxxx

  4. There will be a wait period of 5 business days for the communities to react to the forum post with comments, questions or requests for clarification.
  5. FHIR URIs must be proposed for all jurisdictional and non-jurisdictional OID requests according to the URI Guidelines and must be published in the Canadian URI Registry. Publishing the URI is an optional but highly recommended step. The Requestor will submit a validated FHIR® NamingSystem resource object based on the NamingSystem profile to their jurisdictional representative who will then upload it.
  6. FHIR URIs must not be proposed for Subsets to be published on the Terminology Gateway as they will be generated automatically.
  7. The Forum post will be updated with the new OID.

Browse International and Canadian Content

SNOMED International's SNOMED CT browser allows users to search for existing concepts and explore 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

 

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 Request

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

Derek Ritz
Picture of Derek Ritz
ecGroup Inc.
OFFLINE
Contact
Andrea MacLean
Picture of Andrea MacLean
Canada Health Infoway
OFFLINE
Admin
Linda Monico
Picture of Linda Monico
Canada Health Infoway
OFFLINE
Admin
David Anderson
Picture of David Anderson
Metro North Hospital and Health Service
OFFLINE
Member
Philippe Léger
Picture of Philippe Léger
Petal inc.
ONLINE
Member
Richard Mutezintare
Picture of Richard Mutezintare
n/a
OFFLINE
Member
Mina Karmali
Picture of Mina Karmali
AHS
OFFLINE
Member
Kevin Keane
Picture of Kevin Keane
MGH
OFFLINE
Member
Catherine Jingco
Picture of Catherine Jingco
Health Information Management
OFFLINE
Member
Tameka Richmond
Picture of Tameka Richmond
N/A
OFFLINE
Member
Ann-Marie Westgate
Picture of Ann-Marie Westgate
Canada Health Infoway
OFFLINE
Member
Allana Cameron
Picture of Allana Cameron
Canada Health Infoway
OFFLINE
Member
Mike Morrison
Picture of Mike Morrison
Deloitte
OFFLINE
Member
Samira Ahmadi
Picture of Samira Ahmadi
Google
OFFLINE
Member
Michael Laviola
Picture of Michael Laviola
Humber River Hospital
OFFLINE
Member

InfoCentral logo

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



Login Register