General

This paragraph explains the general principles concerning the storage and consultation of a medication scheme.

A medication scheme consists of

• 1 transaction MS (medicationscheme), 
• 0 or more transactions MSE (medicationschemeelement) and 
• 0 or more transactions TS (treatmentsuspension)

 These transactions are named "a transaction set". This is reflected in the presence of the eHealth Interhub Webservices getTransactionSet and putTransactionSet.

Medication scheme

Read a medication scheme

The web service getTransactionList needs to be called in order to retrieve the id for the transaction MS.

A succesfull response will contain an <id S="LOCAL" SL="vitalinkuri"> whose value is needed as input for the next step in the reading of the medication scheme:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
 <soap:Body>
  <ns3:GetTransactionListResponse xmlns="http://www.ehealth.fgov.be/hubservices/core/v3" xmlns:ns10="urn:be:fgov:ehealth:metahub:protocol:v2" xmlns:ns2="http://www.ehealth.fgov.be/standards/kmehr/schema/v1" xmlns:ns3="http://www.ehealth.fgov.be/hubservices/protocol/v3" xmlns:ns4="urn:be:fgov:ehealth:metahub:core:v2" xmlns:ns5="http://www.w3.org/2001/04/xmlenc#" xmlns:ns6="http://www.w3.org/2000/09/xmldsig#" xmlns:ns7="urn:be:fgov:ehealth:safe:internal:v3" xmlns:ns8="urn:be:fgov:ehealth:safe:common:decryptor:v3" xmlns:ns9="urn:be:fgov:ehealth:safe:common:v3">
   <response>
	...
   </response>
   <acknowledge>
		...
   </acknowledge>
   <kmehrheader>
    <folder>
     <patient>
		...
     </patient>
     <transaction>
      <id S="ID-KMEHR" SV="1.0">1</id>
      <id S="LOCAL" SL="vitalinkuri" SV="1.0">/subject/72071135503/medication-scheme</id>
      <cd S="CD-TRANSACTION" SV="1.6">medicationscheme</cd>
      <cd S="CD-HUBSERVICE" SV="1.0">GetTransactionSet</cd>
      	...
     </transaction>
    </folder>
   </kmehrheader>
  </ns3:GetTransactionListResponse>
 </soap:Body>
</soap:Envelope>

Reading the medication scheme is parsing the response of a getTransactionSet for a specific patient and with the id of the needed transaction MS.

Some Kmehr elements of the response have a meaning in the context of future manipulation of the medication scheme:

Update a medication scheme

Updating a medication scheme means doing putTransactionSet for a specific patient and with the id of the needed transaction MS.

In this set of transactions, MSE/TS transactions can be manipulated as follows:

The MS transaction itself must also be passed as input for the putTransactionSetRequest. 

Here an example of an updated MS transaction:

<transaction>
	<id S="ID-KMEHR" SV="1.0">1</id>
	<cd S="CD-TRANSACTION" SV="1.4">medicationscheme</cd>
	<date>2018-02-09</date>
	<time>10:21:13.603+01:00</time>
	<author>
		<hcparty>
			<id S="ID-HCPARTY" SV="1.0">18334780</id>
			<id S="INSS" SV="1.0">82051234978</id>
			<cd S="CD-HCPARTY" SV="1.1">persphysician</cd>
			<firstname>Hannes</firstname>
			<familyname>De Clercq</familyname>
		</hcparty>
	</author>
	<iscomplete>true</iscomplete>
	<isvalidated>true</isvalidated>
	<version>41</version>
</transaction>

Delete a medication scheme

There is no explicit function to delete a medication scheme. A medication scheme is however implictly deleted by deleting all its MS/TSE transactions.

Create a medication scheme

There is no explicit function to create a medication scheme. A medication scheme is however implictly created by creating 1 or more MS/TSE transaction(s).

MSE/TS transaction

Read a MSE/TS transaction

Reading the MSE/TS transactions means parsing the correspondent transaction elements in the getTransactionSetResponse. 

Create a MSE/TS transaction

An MSE/TS transaction needs to be composed, compliant to the structure described in Medicationscheme Kmehr Structure, where the following elements have a specific meaning:

Here an example of a created MS transaction:

<transaction>
	<id S="ID-KMEHR" SV="1.0">6</id>
	<cd S="CD-TRANSACTION" SV="1.11">medicationschemeelement</cd>
	<date>2018-02-09</date>
	<time>10:21:13.603+01:00</time>
	<author>
		...
	</author>
	<iscomplete>true</iscomplete>
	<isvalidated>true</isvalidated>
	...
</transaction>

Update a MSE/TS transaction

An earlier MSE/TS transaction needs to be adapted, compliant to the structure described in Medicationscheme Kmehr Structure, where the following elements have a specific meaning:

Here an example of an updated MS transaction:

<transaction>
	<id S="ID-KMEHR" SV="1.0">6</id>
	<cd S="CD-TRANSACTION" SV="1.11">medicationschemeelement</cd>
	<date>2018-02-09</date>
	<time>10:21:13.603+01:00</time>
	<author>
		...
	</author>
	<iscomplete>true</iscomplete>
	<isvalidated>true</isvalidated>
	...
</transaction>

Delete a MSE/TS transaction

This can be achieved by not adding the transaction (that needs to be deleted)in the <kmehrmessage> of the putTransactionSetRequest.  

----------------------

A transaction MS must be composed.

Create transaction MSE

Create transaction TS

A transaction TS must be composed.

Update the medication scheme kmehrmessage

A list of URI’s will be submitted with the response message. In this list you’ll find the active medication of the complete medication scheme. So these are the unchanged, added and modified medications.

Update transaction MS

A transaction MS must be composed.

Update transaction MSE

A transaction MS must be composed.

Create transaction MSE

Create transaction TS

Delete transaction MS

A transaction MS must be composed.

Delete transaction TS