vpk:Vdraft FHIR eOverdracht Proeftuin
Introduction
This page details the HL7 FHIR requirements for exchanging the data in the Verpleegkundige eOverdracht Proeftuin pilot described in this functional design. Implementation of these transactions is spread over multiple phases. In the first Phase of the Proeftuin a simplified version of both the Aanmeldbericht en Overdrachtsbericht are being used. Both messages excist out of four HCIMs listed in the table below. The Aanmeldbericht is send to the recieving organisation, which after confirmation of recieving the aanmeldberricht, gets send the Overdrachtbericht. This FHIR implementation guide assumes the sending XIS is able to make a connection with the recieving XIS. It does not provide information on finding the right XIS nor does it provide information about security.
Packages
eOverdracht uses the FHIR Packaging mechanism. This conveniently bundles all examples, profiles and other conformance resources you need into a single download. This version of the information standard depends on Nictiz Zib2017 package . Please note that the direct links to the various conformance resources below will take you to the latest version, which might not match the package version. At time of writing, there is no way to render the conformance resource as found in the package. This is on the roadmap for Simplifier.
Phase two consists of the complete Aanmeldbericht as well as an incomplete Overdrachtsbericht. The Overdrachtsbericht is a subset of 11 HCIM's (complete set used in Aanmeldbericht) and an unstructured PDF containing the remaining data which are not part of the HCIM's.
Phase three is the complete dataset of the Aanmeldbericht, Overdrachtsbericht Volwassenen, Overdrachtsbericht Kinderen 0-1 jaar, Overdrachtsbericht Kinderen 1-18 jaar as PUSH messages.
|
|
Basic FHIR(STU3) knowledge is required. |
Use case 1A: Send Overdrachtsbericht volwassenen (PUSH)
Introduction
The Send Overdrachtsbericht scenario is used by the sending XIS to send the relevant data for the patient care to the receiving XIS. The structure of the eventual scenario is described in the functional design and additionally in Opbouw eOverdracht Overdrachtsbericht. For the pilot a limited subset is implemented.
Actors
| Transaction group | Transaction | Actor | Role |
|---|---|---|---|
| Send eOverdracht Overdrachtbericht(PUSH) | Send overdrachtbericht | Healthcare professional (using a XIS) | Sends overdrachtbericht to the receiving XIS |
Invocation
The Send Overdrachtbericht transaction is an HTTP POST method on the target XIS's base:
POST [base] {?_format=[mime-type]}
where the body of the POST request is the assembled Bundle.
Trigger events
This transaction is invoked when the XIS needs to send the eOverdrachtbericht to the receiving XIS.
Expected response
The document Bundle should be processed as a transaction by the receiving XIS and each Bundle.entry should be treated as a create interaction for the Bundle.entry.resource.
When the resource syntax or data is incorrect or invalid and cannot be used to create a new resource, or when the server rejects the content of the resource because of business rules, it should perform a rollback of the creation of any previous entries and send the appropriate response.
On success, the target XIS SHALL respond:
- With the HTTP status code 201 Created.
- With the Location header containing the new Logical Id and Version Id of the created resource version.
- With a response body set to a Bundle of type "transaction-response", containing one entry for each entry in the request, in the same order, with the outcome of processing the entry.
On failure, the target XIS SHALL respond:
- With an HTTP status code set appropriate to the processing outcome:
- When the resource syntax or data is incorrect or invalid, and cannot be used to create a new resource, the server returns a 400 Bad Request HTTP status code.
- When the server rejects the content of the resource because of business rules, the server returns a 422 Unprocessable Entity error HTTP status code. Additional HTTP status code may be used if more appropriate.
- With a response body set to a FHIR OperationOutcome resource with detailed error messages describing the reason for the error.
Structure of the Overdrachtbericht phase 1 (4HCIMs + PDF)
Both the Aanmeldbericht as the eOverdrachtbericht are sent as a FHIR Document. To create this document, a FHIR Composition resource should be created according to the relevant Composition profiles.
A client may use the returned Bundle to track the outcomes of processing the entry, and the identities assigned to the resources by the server. Each entry element SHALL contain a response element which details the outcome of processing the entry - the HTTP status code, and the location and ETag header values, which are used for identifying and versioning the resources. In addition, a resource may be included in the entry, as specified by the Prefer header.
The Overdrachtsbericht consists of multiple FHIR resources, which are assembled into a FHIR Bundle. The table below lists the FHIR StructureDefinitions that are applicable for the pilot implementation of the 'Overdrachtsbericht' transactions. During phase 1, the Overdrachtsbericht is based on the same 4 HCIMs as the aanmeldbericht (Patient, Betaler, Contactpersoon en Zorgaanbieder).
Use case 3A: Send Aanmeldbericht (PUSH)
Introduction
The Send Aanmeldbericht scenario is used by the sending XIS to send the relevant data for the patient intake to the receiving XIS, and constitutes a subset of the Overdrachtsbericht. The structure of the eventual scenario is described in the functional design and additionally in Opbouw eOverdracht aanmelding. For the pilot a limited subset is implemented.
Actors
| Transaction group | Transaction | Actor | Role |
|---|---|---|---|
| Send eOverdracht Aanmeldbericht(PUSH) | Send aanmeldbericht request | Healthcare professional (using a XIS) | Sends aanmeldbericht to the receiving XIS |
| Send aanmeldbericht response | Receiving XIS | Sends acknowledgement message to sending XIS |
Invocations
The Send Aanmeldbericht transaction is an HTTP POST method on the target XIS's base:
POST [base] {?_format=[mime-type]}
where the body of the POST request is the assembled Bundle.
Trigger events
This transaction is invoked when the patiënt is ready for transfer, and the sending XIS wants to confirm a recieving XIS.
Server response
Structure of the Aanmeldbericht phase 1
Both the Aanmeldbericht as the eOverdrachtbericht are sent as a FHIR Document. To create this document, a FHIR Composition resource should be created according to the relevant Composition profiles.
The Aanmeldbericht consists of multiple FHIR resources, which are assembled into a FHIR Bundle. The table below lists the FHIR StructureDefinitions that are applicable for the pilot implementation of the 'Aanmeldbericht' transactions.
| Section | FHIR profile | FHIR resource | HCIM name | HCIM version | Remarks |
|---|---|---|---|---|---|
| - | aanmeldbericht phase one@ http://nictiz.nl/fhir/StructureDefinition/eOverdracht-aanmeldbericht-phase-one | Composition | - | - | Declaration of the Send Aanmeldbericht transaction. |
| Datum overplaatsing | http://nictiz.nl/fhir/StructureDefinition/eOverdracht-TransferDate | - | - | - | DateTime extension used in eOverdracht composition profiles |
| Persoonsgegevens | http://fhir.nl/fhir/StructureDefinition/nl-core-patient | Patient | Patient | v3.1(2017NL) | - |
| http://nictiz.nl/fhir/StructureDefinition/zib-Payer | Coverage | Betaler | v3.1(2017NL) | - | |
| Sturende organisatie | http://fhir.nl/fhir/StructureDefinition/nl-core-organization | Organization | Zorgaanbieder | v3.1.1(2017NL) | - |
| Ontvangende organisatie | http://fhir.nl/fhir/StructureDefinition/nl-core-organization | ||||
| Binary | Binary | - | - | Should be used to send unstructured PDF data. |
FHIR CapabilityStatements
Phase one
- server@ http://nictiz.nl/fhir/CapabilityStatement/eOverdracht-servercapabilities-phase-one
- server@ http://nictiz.nl/fhir/CapabilityStatement/eOverdracht-clientcapabilities-phase-one
FHIR Examples
Example instances can be found on Simplifier: