Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

Table of contents

  1. Introduction. 3
  2. XML-layout 4

2.1   Process description. 4

2.2   Description layout according to Factuurlink V3.3.XSD.. 4

 


 

1.   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)             = 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

Description

Mandatory

Max length

Type

Specification

Invoice

Complex

See 2.2.2

 

Ja

 

 

Root Tag

 

 1.2.2 Invoice

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

InvoiceHeader

Complex

See 2.2.3

 

Yes

 

 

Invoice header

InvoiceDetail

Complex

 

Yes

 

 

Invoice detail

InvoiceSummary

Complex

 

Yes

 

 

Totals on the invoice

1.2.3 InvoiceHeader

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

InvoiceType

Simple

 

Yes

 

 

May be left empty

InvoiceStatus

Simple

 

 

 

 

Blank

TaxTreatment

Simple

 

 

 

 

Blank

InvoiceTreatment

Simple

 

 

 

 

Blank

InvoiceNumber

Simple

 

 

 

 

Official invoice number

InvoiceDate

Simple

 

Ja

10

A

yyyy-mm-dd
This date must fall in the month when the care home wants to bill the residents for the medication.

 

Currency

Simple

 

 

 

 

EUR

Party

Complex

See 2.2.4.

 

 

 

 

 

Customer

Complex

See 2.2.5.

 

 

 

 

 

 

 1.2.4. Party

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

PartyID

Simple

 

Yes

 

 

APB number of the pharmacy

CompanyNr

Simple

 

 

 

 

Company number of the pharmacy

Name

Complex

See 2.2.6

 

 

 

 

 

Street

Complex

See 2.2.7

 

 

 

 

 

PostalInfo

Complex

See 2.2.8

 

 

 

 

 

 

 1.2.5. Customer

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

CustomerID

Simple

 

Yes

 

 

Customer number of the care home in the pharmacy software

CustomerCode

Simple

 

Yes

 

 

RIZV/INAMI number of the care home

CompanyNr

Simple

 

 

 

 

 

Name

Complex

See 2.2.6

 

 

 

 

 

Street

Complex

See 2.2.7

 

 

 

 

 

PostalInfo

Complex See 2.2.8

 

 

 

 

 

 

 1.2.6. Name

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

Name1

Simple

 

Yes

Variable

A

Name pharmacy (1)

Name2

Simple

 

No

Variable

A

Name pharmacy (2)

Name3

Simple

 

No

Variable

A

Name pharmacy (3)

 

 1.2.7.Street

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

Street1

Simple

 

Yes

Variable

A

Street pharmacy (1)

Street2

Simple

 

No

Variable

A

Street pharmacy (2)

Street3

Simple

 

No

Variable

A

Street pharmacy (3)

 

 1.2.8. PostalInfo

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

City

Simple

 

Yes

Variable

A

Place pharmacy

CountrySubEntity

Simple

 

No

Variable

A

 

PostalCode

Simple

 

Yes

Variable

A

Postal code pharmacy

Country

Simple

 

Yes

Variable

A

BE

 

 1.2.9. InvoiceDetail

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

PatientDetail

Complex

See 0

 

Yes

 

 

 

 

 


 1.2.10 PatientDetail

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

PatientDetailLines

Complex

See 2.2.11

 

Yes

 

 

 

PatientSummary

Complex

See 2.2.15

 

 

 

 

 

 

 1.2.11. PatientDetailLines

 

Fieldname

Type

Description

Mandatory

Max. Length

Type

Specification

BaseItemDetail

Complex

See 2.2.12

 

Yes

 

 

 

 

 1.2.12. BaseItemDetail

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

 

Simple

 

Yes

 

N

Invoice line number over all records for all residents. Is unique per invoice. Start with 1.

PartNumDetail

Complex

See 2.2.13

 

 

 

 

 

Quantity

Complex

See 0

 

 

 

 

 

TotInterv

Simple

 

 

 

N

Amount co-payment

TotPPIncl

Simple

 

 

 

N

Amount public price

TotDiscount

Simple

 

 

 

N

Discount

TaxPercent

Simple

 

 

 

N

VAT %

 

 1.2.13. PartNumDetail

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

PartNum

Simple

 

Yes

 

A

CNK

PartDesc

Simple

 

Yes

 

A

Medication description

 

 


 1.2.14. Quantity

 

Fieldname

Type

Description

Mandatory

Max lengyj

Type

Specification

Qty

Simple

 

Yes

 

A

Number of packages

UnitOfMeasure

Simple

 

 

 

A

 

 

 1.2.15 PatientSummary

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

PatFirstname

Simple

 

Yes

 

A

First name

PatLastname

Simple

 

Yes

 

A

Last name

PatSSCode

Simple

 

Yes

 

A

INSZ Nr (Social security number)

PatAmountPP

Simple

 

Yes

 

N

Total public price (informatief)

PatAmount

Simple

 

Yes

 

N

Total to be paid by patient (VAT incl)

PatDiscountAmount

Simple

 

Yes

 

N

Discount deducted (VAT incl)

 

 1.2.16. InvoiceSummary

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

TaxSummary

Complex

See 2.2.17

 

Yes

 

 

Summary VAT

PatientSummary

Complex

See 2.2.15

 

 

 

 

Patient totals

InvoiceTotals

Complex

See 2.2.19

 

 

 

 

Invoice totals

ActualPayment

Complex

See 2.2.20

 

 

 

 

Payment information

 

 1.2.17. TaxSummary

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

Tax

Complex

See 0

 

Yes

 

 

 

 

1.2.18. Tax

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

TaxFunction

Simple

 

No

 

 

Not used

TaxType

Simple

 

 

 

 

Not used

TaxCategory

Simple

 

 

 

 

Always ‘APO’

TaxPercent

Simple

 

 

 

 

VAT rate: 0, 6, 12, 21

BaseAmount

Simple

 

 

 

 

Base price for discounts

Discount

Simple

 

 

 

 

Discount VAT Excl

TaxableAmount

Simple

 

 

 

 

Base price after discounts

TaxAmount

Simple

 

 

 

 

VAT on base price after discounts

BaseAmountRem

Simple

 

 

 

 

Base refund before discounts

TaxableAmountRem

Simple

 

 

 

 

Base for VAT on refund after discount

TaxAmountRem

Simple

 

 

 

 

VAT on refund after discount

 

 1.2.19. InvoiceTotals

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

NetValue

Simple

 

Yes

Variable

A

Total base price before discounts

TaxValue

Simple

 

No

Variable

A

Sum VAT on base price after discount

DiscountValue

Simple

 

No

Variable

A

Sum discount VAT Excl

GrossValue

Simple

 

 

 

 

NetValue + TaxValue  - DiscountValue

NetValueRem

Simple

 

 

 

 

Sum base refund before discount

TaxValueRem

Simple

 

 

 

 

Sum VAT on refund after discount

GrossValueRem

Simple

 

 

 

 

NetValueRem + TaxValueRem – DiscountValue

TotReemboursed

Simple

 

 

 

 

Sum Co-payment refunded products

TotNonReemboursed

Simple

 

 

 

 

Sum Co-payment non-refunded products

 

 1.2.20. ActualPayment

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

PaymentAmount

Complex

See 2.2.21

 

Yes

Variable

A

 

PaymentDate

Simple

 

Yes

Variable

A

 

 

 1.2.21. PaymentAmount

 

Fieldname

Type

Description

Mandatory

Max length

Type

Specification

LocalCurrencyAmt

Simple

 

Yes

Variable

A

 

  • No labels