eWZC PAD-02: Home’Link Apotheek v. 2
|
Analysedocument
Beschrijving interface elektronisch schema “Therapie’Link” versie 1.9
Inhoudstafel
1. Inleiding. 3
2. Description proces Table of contents
- Introduction.
- Description process en XML-layout opmaak bestelling.
...
2.1 Beschrijving procesProcess description. 4
...
2.2 Beschrijving Lay-out conform de Description layout in accordance with TherapieExport.V1v1.9.XSD.. 5
2.2.1 Therapie. 5
2.2.2 Sort order 7
2.2.3 Patients. 8
2.2.4 Patient (Resident) 8
2.2.5 Products. 10
2.2.6 Product (medicament) 10
2.2.7 AdmUnit 12
2.2.8 Adms (Toedieningen) 12
2.2.9 Adm.. 13
1. Inleiding
Het doel van dit protocol is om therapieschema’s van woonzorgcentra (en aanverwanten) te delen met de apotheker. Hierdoor kan de apotheek het therapieschema extra evalueren naar contra-indicatie, interferentie en als basis gebruiken voor de tarificatie per eenheid.
We noemen deze method “Therapie’Link”. De Therapie’Link maakt deel uit van het Home’Link Apotheek v2 protocol. De Home’Link omvat alle interface protocollen tussen rusthuis en apotheek. Het is de tweede versie van het protocol dat initieel in 2007 gelanceerd werd, waarbij naast functionele uitbreidingen ook de beveiligde communicatie van deze medische patiënten gegevens belangrijk is. De Vlaamse overheid en alle Vlaamse beroepsfederaties hebben in het roadbook voor de informatisering van WZC het belang van beveiligde elektronische communicatie tussen zorgactoren toegelicht en de financiering van het eWZC project Pad-02 gekoppeld aan het gebruik van de eHealthbox.
Home’Link Apotheek v2 zal daarom enkel mogen aangewend worden indien de communicatie via de beveiligde eHealthbox verloopt.
Het WZC zal de actuele Therapieschema’s ter beschikking stellen via de eHealthbox van de apotheker.
De apotheker neemt initiatief vanuit zijn pakket om de therapieschema’s op te halen. De TherapieLink bestanden. Dit gebeurt op basis van de herkenning op naam van de beschikbare bestanden. In de naam zit het type verwerkt via 2 karakters (TH voor therapieschema), en de identificatie van WZC en identificatie van apotheker. Het beschikbaar bestand wordt direct verwerkt. Er wordt geen confirmatie teruggestuurd. Het eHealthbox communicatiekanaal voorziet op zich al functies om er zeker van te zijn dat de bestanden bij de juiste bestemmeling worden afgeleverd.
1. Introduction
The purpose of the Therapy’Link process is to send therapy schedules from care institutions (e.g. rest and care homes) via eHealtbox and thereafter to import them in the default pharmacy software. This enables the pharmacy to use the therapy schedule in his software for a.o. tarification per unit, preparing medication doses or creating files for automated dispensing systems. The difference with the Dose’Link file is that the former only contains the multidose medication (= medication dispensed by the pharmacy, either by a robot or manually), whereas Therapy’Link contains all medication, including medication managed by the care institution.
Therapy’Link is part of the Home’Link Pharmacy v2 protocol. Home’Link consists of all interface protocols between care homes and pharmacies. It’s the second version of the protocol which was initially launched in 2007. In the second version, both functional enhancements and secure communication of patient data were important. In the roadbook for the digitization of elderly care homes, the Flemish government and all Flemish professional federations addressed the importance of secure electronic communication between care providers and linked the financing of the eWZC project Pad-02 with the use of eHealthbox.
Care homes register per pharmacy whether they use electronic therapy schedules and to which ehealthID the schedules should be sent. The name of the files and the functional type is used to determine which files can be imported.
The pharmacy imports the files in its software. The file name contains elements that allow the software to determine what to do with the available files. It contains two characters (TH for therapy schedules) referring to the file type, as well as the identification of the elderly care home and the identification of the pharmacy.
The care institution sends the therapy schedules on a daily basis (preferably automated) at an agreed time. The time period covered in the schedule should be at least 10 days, because the tarification per unit is valid for a days, and it is best to have a couple of extra days as a buffer. It is recommended to use send therapy schedules for two weeks as a default.
2. Description process en XML-layout opmaak bestelling
2.1
...
Process description
The file format chosen is XML with UTF-8 encoding
...
Bestandsnaam:
De interface bestanden hebben steeds een naam volgens de volgende structuur:
...
, according to TherapieExport.XSD
File name:
The name of the interface files always needs to be built according to the following structure:
bbbbbbbbbbbbbbbb_zzzzzzzzzzzzzzzz_yyyymmddhhmmss_tt.xml
where
...
...
bbbbbbbbbbbbbbbb (11 or 16)
...
=
...
receiver (16 for care homes, 11 for pharmacies [1])
zzzzzzzzzzzzzzzz (11
...
or 16) =
...
sender (
...
16 for care homes,
...
11 for pharmacies[2])
yyyymmdd = datum van de transactie
hhmmss = tijdstip van de transactie
tt = type transactie, dus voor de therapieschema’s steeds TH.
* Voor een rusthuis wordt bij voorkeur het RIZIV nr gebruikt. Indien niet mogelijk kan in samenspraak een andere alfanumerieke waarde gebruikt worden. Het veld moet met voorloopnullen opgevuld worden tot 16 posities.
Voor een apotheek wordt het APB nr gebruikt. De lengte is 6 lang en wordt met 5 voorloopnullen opgevuld tot 11 posities.
**De care toepassing maakt Therapie’Link bestanden aan op basis van geparametreerd aantal vaste dagen of weken. In het kader van de tarificatie per eenheid moet dit minimaal 10 dagen zijn, maar de werkgroep stelt voor om hier 2 weken te nemen. Het aanmaken en doorsturen volgens 2 scenario’s verlopen, namelijk dagelijks geautomatiseerd of manueel:
- Geautomatiseerd: zodat apotheek dagelijks over een up-to-date medicatieschema beschikt. In de care sofware wordt een afgesproken uur ingesteld.
- Manueel: zodat WZC de recentste wijzigingen nogmaals kan doorsturen (aanvullend)
Alle communicatie verloopt over de beveiligde eHealthbox.
*** De Therapie’Link is inhoudelijk en structureel zeer gelijkend op de Doseer’Link. De Doseer’Link beperkt zich tot de medicatie die door de apotheek via de robot of in een manueel systeem wordt klaargezet en dit voor de productieperiode. De Therapie’Link bevat alle medicatie en voor een langere periode. We raden dan ook aan om de vanuit de Care toepassing enkel de Therapie’Link nog te gebruiken en vanuit de apotheeksoftware een Doseerfile te genereren.
...
yyyymmdd = transaction date
hhmmss = transaction time
tt = transaction type: for a therapy schedule this is always ‘TH’
When the file is sent via eHealtbox, a functional type will be provided. For therapy schedules, this is HL-TH (which refers to HomeLink Therapy).
2.2 Description layout in accordance with TherapieExport.v1.9.XSD
2.2.1.
...
Therapie
Sectie noodzakelijkSection necessary: Ja Yes
BeperkingRestriction: 1 per file, dit ; this is het the root element.
Fieldname | Type | NederlandsDescription | VerplichtMandatory | Max | . LengteLength | Type | BeschrijvingSpecification | ||
SenderNr | Simple | NummerAfzenderSender number | JaYes | 16 | A | Identificatienr. afzender. Dit is de zelfde waarde als gebruikt in de naamgeving. Links aanvullen met ‘0’. Spaties en tekens moeten hieruit gehaald worden. Is RIZIV nummer van het WZC of APBNR van ApotheekIdentification number of the sender. These are the same characters as used for the sender in the file name. At the left side, the number needs to be completed with leading zeroes. Spaces and special characters need to be removed. This is the INAMI number of the care home. | |||
SenderName | Simple | NaamAfzenderSender name | JaYes | 35 | A | Naam instellingName of the care home | |||
ReceiverNr | Simple | NummerBestemmelingReceiver number | JaYes | 11 | A | Identificatienummer afzender. Dit zijn de identieke 16 karakters als gebruikt in de naamgeving. Links aanvullen met ‘0’. Spaties en tekens moeten hieruit gehaald worden. Is APB nummer van de apotheek.Identification number of the receiver. These are the same characters as used for the receiver in the file name. At the left side, the number needs to be completed with leading zeroes. Spaces and special characters need to be removed. This is the APB number of the pharmacy | |||
ReceiverName | Simple | NaamBestemmelingReceiver name | JaYes | 35 | A | Naam apotheekName of the pharmacy | |||
CreationDateTime | Simple | CreatieDatumUur | JaCreation date and time | Yes |
| xs:dateTime | YYYY-MM-DDTHH:MM:SS | Bve.g. 2014-10-09T12:35:55 | Op basis van dit veld kan de apotheek evalueren of het bestand reeds ingelezen werdBased on the information in this field, the pharmacy software can determine whether this file has already been imported. |
StartDate | Simple | StartDatumStart date | JaYes |
| xs:date | YYYY-MM-DD | Is de eerste dag waarvoor het doseerschema is opgemaakt.The first day of the dosage schedule | ||
EndDate | Simple | EindDatumEnd date | JaYes |
| xs:date | YYYY-MM-DD | Is de laatste dag waarvoor het doseerschema is opgemaakt.The last day of the dosage schedule | ||
SortOrder | Simple, | zie see 2.2.2 | SorteringOrder | NeeNo | 70 | A | Bepaalt de sortering waarop het therapieschema moet verwerkt worden. Zie hieronder. Deze heeft voor de therapie geen belang, maar wordt wel overgenomen van de doseer’LinkDetermines the order according to which the therapy schedule should be processed. See below. This is not important for the therapy, but it has been adopted from Dose’Link | ||
Patients | Complex | zie see 2.2.3 |
| JaYes |
|
|
|
2.2.2.
...
Sort order
Deze tag wordt gebruikt wanneer de apotheeksoftware op basis van een TherapieLink-bestand een productiebestand voor de verdeelkast aanmaakt. In deze tag kan het woonzorgcentrum aangeven in welke volgorde/sortering de productie en aanlevering van zakjes moet verlopen:
This tag is used when the pharmacy software creates a production file for an automated dispensing system based on a Therapy’Link file. It is used by the care home for determining the production and delivery order of the medication bags.
<SortOrder>Location2, Date, Hour, Location4, Location5</SortOrder>
De inhoud van dit veld bestaat uit max 7 komma gescheiden delen, gaande van Location1 tot The contents of this field consist of maximum 7 parts separated by commas, starting from Location1 to Location5, plus Date en and Hour:
- In de velden Location1 tot 5 uit de sectie Location 1 to 5 from the section <Patient>
- Date en Hour verwijzen naar <AdmDate> en <AdmHour> uit de sectie and hour refer to <AdmDate> and <AdmHour> from the section <Adm>
Voorbeeld Example 1:
Location1 =
...
Building A,
Location2 =
...
1st floor,
Location3 =
...
Section 1,
Location4 = 101 (
...
room number),
Location5 = A (Bed A)
...
Example 2:
...
Suppose the institution wants the following order: Floor, Room, Bed,
...
Date,
...
Hour
Dan zal <SortOrder> als volgt ingevuld moeten wordenThe field <SortOrder> will need to be filled as follows: “Location2, Location4, Location5, Date, Hour”
Enkele opmerkingenRermarks:
- Men is in de sortering niet verplicht om de 5 locations te gebruiken
- Date en Hour moeten niet noodzakelijk achteraan staan
- Als <SortOrder> niet is ingevuld of meegegeven zal de apotheeksoftware de sortering moeten bepalen.
2.2.3 Patients
Sectie noodzakelijk: Ja
...
- It is not mandatory to use all 5 location for the sorting
- Date and hour don’t necessary need to follow each other
- If <SortOrder> is left empty or hasn’t been provided, the pharmacy software will need to determine the sorting.
2.2.3. Patients
Section necessary: Yes
Restriction: 1 per file
Uitleg: Hierin worden alle patiënten (residenten) geplaatst, waarvoor een doseerschema wordt doorgegevenExplanation: This section contains all patients (residents) for whom a therapy schedule is being provided.
Fieldname | Type | NederlandsDescription | VerplichtMandatory? | Max | . Lengtelength | Type | BeschrijvingSpecification | |
Patient | Complex, | zie see 2.2.4 | .
| JaYes |
|
|
|
...
2.2.
...
4 Patient (Resident)
Sectie noodzakelijknecessary: JaYes
BeperkingRestriction: elke 1 per resident komt 1x voor
Fieldname | Type | NederlandsDescription | VerplichtMandatory? | LengteMax Length | Type | BeschrijvingSpecification | |||||
Id | Simple | Id | JaYes | 20 | N | Volgnr patiënt(interne nummering bij afzenderPatient serial number (Internal number from sender). Possible values : NISS of the patient or INAMI of the home | |||||
Name | Simple | NaamLast name | JaYes | 48 | A | Naam patiëntLast name of the patient | |||||
Firstname | Simple | VoornaamFirst name | JaYes | 24 | A | Voornaam patiëntFirst name of the patient | |||||
HomeID | Simple | HomeId | NeeNo | 20 | A | Patient ID | die in de instelling gebruikt wordt.used in the care home software | ||||
Location1 | Simple | Locatie1Location1 | NeeNo | 40 | A | Hoogste niveau om de locatie te bepalen (bvb Gebouw Highest level used to determine the location (e.g. Building A) | |||||
Location2 | Simple | Locatie2Location2 | NeeNo | 40 | A | 2e niveau om de locatie te bepalen (bvb 1e verdieping2nd level to determine the location (e.g. 1st floor) | |||||
Location3 | Simple | Locatie3Location3 | NeeNo | 40 | A | 3e niveau om de locatie te bepalen (bvb Sectie 3d level to determine the location (e.g. Section 1) | |||||
Location4 | Simple | Locatie4Location4 | NeeNo | 40 | A | 4e niveau om de locatie te bepalen (bvb Kamernummer4th level to determine the location (e.g. room number) | |||||
Location5 | Simple | Locatie5Location5 | NeeNo | 40 | A | 5 | e niveau om de locatie te bepalen (bvb th level to determine the location (e.g. Bed A) | ||||
Birthdate | Simple | GeboortedatDate of birth. | NeeNo |
| xs:date | YYYY-MM-DD | |||||
DoctorName | Simple | NaamDokterName doctor | NeeNo | 40 | A | Naam behandelende dokter van de residentName of doctor treating the patient | |||||
DoctorMedRegNr | Simple | RizivNrDokter | NeeINAMI/RIZIV number doctor | No | 11 | N | Riziv nummer van de behandelende dokter (verplicht als NaamDoktor is meegegeven) | PatientUnidose | Simple | PatientUnidose | NeeINAMI/RIZIV number of the doctor treating the patient (mandatory if DoctorName is provided) |
ShortStay | Simple | Short stay | No | 1 | N | 0 | of 1 (1= voor deze resident wordt er een multidosebeheer toegelaten, 0 is geen MD)PatientUnidosePacket= not a short stay resident | ||||
PatientUnidose | Simple | PatientUnidosePacketPatientUnidose | NeeNo | 1 | N | 0 | = voor de maaltijd|||||
PatientRemark | Simple | PatientRemark | Nee |
| A | Opmerking op niveau van de patiënt | |||||
Shortstay | Simple | Kortverblijf | Nee |
| A | Is de resident opgenomen in kortverblijf 0=geen kortverblijf 1=kortverblijf | |||||
SubstitutionAllowed | Simple | SubstitutionAllowed | Neeor 1 (1= multi dose management allowed fort his resident, 0 = no multi dose management allowed) | ||||||||
PatientUnidosePacket | Simple | PatientUnidosePacket | No | 1 | N | 0= | nietbefore food 1= | wel||||
Pulverize | Simple | Pletten | Nee | 1 | N | Moet medicatie geplet worden 0 = neen 1 = ja | |||||
Products | with food 2= after food Used for all medication for this patient |
2.2.5.
...
...
Products
...
...
2.2.5 Products
Sectie noodzakelijk: Ja
Uitleg: komt 1x per patiënt voorSection necessary: Yes
Explanation: 1 per resident
Fieldname | Type | NederlandsDescription | VerplichtManadtory? | Max | . LengteLength | Type | BeschrijvingSpecification | |
Product | Complex | Zie See 2.2.6 | .
| JaYes |
|
|
|
2.2.
...
6.
...
Product (
...
medication)
Sectie noodzakelijknecessary: Ja Yes
Uitleg: Dit zal voor elk medicament dat in het doseerschema voorkomt herhaald worden.Explanation: This section will be repeated for each medication in the dosage schedule.
Fieldname | Type | NederlandsDescription | VerplichtMandatory | Max | . LengteLength | Type | BeschrijvingSpecification | |||
ProductId | Simple | CNK | JaYes | 20 | N | CNK | van het medicament of apotheek eigen CNK toegekend aan magistrale bereiding.code of the package or CNK code given by the pharmacy to a magisterial preparation
| |||
ProductIdHome | Simple | IdMedicamentIdMedication | JaYes | 20 | A | Id medicament gebruikt in software instellingUnique number for the medication used in the care home software | ||||
PreparationId | Simple | IdBereidingIdPreparation | NeeNo | 20 | A | Nummer van de bereidingInternal number used by the institution for the preparation | ||||
Speciality | Simple | SpecialiteitSpeciality | JaYes | 1 | N | 0= | magistrale bereidingmagisterial preparation 1= | product met proprietary drug with CNK | ||
Dsc | Simple | OmschrijvingDescription | JaYes | 120 | N | Omschrijving medicamentDescription of the medication | ||||
Formula | Simple | FormuleFormula | NeeNo |
| A | Formule medicament voor magistrale bereidingenFormula of the magisterial preparation | ||||
TabletUnidose | Simple | TabletUnidose | NeeNo | 1 | N | 0 | of or 1 (1= | dit multi dose product | is MD, 0 | is Niet-MD= not a multi dose product) |
TabletUnidosePacket | Simple | TabletUnidosePacket | NeeNo | 1 | N | 0= | voor, before food 1= | tijdens,with food 2= | na de maaltijdIs voor dit medicamentafter food Used for this medication | |
AdmUnit | Complex | Zie See 2.2.7 |
| NeeNo |
|
|
| |||
PrescriptionId | Simple | VoorschriftIdPrescriptionID | NeeNo | 30 | N | Id van het voorschriftID of the prescription | ||||
StartTreatment | Simple | StartPosologieStart posology | NeeNo | 8 | xs:date | YYYY-MM-DD | Startdatum van de huidige posologie /behandeling van dit medicamentStart date of the current posology/treatment for this medication | |||
StopTreatment | Simple | StopPosologieStop posology | NeeNo | 8 | xs:date | YYYY-MM-DD | Stopdatum van de huidige posologie / behandeling van dit medicament. Indien niet meegegeven is dit onbepaaldStop date of the current posology/treatment for this medication. If this date is not provided, it is undefined. | |||
Adms | Complex | Zie See 2.2.8 |
| Ja |
|
|
| |||
ProductRemark | Simple | ProductOpmerkingProduct remark | NeeNo |
| A | Opmerkingen op product niveau |
2.2.7 AdmUnit
Sectie noodzakelijk: Nee
Beperking: geen, kan dus meerdere keren voorkomen.
...
Remarks on the product level |
2.2.7. AdmUnit
Section necessary: No
Restrictions: None; this section can be repeated
This section will be repeated for each language
Fieldname | Type | NederlandsDescription | VerplichtManadtory? | Max | . Lengtelength | Type | BeschrijvingSpecification |
DscLg | Simple | TaalLanguage | JaYes | 2 | A | Moet NL voor Nederlands, FR voor Frans zijn. Er moet minstens 1 taal aanwezig zijnMust be NL for Dutch and FR for French. At least one language should be present. | |
Dsc | Simple | OmschrijvingDescription | Ja |
| A | De omschrijving van de toedieningseenheidThe description of the administration unit. |
2.2.
...
8.
...
Adms (
...
administrations)
Sectie noodzakelijknecessary: jaYes
BeperkingRestriction: komt 1x voor 1 per productUitleg: Lijst van de toedieningsmomenten voor de te verpakken medicatie OF AdHoc aanduiding (indien nodig).
Explanation: List of administration moments for medication to be dispensed, or indication ‘adhoc’ for medication that needs to be administered if needed.
Fieldname | Type | NederlandsDescription | VerplichtMandatory | Max | . Lengtelength | Type | BeschrijvingSpecification |
Adm | Complex | Zie See 2.2.8 |
| Yes | Ja
|
|
|
or
OF
Fieldname | Type | NederlandsDescription | Verplichtverplicht | Maxmax. Lengte | Type | BeschrijvingSpecification | ||
AdHoc | Simple | IndienNodigIf needed | JaYes | 1 | N | Geen vast toedieningsmoment, enkel innemen indien nodig No fixed administration moment, only administer if needed? 0 = | neenno 1 = | jayes |
Dus voor alle duidelijkheid:
The section will contain either
<Adms>
<Adm>…</Adm>
<Adm>…</Adm>
<Adm>…</Adm>
</Adms>
Ofor
<Adms>
<Adhoc>1</Adhoc>
</Adms>
Een combinatie van beide is NIET toegestaanA combination of both is NOT allowed.
2.2.
...
9.
...
Adm
Sectie noodzakelijknecessary: Ja Yes
Beperking: geen, kan dus meerdere keren voorkomen.
Deze sectie zal voor elk toedieningsmoment herhaald worden en dit voor de ganse periode waarvoor het bestand is aangemaakt.
bv. Als bestand is opgemaakt voor 7 dagen en het moet 3x daags genomen worden, dan geeft 21 lijnenRestriction: none; this section can be repeated.
This section will be repeated for each administration moment, and this for the entire period for which the file has been created.
E.g. If the file has been created for 7 days, and the medication needs to be taken 3 times per day, this will result in 21 lines.
Fieldname | Type | NederlandsDescription | VerplichtMandatory? | Max | . LengteLength | Type | BeschrijvingSpecification | ||
Qty | Simple | AantalQuantity | JaYes | 8 | N | Aantal eenheden dat moeten toegediend worden. Mag met 2 decimalen.Number of units to be administered. 2 decimal places allowed. | Een ¼ tablet wordt A quarter tablet will be 0.25 | Anderhalf wordt One and a half tablet will be 1.50 | In de rustoordsoftware dient ingesteld te worden of decimalen mogen opgenomen wordenIt needs to be defined in the care home software whether decimal places may be used. |
AdmDate | Simple | ToedieningsDatumAdministration date | JaYes | 8 | N | YYYY-MM-DD | |||
AdmHour | Simple | ToedieningsUurAdministration hour | JaYes |
| xs:time | HH:MM:SS | Is het startuur van het toedieninsgmoment.This is the starting hour of the administration period | ||
AdmCode | Simple | Code | Toedieningswijzeadministration method | NeeNo |
| A | Zie onderstaande tabel. Kolom See table below. Column Code is enumeration | uit from XSD. |
[1] The RIZIV-number is used for care homes. The length of this number is variable, depending on the type of home, and needs to be completed with leading zeroes up to 16 positions.
The APB-number is used for pharmacies. The length of this number is 6 characters. It needs to be completed with leading zeroes up to 11 positions.
[2] The RIZIV-number is used for care homes. The length of this number is variable, depending on the type of home, and needs to be completed with leading zeroes up to 16 positions.
The APB-number is used for pharmacies. The length of this number is 6 characters. It needs to be completed with leading zeroes up to 11 positions.