XSchema

Files description

The syntax of a KMEHR message is primilarly determined by the XSchema, which is mainly composed of five files.
 

  •     The kmehr_element file defines the root element 'kmehrmessage'. This small file uses the types defined in the core file : kmehr.xsd. Other core elements will probably be added in this file.
  •     The kmehr file is the core file. It defines the structure of a kmehr message.
  •     The cd file is dedicated to the cd basic element and gathers the elements related to the reference tables.
  •     The dt file defines some basic data types.
  •     The id file deals with identifiers. It contains the definition of the id element.


Two external schemas are also used.

  •     The xenc-schema file tackles encryption aspects.
  •     The xmldsig-core-schema file tackles signature aspects.

Versions

Kmehr releases
Date Content Version
2024-08-01

Includes:

Original Release (v1.41.0):

  • Request ESI-562:
    • Added table CD-INVOLVED-PARTY
    • New value in CD-ITEMschemes:
      • 'CD-INVOLVED-PARTY'

1.41.0:

ehealthxsd-1.41.0.zip

2024-03-20

Includes:

Original Release (v1.40.2):

  • Request ESI-71:
    • New values in CD-VACCINEINDICATION:
      • 'monkeypox'
  • Request ESI-118:
    • added 'instructionforpharmacist' element
  • Request ESI-203:
    • New values in CD-TRANSACTION:
      • 'transferreport'
  • Request ESI-492:
    • New value in CD-MEDIATYPE:
      • 'application/fhir+json', 'application/fhir+xml'

1.40.2:

ehealthxsd-1.40.2.zip

2023-08-01

Includes:

Original Release (v1.39.0):

  • Request ESI-193:
    • New values in CD-TRANSACTION-TYPE:
      • 'adanormal', 'adaextension', 'adarelapse'
  • Request ESI-187:
    • New value in CD-TRANSACTIONschemes:
      • 'CD-TRANSACTION-INC-NOT'

1.39.0:

ehealthxsd-1.39.0.zip

2023-04-14

Includes:

Original Release (v1.38.1):

  • Request ESI-157 and ESI-180:
    • New values in CD-HCPARTY:
      • 'orgpharmacyinvoicingoffice', 'persoptometrist', 'persmobilityimprover', 'persbandagistorthosiologist',
                 'persprosthesiologist', 'persshoetechnologist'

1.38.1:

ehealthxsd-1.38.1.zip

2022-10-01

Includes:

Original Release (v1.37.0):

  • Request ESI-91 from Corilus:
    • New values in CD-VACCINEINDICATION:
      • 'pneumonia15', 'pneumonia20'

1.37.0:

ehealthxsd-1.37.0.zip

2022-07-01

Includes:

Original Release (v1.36.0):

  • Request ESI-43 from RSW:
    • New values in CD-HCPARTY:
      • 'deptpsychogeriatry'
  • Request ESI-22 from SPF:
    • New values in CD-TRANSACTIONschemes: 
      • 'CD-LABORESULT-TYPE'

1.36.0:

ehealthxsd-1.36.0.zip

2022-04-01

Includes:

Original Release (v1.35.1):

  • Request EHKMEHR-317 from Belrai:
    • New values in CD-HCPARTY:
      • 'persappliedpsychbachelor', 
      • 'persfamilysciencebachelor', 
      • 'persgerontologymaster', 
      • 'persorthopedagogistmaster', 
      • 'perspsychomotortherapymaster', 
      • 'persreadaptationbachelor', 
      • 'perspedagogybachelor'
  • Request EHKMEHR-325 from Saint-Luc UC Louvain:
    • New values in CD-MEDIATYPE: 
      • 'application/rtf'
  • Request EHKMEHR-328 from Medispring:
    • New values in CD-VACCINEINDICATION: 
      • 'meningitisb'

1.35.1:

ehealthxsd-1.35.1.zip

2021-01-20 Includes:

Original Release (v1.34.0):

  • Extra mid-cycle release to support covid vaccination indication code.

1.34.0:

ehealthxsd-1.34.0.zip

2020-12-01 Includes:

Original Release (v1.33.0):

  • Evolution for nursing report and pharmaceutical medication scheme.

1.33.0:

ehealthxsd-1.33.0.zip

2020-09-01 Includes:

Original Release (v1.32.0):

  • Evolution for Administration units and drug routes.

1.32.0:

ehealthxsd-1.32.0.zip

2020-06-01 Includes:

Original Release (v1.31.0):

  • Evolution for Diary, HCparty and Transaction tables.

v1.31.0:

ehealthxsd-1.31.0.zip

2020-03-01 Includes:

Original Release (v1.30.0):

  • Evolution for Pharmaceutical prescription.

v1.30.0:

ehealthxsd-1.30.0.zip

2019-09-01

Includes:

Original Release (v1.29.0):

  • Evolution for Diary note.

v1.29.0:

ehealthxsd-1.29.0.zip

2019-03-01

Includes:

Original Release (v1.28.0):

  • Evolution for Recip-e.

Attention: when and how to use the new optional elements in the KMEHR Header (<expirationdate> and <source>): please refer to Recip-e documentation.

v1.28.0:

ehealthxsd-1.28.0.zip

2018-12-01

Includes:

Original Release (v1.27.0):

  • Evolution for MyCarenet and extra values for vaccination.

v1.27.0:

ehealthxsd-1.27.0.zip

2018-09-01

Includes:

Original Release (v1.26.0):

  • Evolution for MyCarenet.

v1.26.0:

ehealthxsd-1.26.0.zip

2018-06-01

Includes:

Original Release (v1.25.0):

  • Evolution for MyCarenet.

v1.25.0:

ehealthxsd-1.25.0.zip

2018-03-01

Includes:

Original Release (v1.24.0):

  • Evolution for AMP table, hcparty and parameter values.

v1.24.0:

ehealthxsd-1.24.0.zip

2017-12-01

Includes:

Original Release (v1.23.0):

  • Evolution for HL7 CDA Base64 support in KMEHR.

 

v1.23.0:

ehealthxsd-1.23.0.zip

2017-09-01

Includes:

Original Release (v1.22.0):

  • Evolution for Diary note, update of hcparty values.

 

v1.22.0:

ehealthxsd-1.22.0.zip

 

2017-06-01

Includes:

Original Release (v1.21.0):

  • Evolution for Mult-eMediAtt.

 

v1.21.0:

ehealthxsd-1.21.0.zip

 

2017-03-01

Includes:

Original Release (v1.20.0):

  • Evolution for exchange of medication schemes. Update of CD-ENCRYPTOR values.

 

v1.20.0:

ehealthxsd-1.20.0.zip

 

2016-12-01

Includes:

Original Release (v1.19.0):

  • Evolution for Hubservices, Recip-e, Mediprima, SumehrV2.

 

v1.19.0:

ehealthxsd-1.19.0.zip

 

2016-09-01

Includes:

Original Release (v1.18.0):

  • Evolution for My Carenet eAttest, Mediprima, Recip-e and Reintegration.

 

v1.18.0:

ehealthxsd-1.18.0.zip

 

2016-06-01

Includes:

Original Release (v1.17.1):

  • Evolution to rationalize structures of types person and error. Update of CD-FED-COUNTRY and CD-PROOF.

 

v1.17.1:

ehealthxsd-1.17.1.zip

 

2016-03-01

Includes:

Original Release (v1.16.0):

  • Evolution for eCare TardisDeclaration.

 

v1.16.0:

ehealthxsd-1.16.0.zip

 

2015-12-01

Includes:

Original Release (v1.15.0):

  • Evolution for eCare TardisDeclaration.

 

v1.15.0:

ehealthxsd-1.15.0.zip

 

2015-09-01

Includes:

Original Release (v1.14.0):

  • Evolution for eCare PacemakerDeclaration and Nursing Migration Format.

 

v1.14.0:

ehealthxsd-1.14.0.zip

 

2015-06-01

Includes:

Corrective patch (v1.13.1):

  • Removed white space at the end of 'CD-PM-ELEC-TYPE' and 'CD-PM-DISTURBANCE'.

Original Release (v1.13.0):

  • The adaptations required for eCare PacemakerDeclaration.

 

v1.13.1:

ehealthxsd-1.13.1.zip

v1.13.0:

ehealthxsd-1.13.0.zip

 

2015-03-01

Includes:

Original Release (v1.12.0):

  • The adaptations required for the XML Library and eCare OrthoDeclaration.

 

v1.12.0:

ehealthxsd-1.12.0.zip

 

2014-12-01

Includes:

 The corrective patch 1.11.1 was published on Dec 19, 2014

Corrective Patch (v1.11.1):

  • CD-UNIT: changed 'sap' to 'Gy.cm2' in CD-UNIT values
  • CD-ORTHO-GRAFT: added value 'none'

Original Release (v1.11.0):

  • The adaptations required for the eCare DefibDeclaration and eCare OrthoDeclaration projects.

 

v1.11.1:

ehealthxsd-1.11.1.zip

v1.11.0:

ehealthxsd-1.11.0.zip

 

2014-10-01

Includes:

Original Release (v1.10.0):

  • The adaptations required for the eCare Safe V2.3 and eCare Defib projects.

 

v1.10.0:

ehealthxsd-1.10.0.zip

 

2014-07-01

Includes:

Original Release (v1.9.0):

  • The adaptations required for the eCare Tuco S2S V2 project.

 

v1.9.0:

ehealthxsd-1.9.0.zip

 

2014-04-01

Includes:

The corrective patch 1.8.1 was published on May 22, 2014

Corrective Patch (v1.8.1):

  • Integrated bug fix of v1.7.2

Original Release (v1.8.0):

  • Support new patient INSS support card number ISI+

v1.8.1:

ehealthxsd-1.8.1.zip

v1.8.0:

ehealthxsd-1.8.0.zip

 

2013-10-01

Includes:

The corrective patch 1.7.2 was published on May 22, 2014

Corrective Patch (v1.7.2):

  • Moved 'CD-MYCARENET-JUSTIFICATION' from CD-ITEMschemes to CD-CONTENTschemes
The corrective patch 1.7.1 was published on January 01, 2014

Corrective Patch (v1.7.1):

  • Added value "orgprimaryhealthcarecenter" to CD-HCPARTY
  • Removed "completed" duplication from CD-LIFECYCLE
  • Added value 'tariff' to CD-TRANSACTION-MYCARENET
  • Added values 'fee', 'reimbursement', 'patientfee', 'financialcontract' to CD-ITEM-MYCARENET
  • Added table "CD-MYCARENET-JUSTIFICATION"

Original Release (v1.7.0):

  • Adaptations for DefibDeclaration
  • Adaptations for the homologation 2013

v1.7.2:

ehealthxsd-1.7.2.zip

v1.7.1:

ehealthxsd-1.7.1.zip

v1.7.0:

ehealthxsd-1.7.0.zip

 

2013-07-10

Includes:

Original Release (v1.6.0):

  • Adaptations for the medex incapacity notification
  • Adaptations for the GP Software homologation 2013
  • Setup structure for generic transactions and their specialisations, for future expansion

v1.6.0:

ehealthxsd-1.6.0.zip

2012-10-01

Some corrections were necessary after the initial release, which has resulted in the release of a patch on July 10, 2013

Corrective Patch (v1.5.1):

  • added type="xsd:string" in intendedname element for substanceproduct
  • adapted compoundprescription element for backward compatibility with older Kmehr versions
  • added processcontent="lax" in the sequence of "textWithLayoutType" element
  • corrected the values added in version 1.5.0 in CD-HCPARTY by adding a "dept" at the begin
  • added id element (ID-KMEHR) to addressType, addressTypeBase and telecomType

Original Release (v1.5.0):

  • Extra values for RSW in CD-HCPARTY
  • Adaptations for an encoded magistral preparation, based on input from APB
  • New elements required for the GMD Holder registration project (CIN)
  • Addition of financial elements (CD-CURRENCY, ID-IBAN)
  • Addition of ID-INSURANCE identifier type

 v1.5.1:

 ehealthxsd-1.5.1.zip

 v1.5.0:

 ehealthxsd-1.5.0.zip

2012-07-01

Includes:

Original Release (v1.4.0):

  • The adaptations required for the Therapeutic Link project.

v1.4.0:

ehealthxsd-1.4.0.zip

2012-04-01

Includes:

Original Release (v1.3.0):

  • The adaptations required for the eCare ORTHOPride S2S project.
  • The adaptations required for the eCare Tuco S2S project.
  • New transactions required for the Vitalink project (treatmentsuspension and medicationschemeelement).

v1.3.0:

ehealthxsd-1.3.0.zip 

2011-07-01

Some corrections were necessary after the initial release, which has resulted in the release of a patch on 11 august 2011 and on 1 september 2011.
The patched versions 1.2.2 and 1.2.1 are backwards compatible with the original release 1.2.0. Please note that the Kmehr release remains 20110701.

Includes:

Corrective patch (v1.2.2)

  • Base64EncryptedValue: now accepts base64 data again
  • Extended list with contact person types to CD-CONTACTTYPE
  • Added 'vaccinationrefusal' to CD-PATIENTWILL
  • Added 'EHP' to CD-ENCRYPTION-ACTOR

Corrective patch (v1.2.1):

  • Added 'kg/m2' value to CD-UNIT
  • Correction: Allowed 'SL' attribute for CD-HCPARTY

Original Release (v1.2.0):

  • The adaptations required for the hub-metahub project 1.1 specification
  • The adaptations required for the Biobank project by the Belgian Cancer Register
  • The adaptations required to enable the exchange of Chapter IV messages
  • The adaptations required for the GP Software Migration Format 1.1 specification.
  • A new, case-sensitive version (2.0) of the CD-TIMEUNIT value table

v1.2.2:
ehealthxsd-1.2.2.zip
v1.2.1: 
ehealthxsd-1.2.1.zip
v1.2.0: 
ehealthxsd-1.2.0.zip

2010-09-01

Includes:

  • The adaptations introduced, so far, for the hub-metahub project.
  • The adaptations required for the migration formats.

ehealthxsd-1.1.0.zip

2010-06-01

Version adapted to fit with the sumehr 1.1 specification. It also includes some points introduced in the hubs-metahub project.

Includes:

  • The adaptations required for sumehr 1.1.
  • A new namespace with versioning.
  • A new scheme 'INSS' to support the identification of physical persons.

Does not include:

  • The range definition for the externalized tables such as CD-DRUG-CNK.
  • The adaptations required to support the JOEPIE format.
  • The adaptations required to support the use of the eHealth platform encryption 'end-to-end'.

A new minor version including the last two points is foreseen. This version will not imply a change of namespace.

20100601_kmehr.zip

2009-11-01

First version published on the site.

Includes:

  • The new structure discussed within Be-prescript III for medication prescription.
  • The adaptations required for eBirth.
  • The adapations required for eCare-SAFE.

Does not include:

  • The range definition for the externalized tables such as CD-DRUG-CNK.

20091101_kmehr.zip

Draft version

Please consult the kmehr xsd draft page.