Search

Receive documents

Introduction

By implementing the "Receive documents" component in a connector with ZorgDomein, you enable your application to receive and process clinical documents such as appointment requests, referral letters, healthcare requests, reports and transfer dossiers directly in your application. ZorgDomein can deliver these documents in two different formats in your application:

  • As a HL7 FHIR Document, see specifications for details.
  • As a HL7v2 message, see message specifications for details. Please note that this format is based on the older HL7v2 standard. Only clinical documents for referrals and request forms for diagnostic research are supported. Future developments on our interfaces will focus on HL7 FHIR.

Transactions and document types

Most of the core functionalities of the ZorgDomein application are based on the concept of transactions. Each transaction involves the exchange of one or more documents to transfer the request or message. ZorgDomein has implemented different document types that are used in the different transaction types. See the functional documentation of transactions and documents for more details.

Recipient types

ZorgDomein supports different recipient types for incoming documents:

  • Person: the document is aimed at a specific person. Documents for reports are typically sent to individual persons.
  • Organizational unit: the document is aimed at a specific organizational unit, also known as a ZorgDomein “cluster”. All organizations in ZorgDomein have one or more clusters. Small practices only have one cluster for the entire organization, large hospitals have dozens of clusters to identify different locations, departments or specialisms. Documents for referrals, requests and transfers are typically sent to organizational units (clusters).

When receiving a document in your application, it is important that the document is delivered at and exposed to the right recipient. This means that a document that is sent to an individual person should not be exposed to an entire organization. Each document that is sent via ZorgDomein is labeled with a unique identifier that should be used to route and deliver the document to the intended recipient.

NB: since HL7v2 messages only support referrals and diagnostic requests, they don’t support individual persons as a recipient (these transaction types cannot be sent to individual persons). 

Validation criteria

Before a connector with ZorgDomein can be released, ZorgDomein will validate the connector against a set of validation criteria. These validation criteria consist of functional and technical validation criteria. The functional criteria for this component are listed below. 

The application must support:

  1. receiving and storing all incoming document types.
  2. receiving and storing all incoming attachments.
  3. routing all incoming documents to the intended recipient, both for organizational units and individual persons.
  4. notifying authorized user(s) of new documents. 
  5. showing all incoming documents to the authorized user(s) within the UI of the application.
  6. grouping incoming documents that are part of a single transaction based on ZD-number. 
  7. making a clear distinction between read and unread documents. 
  8. linking an incoming document to an already registered patient automatically.
  9. registering a new patient based on the patient details provided in the document if the patient has not been registered yet. 
  10. receiving and processing documents for patients that do NOT have a BSN. 
  11. receiving a document as an idempotent operation: receiving the same document multiple times should not trigger errors in the response or multiple documents in the UI of the application.
  12. auto-activation