eWZC PAD-02: Home’Link Apotheek v. 2
Beschrijving interface Factuurlink
versie 3.3
Inhoudstafel
1. Inleiding. 3
2. XML-layout 4
2.1 Beschrijving proces. 4
2.2 Beschrijving layout conform de Content
- Introduction.
- XML-layout
2.1 Process description.
2.2 Description layout according to Factuurlink V3.3.XSD.. 4
...
1.
...
Het doel van dit proces is om medicatiefacturen van apothekers naar instellingen (bv. WZC’s) te versturen via eHealthBox. Hierdoor kan de facturatie naar de bewoners van de instellingen vereenvoudigd worden.
We noemen dit “Factuurlink”. De Factuurlink maakt deel uit van het Home’Link Apotheek v2 protocol. De Home’Link omvat alle interface protocollen tussen instelling 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.
De naamgeving van de bestanden en het type wordt gebruikt om te herkennen welke bestanden opgehaald mogen worden.
De instelling neemt initiatief vanuit zijn pakket om de factuur op te halen. Dit gebeurt op basis van de herkenning op naam van de beschikbare bestanden. In de naam zit het type verwerkt via 2 karakters (IN voor factuur), identificatie rustoord en identificatie apotheker.
...
Introduction
The purpose of this process is to send medication invoices from pharmacies to care institution (e.g. rest and care homes). This allows the care home to simplify the resident billing process.
Invoice’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.
The name of the files and the functional type is used to determine which files can be imported.
The care institution imports the file in its software. The file name contains elements that allow the software to determine what to do with the available files. It contains to characters (IN or invoice) referring to the file type, as well as the identification of the care home and the pharmacy.
Remark: This documents mentions version 3.3. Because different parties have been using different version numbers for the same thing, we opted for using the highest number that had been in use. Version 3.3 corresponds to the old version 1.4.
...
1. XML-layout
...
1.1
...
Process description
The file format chosen is XML with UTF-8 encoding,
...
according to HomesExport.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 )
zzzzzzzzzzzzzzzz (11 or 16)
...
yyyymmdd = datum van de transactie
hhmmss = tijdstip van de transactie
tt = type transactie, dus voor de factuur steeds IN.
...
= sender (16 for care homes, 11 for pharmacies )
yyyymmdd = transaction date
hhmmss = transaction time
tt = transaction type: for an invoice this is always ‘IN
When the file is sent via eHealtbox, a functional type will be provided. For invoices, this is HL-IN (which refers to HomeLink-INvoice).
...
1.2
...
Description layout
...
according to Factuurlink V3.3.XSD
...
1.2.
...
1 Invoices
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
Invoice | Complex | Zie See 2.2.2 |
| Ja |
|
| Root Tag |
...
1.2.
...
2 Invoice
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
InvoiceHeader | Complex | Zie See 2.2.3 |
| JaYes |
|
| Hoofding van de factuurInvoice header |
InvoiceDetail | Complex |
| JaYes |
|
| Details van de factuurInvoice detail | |
InvoiceSummary | Complex |
| JaYes |
|
| Totalen van de factuur |
...
Totals on the invoice |
1.2.
...
3 InvoiceHeader
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
InvoiceType | Simple |
| JaYes |
|
| Mag blanco zijnMay be left empty | |
InvoiceStatus | Simple |
|
|
|
| BlancoBlank | |
TaxTreatment | Simple |
|
|
|
| BlancoBlank | |
InvoiceTreatment | Simple |
|
|
|
| BlancoBlank | |
InvoiceNumber | Simple |
|
|
|
| Is officiële factuurnummerOfficial invoice number | |
InvoiceDate | Simple |
| Ja | 10 | A | yyyy-mm-dd | Moet steeds in de maand vallen waarin het rustoord de medicatie wenst door te facturen aan de residenten.This date must fall in the month when the care home wants to bill the residents for the medication.
|
Currency | Simple |
|
|
|
| EUR | |
Party | Complex | Zie See 2.2.4. |
|
|
|
|
|
Customer | Complex | Zie See 2.2.5. |
|
|
|
|
|
1.2.
...
4.
...
Party
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
PartyID | Simple |
| JaYes |
|
| APB | apotheeknumber of the pharmacy |
CompanyNr | Simple |
|
|
|
| Ondernemingsnummer apotheekCompany number of the pharmacy | |
Name | Complex | Zie See 2.2.6 |
|
|
|
|
|
Street | Complex | Zie See 2.2.7 |
|
|
|
|
|
PostalInfo | Complex | Zie See 2.2.8 |
|
|
|
|
|
1.2.
...
5.
...
Customer
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
CustomerID | Simple |
| JaYes |
|
| Klantnummer rustoord bij apotheekCustomer number of the care home in the pharmacy software | |
CustomerCode | Simple |
| JaYes |
|
| RIZIV nr rustoordRIZV/INAMI number of the care home | |
CompanyNr | Simple |
|
|
|
|
| |
Name | Complex | Zie See 2.2.6 |
|
|
|
|
|
Street | Complex | Zie See 2.2.7 |
|
|
|
|
|
PostalInfo | Complex | zie See 2.2.8 |
|
|
|
|
|
1.2.
...
6.
...
Name
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
Name1 | Simple |
| JaYes | VariabelVariable | A | Naam apotheek Name pharmacy (1) | |
Name2 | Simple |
| NeeNo | VariabelVariable | A | Naam apotheek Name pharmacy (2) | |
Name3 | Simple |
| NeeNo | VariabelVariable | A | Naam apotheek Name pharmacy (3) |
1.2.
...
7.
...
Street
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
Street1 | Simple |
| JaYes | VariabelVariable | A | Straat apotheek Street pharmacy (1) | |
Street2 | Simple |
| NeeNo | VariabelVariable | A | Straat apotheek Street pharmacy (2) | |
Street3 | Simple |
| NeeNo | VariabelVariable | A | Straat apotheek Street pharmacy (3) |
1.2.
...
8.
...
PostalInfo
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
City | Simple |
| JaYes | VariabelVariable | A | Gemeente apotheekPlace pharmacy | |
CountrySubEntity | Simple |
| NeeNo | VariabelVariable | A |
| |
PostalCode | Simple |
| JaYes | VariabelVariable | A | Postcode apotheekPostal code pharmacy | |
Country | Simple |
| JaYes | VariabelVariable | A | BE |
1.2.
...
9.
...
InvoiceDetail
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
PatientDetail | Complex | Zie 2.2.10See 0 |
| JaYes |
|
|
|
...
1.2.10 PatientDetail
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
PatientDetailLines | Complex | Zie See 2.2.11 |
| JaYes |
|
|
|
PatientSummary | Complex | Zie See 2.2.15 |
|
|
|
|
|
1.2.
...
11.
...
PatientDetailLines
Fieldname | Type | NederlandsDescription | verplichtMandatory | maxMax. | LengteLength | Type | BeschrijvingSpecification |
BaseItemDetail | Complex | Zie See 2.2.12 |
| JaYes |
|
|
|
1.2.
...
12.
...
BaseItemDetail
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification | LineItemNum
| Simple |
| JaYes |
| N | Lijnnummer factuur over alle records van alle residenten. Is dus uniek per factuur. Beginnen met 1Invoice line number over all records for all residents. Is unique per invoice. Start with 1. | |
PartNumDetail | Complex | Zie See 2.2.13 |
|
|
|
|
|
Quantity | Complex | Zie 2.2.14See 0 |
|
|
|
|
|
TotInterv | Simple |
|
|
| N | Bedrag remgeldAmount co-payment | |
TotPPIncl | Simple |
|
|
| N | Bedrag publieksprijsAmount public price | |
TotDiscount | Simple |
|
|
| N | KortingDiscount | |
TaxPercent | Simple |
|
|
| N | BTW VAT % |
1.2.
...
13.
...
PartNumDetail
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
PartNum | Simple |
| JaYes |
| A | CNK | |
PartDesc | Simple |
| JaYes |
| A | Omschrijving medicamentMedication description |
1.2.
...
14.
...
Quantity
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max lengyj | Type | BeschrijvingSpecification |
Qty | Simple |
| JaYes |
| A | Aantal verpakkingenNumber of packages | |
UnitOfMeasure | Simple |
|
|
| A |
|
...
1.2.15 PatientSummary
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
PatFirstname | Simple |
| JaYes |
| A | VoornaamFirst name | |
PatLastname | Simple |
| JaYes |
| A | FamilienaamLast name | |
PatSSCode | Simple |
| JaYes |
| A | INSZ Nr ( | RijksregisterSocial security number) |
PatAmountPP | Simple |
| JaYes |
| N | Totaal publiekprijs Total public price (informatief) | |
PatAmount | Simple |
| JaYes |
| N | Totaal te betalen door patiënt (btw Total to be paid by patient (VAT incl) | |
PatDiscountAmount | Simple |
| JaYes |
| N | Reeds verrekende korting (btw Discount deducted (VAT incl) |
1.2.
...
16.
...
InvoiceSummary
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
TaxSummary | Complex | Zie See 2.2.17 |
| JaYes |
|
| Samenvatting BTWSummary VAT |
PatientSummary | Complex | Zie See 2.2.15 |
|
|
|
| PatiënttotalenPatient totals |
InvoiceTotals | Complex | Zie See 2.2.19 |
|
|
|
| FactuurtotalenInvoice totals |
ActualPayment | Complex | Zie See 2.2.20 |
|
|
|
| BetalingsinfoPayment information |
1.2.
...
17.
...
TaxSummary
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
Tax | Complex | Zie 2.2.18See 0 |
| JaYes |
|
|
|
1.2.
...
18.
...
Tax
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
TaxFunction | Simple |
| NeeNo |
|
| Niet gebruiktNot used | |
TaxType | Simple |
|
|
|
| Niet gebruiktNot used | |
TaxCategory | Simple |
|
|
|
| Steeds Always ‘APO’ | |
TaxPercent | Simple |
|
|
|
| BTW Tarief, VAT rate: 0, 6, 12, 21 | |
BaseAmount | Simple |
|
|
|
| Basis PP voor kortingBase price for discounts | |
Discount | Simple |
|
|
|
| Korting BTW Discount VAT Excl | |
TaxableAmount | Simple |
|
|
|
| PP Basis na kortingBase price after discounts | |
TaxAmount | Simple |
|
|
|
| BTW op basis na kortingVAT on base price after discounts | |
BaseAmountRem | Simple |
|
|
|
| Basis tussenkomst voor kortingBase refund before discounts | |
TaxableAmountRem | Simple |
|
|
|
| Basis voor BTW op tussenkomst na kortingBase for VAT on refund after discount | |
TaxAmountRem | Simple |
|
|
|
| BTW op tussenkomst na kortingVAT on refund after discount |
1.2.
...
19.
...
InvoiceTotals
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
NetValue | Simple |
| JaYes | VariabelVariable | A | Totaal Basis PP voor kortingTotal base price before discounts | |
TaxValue | Simple |
| NeeNo | VariabelVariable | A | Som BTW op basis PP na kortingSum VAT on base price after discount | |
DiscountValue | Simple |
| NeeNo | VariabelVariable | A | Sm korting BTW Sum discount VAT Excl | |
GrossValue | Simple |
|
|
|
| NetValue + TaxValue - DiscountValue | |
NetValueRem | Simple |
|
|
|
| Som basis tussenkost voor kortingSum base refund before discount | |
TaxValueRem | Simple |
|
|
|
| Som BTW op tussenkomst na kortingSum VAT on refund after discount | |
GrossValueRem | Simple |
|
|
|
| NetValueRem + TaxValueRem – DiscountValue | |
TotReemboursed | Simple |
|
|
|
| Som Remgeld terugbetaalde productenSum Co-payment refunded products | |
TotNonReemboursed | Simple |
|
|
|
| Som Remgeld niet terugbetaalde productenSum Co-payment non-refunded products |
1.2.
...
20.
...
ActualPayment
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
PaymentAmount | Complex | Zie See 2.2.21 |
| JaYes | VariabelVariable | A |
|
PaymentDate | Simple |
| NeeYes | VariabelVariable | A |
|
1.2.
...
21.
...
PaymentAmount
Fieldname | Type | NederlandsDescription | verplicht | max. LengteMandatory | Max length | Type | BeschrijvingSpecification |
LocalCurrencyAmt | Simple |
| JaYes | VariabelVariable | A |
|
...
|