Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

A medication scheme is a kmehrmessage that consists of

...

The next paragrahs describe the kmehrmessage as used for Vitalink. Please refer to the Kmehr standard specification for the basic explanation, see External Links#kmehr_message-overview.

Kmehrmessage element <header>

Vitalink does not require more elements than the ones that are mandatory by the Kmehr standard.

When writing to Vitalink, all the elements are generated by the eHealth technical connector, based on the used properties.

Kmehrmessage element <folder>

Folder element <patient>

Element

Vitalink meaning

Kmehr meaning: External Links#kmehr_patient

Kmehr

Vitalink

id


Mandatory

=

firstname


Mandatory

=

familyname


Mandatory

=

birthdate


Optional

=

birthlocation


Optional

=

deathdate


Optional

=

sex


Mandatory

=
usuallanguage

Vitalink: Question is pending asking what this means for Vitalink

Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyVAZG-118

Optional=

...

When writing to Vitalink, all the elements are generated by the eHealth technical connector, based on the patient information given by the application.

Folder element <transaction> "medicationscheme" (MS)

The Vitalink transaction MS contains the general information of the medication scheme.

Kmehr parent transaction

Element

Vitalink meaning

Kmehr meaning: External Links#kmehr_transaction

Kmehr

Vitalink

id

For the use in storage and consultation, see M. Storage and Consultation.

Mandatory

=

cd


Mandatory

=

date

For the use in storage and consultation, see M. Storage and Consultation.

Mandatory

=

time

For the use in storage and consultation, see M. Storage and Consultation.

Mandatory

=

author

For the use in storage and consultation, see M. Storage and Consultation.

Mandatory

=

iscomplete

Kmehr: Specifies if the transaction is complete.

Vitalink: This element is not used. Since it is mandatory, Vitalink requires always the value "true".

Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyVIM-147
Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyVIM-149

Mandatory

=

isvalidated

Kmehr: Specifies if the transaction is validated.

Vitalink: This element is not used, see M. Concept: User MSE validation

Mandatory

=

item

Vitalink: No item is defined within the transaction medicationscheme.

Optional

0

Vitalink child transaction MS

Element

Vitalink meaning

Kmehr meaning: External Links#kmehr_transaction

Kmehr

Vitalink

version

Kmehr: not existing

Vitalink: this is the version of the medication scheme in Vitalink. When saving a medication scheme, this version needs to be passed to Vitalink.

not existing

Mandatory

Folder element <transaction> "medicationschemeelement" (MSE)

Kmehr parent transaction

Element

Vitalink meaning

Kmehr meaning: External Links#kmehr_transaction

Kmehr

Vitalink

id

For the use in storage and consultation, see M. Storage and Consultation.

Mandatory

=

cd


Mandatory

=

date

For the use in storage and consultation, see M. Storage and Consultation.

Mandatory

=

time

For the use in storage and consultation, see M. Storage and Consultation.

Mandatory

=

author

For the use in storage and consultation, see M. Storage and Consultation.

Mandatory

=

iscomplete

Kmehr: Specifies if the transaction is complete.

Vitalink: This element is not used. Since it is mandatory, Vitalink requires always the value "true".

Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyVIM-147
Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyVIM-149

Mandatory

=

isvalidated

Kmehr: Specifies if the transaction is validated.

Vitalink: This element is not used, see M. Concept: User MSE validation

Mandatory

=

item


Optional

[1-*]

Vitalink child transaction MSE

Transaction element <item>

Each Kmehr element <item> consists of the next elements:

Element

Vitalink meaning

Kmehr meaning: External Links#kmehr_item

Kmehr

Vitalink

id

Vitalink: For Vitalink, this value has no extra meaning.

Mandatory=
cd

Kmehr: The type of the item.

Vitalink: 1 item "medication" and 0 or more items "healthcareelement"

Mandatory=


Transaction element <item> "medication"

The item medication has of the following additional elements:

Element

TypeVitalink

group of elements for

medication information

Refer to corresponding paragraph.Mandatory
temporalityCD-TEMPORALITYOptional
frequency

CD-PERIODICITY

Optional
beginmoment<date>Mandatory
endmoment<date>Optional, not together with duration
duration
Optional, not together with endmoment
regimen
Optional, not together with posology
posology
Optional, not together with regimen
route
Optional
instructionforpatient
Optional
instructionforoverdose
Optional
Medication elements for medication information 

Information with regard to the medication can be included in four different ways. The method that is used depends on whether:

  • the medication is prescribed on product name
  • the medication is prescribed on substance name (‘Prescription On Substance' or POS)
  • the medication needs to be identified via an EAN code
  • the medication is a pharmaceutical compound
Medication information via <medicinalproduct>
Code Block
languagexml
titleExample
linenumberstrue
...
<item>
	<id S="ID-KMEHR" SV="1.0">2</id>
	<cd S="CD-ITEM" SV="1.11">medication</cd>
	<content>
		<medicinalproduct>
			<intendedcd S="CD-DRUG-CNK" SV="2010-07">0018614</intendedcd>
			<intendedname>Alkeran filmomh. tabl. 25 x 2 mg</intendedname>
		</medicinalproduct>
	</content>
	<beginmoment>
		<date>2025-01-15</date>
	</beginmoment>
	...
Medication information via <substanceproduct>
Medication information via CD-EAN
Code Block
languagexml
titleExample
linenumberstrue
...
<item>
	<id S="ID-KMEHR" SV="1.0">2</id>
	<cd S="CD-ITEM" SV="1.4">medication</cd>
	<content>
		<cd SV="external" S="CD-EAN">8426420004947</cd>
	</content>
	<text L="nl">DAFALGAN FORTE DROOG 1G TABL 50</text>
	<beginmoment>
		<date>2025-01-15</date>
	</beginmoment>
	...

Note that the version of the CD-EAN table is externally defined, since it is not a proprietary Kmehr table. No validation is done regarding that version or value passed for CD-EAN.

Medication information via <compoundprescription>

In the current kmehr standard it is only possible to enter a pharmaceutical compound in textual form. However steps have been taken to do this in a more structured manner in a future version. When these modifications are included in kmehr Vitalink will possibly be aligned.

Medication element <temporality>
Medication element <frequency>
Medication element <beginmoment>
Medication element <endmoment>
Medication element <duration>
Code Block
languagexml
titleExample
linenumberstrue
...
<item>
	...
	<beginmoment>
		<date>2025-01-15</date>
	</beginmoment>
	...
	<duration>
		<decimal>4</decimal>
		<unit>
			<cd S="CD-TIMEUNIT" SV="2.1">d</cd>
		</unit>
	</duration>
	...
Medication element <regimen>

This is the element that provides a structure to be able to express a posology in a structured way.

The element <regimen> is mutually exclusive with the element <posology>.

Medication element <posology>

Only when it is not possible to express the medication posology in a structured way with <regimen>, it can be passed to Vitalink as free text. 

...

Code Block
languagexml
titleExample
linenumberstrue
...
<item>
	<id S="ID-KMEHR" SV="1.0">2</id>
	<cd S="CD-ITEM" SV="1.11">medication</cd>
	...
	<posology>
		<text L="nl">Until 3 x 1 per day with meal, during max 3 days and minimally 4hours between 2 ingestions.</text>
	</posology>
	...
</item>
...
Medication element <route>
Medication element <instructionforpatient>
Medication element <instructionforoverdose>

Transaction element <item> "healthcareelement"

To include certain Vitalink specific information within the medication scheme data element, use must be made of separate item with value 'healthcareelement'.

...

healthcareelementvalue of <content>
adaptationflagKmehr table CD-MS-ADAPTATION
begincondition

Text field

endconditionText field
medicationtypeKmehr table CD-MS-MEDICATIONTYPE
medicationuse

Text field

originKmehr table CD-MS-ORIGIN
Healthcareelement "adaptationflag"
Warning
titleUnder discussion

This paragraph is under discussion and needs to be reviewed.

Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyVIM-147

...

Code Block
languagexml
titleExample
linenumberstrue
...
<item>
	<id SV="1.0" S="ID-KMEHR">2</id>
	<cd SV="1.3" S="CD-ITEM">healthcareelement</cd>
	<content>
		<cd SV="1.0" S="CD-ITEM-MS">adaptationflag</cd>
		<cd SV="1.0" S="CD-MS-ADAPTATION">medication</cd>
		<cd SV="1.0" S="CD-MS-ADAPTATION">posology</cd>
	</content>
</item>
...
Healthcareelement "begincondition"
Healthcareelement  "endcondition"
Healthcareelement "medicationtype"
Warning
titleUnder discussion

This paragraph is under discussion and needs to be reviewed.

Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyVIM-147

...

Permitted values for this list are:

  • onprescription
  • otc
  • other
Healthcareelement "medicationuse"
Code Block
languagexml
titleExample
linenumberstrue
...
<item>
	<id SV="1.0" S="ID-KMEHR">2</id>
	<cd SV="1.11" S="CD-ITEM">healthcareelement</cd>
	<content>
		<cd SV="1.0" S="CD-ITEM-MS">medicationuse</cd>
	</content>
	<content>
		<text L="nl">For stomachache</text>
	</content>
</item>
...
Healthcareelement "origin"
Warning
titleUnder discussion

This paragraph is under discussion and needs to be reviewed.

Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyVIM-147

...

Permitted values for this list are:

  • regularprocess
  • recorded

Folder element <transaction> "treatmentsuspension" TS

The Vitalink transaction TS can be used to express a suspension of the ingestion of the medication. A medication scheme can contain 0 or more suspensions.

Kmehr parent transaction

Element

Vitalink meaning

Kmehr meaning: External Links#kmehr_transaction

Kmehr

Vitalink

id

For the use in storage and consultation, see M. Storage and Consultation.

Mandatory

=

cd


Mandatory

=

date

For the use in storage and consultation, see M. Storage and Consultation.

Mandatory

=

time

For the use in storage and consultation, see M. Storage and Consultation.

Mandatory

=

author

For the use in storage and consultation, see M. Storage and Consultation.

Mandatory

=

iscomplete

Kmehr: Specifies if the transaction is complete.

Vitalink: This element is not used. Since it is mandatory, Vitalink requires always the value "true".

Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyVIM-147
Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyVIM-149

Mandatory

=

isvalidated

Kmehr: Specifies if the transaction is validated.

Vitalink: This element is not used, see M. Concept: User MSE validation

Mandatory

=

item

Vitalink: No item is defined within the transaction medicationscheme.

Optional

0

Vitalink child transaction TS

Transaction element <item>

Each Kmehr element <item> consists of the next elements:

Element

Vitalink meaning

Kmehr meaning: External Links#kmehr_item

Kmehr

Vitalink

id

Vitalink: For Vitalink, this value has no extra meaning.

Mandatory=
cd

Kmehr: The type of the item.

Vitalink: 1 item "medication" and 0 or more items "transactionreason"

Mandatory=


Transaction element <item> "medication"

The item medication has of the following additional elements:

Element

TypeVitalink

group of elements for

medication information

Refer to corresponding paragraph.Mandatory
beginmoment<date>Mandatory
endmoment<date>Optional, not together with duration
duration

Jira
serverimec Validation Lab
serverIdac11aa92-3976-3161-9ddb-5020cc76f1c7
keyVIM-147

Optional, not together with endmoment
lifecycle
CD-LIFECYCLEMandatory
lnkRefer to corresponding paragraph.Mandatory
Medication elements for medication information

These elements should be exactly the same as the medication information elements of the corresponding transaction MSE. 

Medication element <beginmoment>
Medication element <endmoment>
Medication element <duration>
Medication element <lifecycle>
Medication element <lnk>

This element contains a link to the transaction MSE that is suspended. The content is an XPath link identifying the corresponding MSE by its ID-KMEHR id.

Code Block
languagexml
titleExample
linenumberstrue
...
<transaction>
	<id S="ID-KMEHR" SV="1.0">46</id>
	...
	<cd S="CD-TRANSACTION" SV="1.11">medicationschemeelement</cd>
	...
</transaction>
...
<transaction>
	<id S="ID-KMEHR" SV="1.0">49</id>
	...
	<cd S="CD-TRANSACTION" SV="1.11">treatmentsuspension</cd>
	...
	<item>
		...
		<cd S="CD-ITEM" SV="1.4">medication</cd>
		...
		<lnk TYPE="isplannedfor" URL="//kmehr:transaction[id[@S='ID-KMEHR']='46']"/>
	</item>
	...
</transaction>
...

Transaction element <item> "transactionreason"

The item medication has of the following additional elements:

...