eMediplan CHMED Implementation Guide
2.2.0 - CI Build Switzerland flag

eMediplan CHMED Implementation Guide, published by IG eMediplan. This is not an authorized publication; it is the continuous build for version 2.2.0). This version is based on the current content of https://github.com/ahdis/chmed/ and changes regularly. See the Directory of published versions

Home

Official URL: http://chmed.emediplan.ch/fhir/ImplementationGuide/ch.chmed.emediplan Version: 2.2.0
Active as of 2023-01-27 Computable Name: CHMED

Copyright/Legal: CC-BY-SA-4.0

Background

Medication plans are a central pillar of any eHealth solution. To enable interoperability between eHealth systems in Switzerland, the organization IG eMediplan was founded in 2016. Its aim is to support and provide public, open source, medication plan formats supported by a broad group of stakeholders from the public and private sectors.

Fig.: Example of a Mediplan

Fig.: Example of a Mediplan

About this IG and CHMED

CHMED

The purpose of this implementation guide is to specify the medication plan exchange formats based on the FHIR® standard from HL7®.

Extending the CHMED16A/CHMED23A format to a FHIR based definition (CHMED) has the following advantages:

  • CHMED formats can be validated for correctness, data types are well defined.
  • Base interoperabilty for other projects based on medications, e.g. mappings will be provided for the exchange formats for medication with the EPR in Switzerland.

The CHMED format can be either in XML or JSON format. However, both are too big in size to be exchanged in a QR code.

HCI Solutions AG has built a converter for all software houses that have integrated the CHMED16A/CHMED23A. If you have questions or want more information please contact hotline@hcisolutions.ch directly.

Scope

  • Documents - in FHIR format to exchange the eMedication information.
  • Profiles - are constraints of FHIR resources and data types for the context of CHMED.
  • Extensions - are FHIR extensions that are added to be able to represent the complete CHMED context.
  • Terminologies - were defined and represented to allow exchange of coded data.
  • Dosage - describes the posology of a medicament in more detail.
  • Artifacts - provides a list of the FHIR artifacts included in this implementation guide.

MustSupport

The meaning of the flag mustSupport for this implementation guide follows the definition of CH EMED, the Swiss eMedication IG from which CHMED is derived.

Download

You can download this implementation guide in NPM format from here.

Change Log

Significant changes to this specification since its initial version.

eMedication Plan

The eMedication Plan CHMED16A and ‘eMedication Plan CHMED23A’ papers describe the specification and reference implementation of the object model for a medication plan, the so-called CHMED16A and CHMED23A, respectively.

CHMED16A

The reference consists of two major parts:

  • The content and layout specification for the electronic document, a string / text file containing a header such as ‘CHMED16A1’ and the (compressed, encoded) medication plan as a JSON object in UTF-8
  • The content and layout specification for a paper-based layout used in Print/PDF scenarios

This allows IT systems to store and transmit electronic medication plans as simple strings or text files in UTF-8. It also makes it possible to transmit the mediplan print-based through the use of QR barcodes. Therefore, the mediplan is readable by users and systems alike. This is necessary to guarantee a simple handling.

A typical CHMED16A object would look like this:

CHMED16A1H4sIAAAAAAAEAMVU3W7TMBR+lcq3S4SPHdtx7raVAaKFqutAAnoREreJ2jpT4gKj6ptxx4txnCwVSKQSu0GVqvPX7+fIpwdyuXcFSYiSFCjloGKtNQnI2GGRUZAh1SGwBUASyYTqC8oSSnHgVe4HZM7z1UqF6WcqwkhxjCKdhcJkWc650GIlcXZq8sXDvSEJtHGZpTtjXUOSj4cORyuIpWpRu0EekFnVDYzxmwbtZ+l13dTV7g9t5Ij1eZVicfYWMRab9byxmF1urMH8zpbezO3iNTkGj4RRJIHH7Bwj/J2RhUAHGa+2e/fF1PnPH9bu7XqAnHEhZHzGrqeGJ5EXVVbk9T7bfHr20tTfBwRAxCQHen7f/y7guqi2pnGmLm1j7MbUA/Qx1VLz8/aftvvf7L9Pm2ZQAQgBTEX/QwL+dJa6Et8/SQ7kqr0z0DGEFPxbDsh16R48lqktZjdv8FYwnabfyl2KhRfG5giasIBMTj3nWp4JPrmEjJ93J+fxx5PGTY3X1tbSzuHpGDthCPUu3eKM4O2Kujbr29C3QcSd9ex0udibYyKUWvbLZX3Au54EdupFfSD6QD4CCBEIBcsjjpJZUVnv6yJCxlEsYMRk+59z62pj/MLuLBreoe2vZj2KsfOhvMcyp0yhAzLfbbzj4y8tzloh3gQAAA==

CHMED23A

The reference consists of:

  • The content and layout specification for the electronic document, a JSON file including a medication (Med) for which the format (MedF) and compression (IsCompressed) is being specified.
    • Med will be a string if compressed or a JSON object otherwise
    • The JSON file must be encoded in UTF-8

The content and layout specification for a paper-based layout used in Print/PDF scenarios is described in the document ‘eMediplan_Paper-based_Layout’.

This allows IT systems to store and transmit electronic medication plans as JSON file in UTF-8. It also makes it possible to transmit the mediplan print-based using QR barcodes. Therefore, the mediplan is readable by users and systems alike. This is necessary to guarantee a simple handling.

A typical compressed CHMED23A object would look like this:

{ 
    "MedF": "ChMed23A", 
    "IsCompressed": true, 
    "Med": 
    "H4sIAAAAAAAACq2OOw4CMQxE7zIt2ZUTAmzcLZsGiU+KUCEKYKlokIACRbk7jkLBAWisZz/NyAmb6/g
    AHxJWI7hsGgqhnsIOnBDBRmF4+9cebCuBtUL0Xy38g73MnIu+DxX/1nRUkCRiv1zLl9tzOF1uIloqxj9FGT
    KmId1oHcnxtGM7a+28c9YtJqSZCPkD+iD8fPQAAAA=" 
}

It is recommended to use the compressed CHMED23A object to minimize data size.

IP Statements

This document is licensed under Creative Commons “No Rights Reserved” (CC0).

HL7®, HEALTH LEVEL SEVEN®, FHIR® and the FHIR ® are trademarks owned by Health Level Seven International, registered with the United States Patent and Trademark Office.

This implementation guide contains and references intellectual property owned by third parties (“Third Party IP”). Acceptance of these License Terms does not grant any rights with respect to Third Party IP. The licensee alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize Third Party IP in connection with the specification or otherwise.

This publication includes IP covered under the following statements.

Cross Version Analysis

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (ch.chmed.emediplan.r4) and R4B (ch.chmed.emediplan.r4b) are available.

Dependency Table

Package ihe.formatcode.fhir#1.1.0

Implementation Guide for IHE defined FormatCode vocabulary. (built Thu, Feb 24, 2022 16:55-0600-06:00)

Package ch.fhir.ig.ch-epr-term#2.0.8

Implementation guide for the meta data specified in the framework of Annex 3 and 9 of the FDHA Ordinance on the electronic patient record in Switzerland (built Wed, Dec 21, 2022 08:03+0100+01:00)

Package ch.fhir.ig.ch-core#3.0.0

FHIR implementation guide CH Core (built Wed, Dec 21, 2022 09:47+0100+01:00)

Package ch.fhir.ig.ch-emed#current

Implementation Guide for the eMedication in Switzerland. (built Tue, Jan 24, 2023 14:25+0000+00:00)

Package ch.fhir.ig.ch-epr-term#2.0.8

Implementation guide for the meta data specified in the framework of Annex 3 and 9 of the FDHA Ordinance on the electronic patient record in Switzerland (built Wed, Dec 21, 2022 08:03+0100+01:00)

Package ch.fhir.ig.ch-core#current

FHIR implementation guide CH Core (built Fri, Jan 27, 2023 08:53+0000+00:00)

Globals Table

There are no Global profiles defined