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: Cette adresse courriel est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser. 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

Le registre canadien d'identificateurs uniformes de ressources (URI) a été créé pour regrouper l'information concernant les espaces de noms des identificateurs et des systèmes de codes. L'utilisation des ressources NamingSystem de FHIR® rend la saisie des métadonnées propice à la consultation et au traitement informatique. Elle permet aussi le mappage bidirectionnel automatique entre les identificateurs d'objets (OID) et les URI.

Afin de rendre la recherche de ces artéfacts plus souple, le registre d'URI canadien (alpha) permet d'effectuer des recherches via du texte en clair, des OID ou des URI. Les identificateurs URI sont créés à l'aide des lignes directrices URI et affichés sur la page du groupe de travail sur l'architecture de solutions FHIR en vue d'être approuvés.

Tous les artéfacts NamingSystem sont organisés par le Canadian URI Project dans Simplifier et peuvent faire l’objet de recherches après une période de 20 minutes.

Consultez le registre d’URI canadien(alpha)

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.

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 Cette adresse courriel est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser..

Organization projects can be viewed without logging in. To edit or request a new project, Cette adresse courriel est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser. with the details.

View projects in the Canadian FHIR Registry

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.

Browse Terminology Gateway Now

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

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.

Access Message ReMixer 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 Service API

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.

Browse SNOMED CT Now

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.

FHIR Terminology Service API

Standards versions available for viewing in HL7 Explorer

Solution for API integration

Infoway Message Builder allows developers to focus on their business problem by providing APIs that foster quick and easy creation, population and access to HL7v3 requests and responses and CDA documents.

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