| Table of Contents |
|---|
General
This paragraph explains the general principles concerning the storage and consultation of a medication scheme.
| Note |
|---|
When reading or updating the medication scheme, all this information should be displayed, validated and checked by the user in its entirety. |
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
Update a medication scheme
Delete a medication scheme
Create a medication scheme
MSE/TS transaction
Read a MSE/TS transaction
Update a MSE/TS transaction
Delete a MSE/TS transaction
Create a MSE/TS transaction
The CRUD operations (Create, Read, Update, Delete) for the medication scheme can be looked at from 2 points of view:
- the medication scheme as a whole, i.e. the kmehrmessage
- the transactions MS, MSE and TSe
| Read | Create | Update | Delete | |
|---|---|---|---|---|
| medication scheme | GetTransactionSet | PutTransactionSet | PutTransactionSet | not possible |
| transaction MS | As transaction MS in the GetTransactionSetResponse. | The new transaction MS is present in the PutTransactionSetRequest | not possible | not possible |
| transaction MSE | As transaction MSE in the GetTransactionSetResponse. | The new transaction MSE is present in the PutTransactionSetRequest. | The updated transaction MSE is present in the PutTransactionSetRequest. | The transaction MSE is absent in the PutTransactionSetRequest. |
| transaction TS | As transaction TS in the GetTransactionSetResponse. | The new transaction TS is present in the PutTransactionSetRequest. | The updated transaction TS is present in the PutTransactionSetRequest. | The transaction TS is absent in the PutTransactionSetRequest. |
In the next paragraphs, a "Kmehr element" next table shows which values should be put in the Kmehr parent elements (create/update) or how they should be interpreted and used (read).
The "Vitalink element" table shows the input/output values for the Vitalink child elements, but only for those elements that influence the basic CRUD behaviour. The usage of the other elements should be clear when reading Medicationscheme Kmehr Structure.
Read the medication scheme kmehrmessage
Read the transaction MS
Read the transaction MSE
Read the transaction TS
Create the medication scheme kmehrmessage
Creating the medication scheme means that no transactions MSE or TS are present in Vitalink.
Create transaction MS
A transaction MS must be composed.
| Kmehr Element | Input value | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| id | 1 id element should be provided:
For Vitalink, the id with S="vitalinkuri" is optional. However, if given, the SSIN part should match the id with S="ID-PATIENT" of the patient element in the kmehr folder. | ||||||||
| cd | S="CD-TRANSACTION" with value "medicationscheme" | ||||||||
| date | ? | ||||||||
| time | ? | ||||||||
| author | ? | ||||||||
| iscomplete | true
| ||||||||
| isvalidated | true
|
| Vitalink Element | Input value | ||||
|---|---|---|---|---|---|
| version | The are several ways to retrieve the correct input value:
|
Create transaction MSE
A transaction MSE must be composed.
| Kmehr Element | Input value | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| id | 1 id element should be provided:
An id with S="LOCAL" should not be provided. Absence of this id means for Vitalink that this is a new transaction. | ||||||||
| cd | S="CD-TRANSACTION" with value "medicationschemeelement" | ||||||||
| date | ? | ||||||||
| time | ? | ||||||||
| author | ? | ||||||||
| iscomplete | true
| ||||||||
| isvalidated | true
|
Create transaction TS
A transaction TS must be composed.
| Kmehr Element | Input value | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| id | 1 id element should be provided:
An id with S="LOCAL" should not be provided. Absence of this id means for Vitalink that this is a new transaction. | ||||||||
| cd | S="CD-TRANSACTION" with value "treatmentsuspension" | ||||||||
| date | ? | ||||||||
| time | ? | ||||||||
| author | ? | ||||||||
| iscomplete | true
| ||||||||
| isvalidated | true
|
Vitalink Element | Input value |
|---|---|
| lnk | The link to the corresponding transaction MSE, identified by its cd 'ID-KMEHR'. |
| medication | The elements defining the medication information (Medicationscheme Kmehr Structure) should exactly match the medication information elements in the corresponding transaction MSE. |
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.
| Warning | ||
|---|---|---|
| ||
In the RSW and RSB implementations, only the ID of the medication scheme as a whole will be returned. |
Update transaction MS
A transaction MS must be composed.
Kmehr Element | Input value | |||||
|---|---|---|---|---|---|---|
| id | 2 id elements should be provided:
| |||||
| cd | S="CD-TRANSACTION" with value "medicationscheme" | |||||
| date | ? | |||||
| time | ? | |||||
| author | ? | |||||
| iscomplete | true | |||||
| isvalidated | true |
Vitalink Element | Input value |
|---|---|
| version | The version of the transaction MS in the last succesfull GetTransactionSet should be passed. Vitalink will check this version to see if the update is based on the latest transaction MS. |
Update transaction MSE
A transaction MS must be composed.
Kmehr Element | Input value | |||||
|---|---|---|---|---|---|---|
| id | 2 id elements should be provided:
| |||||
| cd | S="CD-TRANSACTION" with value "medicationscheme" | |||||
| date | ? | |||||
| time | ? | |||||
| author | ? | |||||
| iscomplete | true | |||||
| isvalidated | true |
Create transaction MSE
Create transaction TS
Delete transaction MS
A transaction MS must be composed.
Kmehr Element | Input value | |||||
|---|---|---|---|---|---|---|
| id | 2 id elements should be provided:
| |||||
| cd | S="CD-TRANSACTION" with value "medicationscheme" | |||||
| date | ? | |||||
| time | ? | |||||
| author | ? | |||||
| iscomplete | true | |||||
| isvalidated | true |