vpk:Vdraft FHIR eOverdracht Proeftuin: verschil tussen versies

Uit informatiestandaarden
Naar navigatie springen Naar zoeken springen
k (Pieter Edelman heeft pagina Vdraft FHIR eOverdracht Proeftuin hernoemd naar vpk:Vdraft FHIR eOverdracht Proeftuin)
Regel 1: Regel 1:
 
=Introduction=
 
=Introduction=
  
−
This page details the HL7 FHIR requirements for exchanging the data in the Verpleegkundige eOverdracht Proeftuin pilot described in [[vpk:V3.1 eOverdracht Proeftuin|this functional design]].
+
This page details the HL7 FHIR requirements for exchanging the data in the eOverdracht Proeftuin pilot described in [[vpk:V3.1 eOverdracht Proeftuin|the 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==
+
This FHIR implementation guide assumes the sending XIS is able to make a connection with the receiving XIS. It does not provide information on finding the right XIS nor does it provide information about security.
−
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 [https://simplifier.net/NictizSTU3-Zib2017/~packages Nictiz Zib2017 package {{VersieInfo|V2019.01|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.
 
  
 +
{{NoteBox|Basic knowledge of [https://www.hl7.org/fhir/stu3/ FHIR(STU3)] is assumed.}}
 +
 +
TODO
 +
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 exist 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.
 
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 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.
 
Phase three is the complete dataset of the Aanmeldbericht, Overdrachtsbericht Volwassenen, Overdrachtsbericht Kinderen 0-1 jaar, Overdrachtsbericht Kinderen 1-18 jaar as PUSH messages.
 +
/TODO
  
−
{{NoteBox|Basic [https://www.hl7.org/fhir/stu3/ FHIR(STU3)] knowledge is required.}}
+
==Package and dependencies==
−
 
+
eOverdracht uses the FHIR Packaging mechanism to conveniently bundle all examples, profiles and other conformance resources you need into a single download. The eOverdracht package has a dependency on the [https://simplifier.net/NictizSTU3-Zib2017/~packages Nictiz Zib2017 package {{VersieInfo|V2019.01|package}}].
−
=Use case 1A: Send Overdrachtsbericht volwassenen (PUSH) =
+
==Examples==
 +
Example instances of the FHIR messages can be found on Simplifier:
 +
* [https://simplifier.net/nictiz-stu3-eoverdracht/~resources?category=Example&exampletype=Composition Composition examples]
 +
* [https://simplifier.net/nictiz-stu3-eoverdracht/~resources?category=Example&exampletype=Bundle Bundle examples]
 +
=Use case 1A: Send Overdrachtsbericht volwassenen (PUSH)=
 
==Introduction==
 
==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 [[vpk:V3.1_Opbouw_eOverdracht_volwassenen|Opbouw eOverdracht Overdrachtsbericht]]. For the pilot a limited subset is implemented.
+
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 [[vpk:V3.1_Opbouw_eOverdracht_volwassenen|Opbouw Overdrachtsbericht Volwassenen]]. For the pilot a limited subset is implemented.
 
==Actors==
 
==Actors==
 
{| class="wikitable" "cellpadding="10"
 
{| class="wikitable" "cellpadding="10"
Regel 25: Regel 29:
 
! style="text-align:left;"| '''Role'''
 
! style="text-align:left;"| '''Role'''
 
|-
 
|-
−
|style="background-color: white;vertical-align:top;"rowspan="2"|Send eOverdracht Overdrachtbericht(PUSH)
+
|style="background-color: white;" rowspan="2"|Send Overdrachtbericht (PUSH)
−
|style="background-color: white;vertical-align:top;"|Send overdrachtbericht
+
|style="background-color: white;" rowspan="2"|Send Overdrachtsbericht
−
|style="background-color: white;vertical-align:top;"|Healthcare professional (using a XIS)
+
|style="background-color: white;"|Healthcare professional at organization A (using a XIS)
−
|style="background-color: white;vertical-align:top;"|Sends overdrachtbericht to the receiving XIS
+
|style="background-color: white;"|Sends Overdrachtsbericht
 +
|-
 +
|style="background-color: white;"|Healthcare professional at organization B (using a XIS)
 +
|style="background-color: white;"|Receives Overdrachtsbericht
 
|}
 
|}
 
==Invocation==
 
==Invocation==
−
The Send Overdrachtbericht transaction is an HTTP POST method on the target XIS's base:
+
The Send Overdrachtsbericht transaction is an HTTP POST method on the target XIS's base:
 
  POST [base] {?_format=[mime-type]}
 
  POST [base] {?_format=[mime-type]}
−
where the body of the POST request is the assembled Bundle.
+
where the body of the POST request is a FHIR document (see [[#Structure of the Overdrachtsbericht (4 HCIMs + PDF)]]).
 
===Trigger events===
 
===Trigger events===
−
This transaction is invoked when the XIS needs to send the eOverdrachtbericht to the receiving XIS.
+
This transaction is invoked when the sending XIS needs to send the Overdrachtsbericht to the receiving XIS.
 
===Expected response===
 
===Expected response===
−
The document Bundle should be processed as a [http://hl7.org/fhir/STU3/http.html#transaction transaction] by the receiving XIS and each ''Bundle.entry'' should be treated as a ''create'' interaction for the ''Bundle.entry.resource''.
+
The document Bundle should be processed as a [http://hl7.org/fhir/STU3/http.html#transaction transaction] by the receiving XIS and each <code>Bundle.entry</code> should be treated as a <code>create</code> interaction for the <code>Bundle.entry.resource</code>. When the receiving XIS cannot create a new resource because of incorrect data or business rules, it should perform a rollback of the creation of any previous entries.
−
 
 
−
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:
 
On success, the target XIS SHALL respond:
 
* With the HTTP status code 201 Created.
 
* 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 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.
+
* 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. The sender may use the returned Bundle to track the outcomes of processing the entry, and the identities assigned to the resources by the server.
  
 
On failure, the target XIS SHALL respond:
 
On failure, the target XIS SHALL respond:
 
* With an HTTP status code set appropriate to the processing outcome:
 
* 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 resource syntax or data is incorrect or invalid, the status code should be 400 Bad Request.
−
** 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.
+
** When the server rejects the content of the resource because of business rules, the status code should be 422 Unprocessable Entity.
 +
** Additional HTTP status code may be used if more appropriate.
 
* With a response body set to a FHIR [http://hl7.org/fhir/STU3/operationoutcome.html OperationOutcome] resource with detailed error messages describing the reason for the error.
 
* With a response body set to a FHIR [http://hl7.org/fhir/STU3/operationoutcome.html OperationOutcome] resource with detailed error messages describing the reason for the error.
 +
==Structure of the Overdrachtsbericht (4 HCIMs + PDF)==
 +
The Overdrachtsbericht consists of multiple FHIR resources, which are assembled into a FHIR [https://www.hl7.org/fhir/STU3/documents.html FHIR Document]. To create this document, a FHIR Composition resource should be created that references the relevant resources. The Composition resource is then bundled together with all referenced resources in a Bundle of type "document". The Composition resource SHOULD be the first entry. During phase 1, the Overdrachtsbericht is based on the same 4 HCIMs as the Aanmeldbericht (Patient, Betaler, Contactpersoon en Zorgaanbieder).
  
−
==Structure of the Overdrachtbericht phase 1 (4HCIMs + PDF)==
+
The table below lists the FHIR profiles<ref name="nopackage">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.</ref> that are applicable for the pilot implementation of the Overdrachtsbericht transaction. All resources SHALL conform to the profiles listed in this table and SHALL include the profile canonical URL in the <code>meta.profile</code> element.
−
Both the Aanmeldbericht as the eOverdrachtbericht are sent as a [https://www.hl7.org/fhir/STU3/documents.html FHIR Document]. To create this document, a FHIR Composition resource should be created according to the relevant [https://simplifier.net/NictizSTU3-Zib2017/~resources?text=eoverdracht&category=Profile&corebasetype=Composition 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 [http://hl7.org/fhir/STU3/bundle.html 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).  
 
  
 
{| class="wikitable" style="horizontal-align: right"
 
{| class="wikitable" style="horizontal-align: right"
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:400px" | Section
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | Section
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:400px" | FHIR profile
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | FHIR profile
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:50px" | FHIR resource
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | FHIR resource
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:50px" | HCIM name
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | HCIM name
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:50px" | HCIM version
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | HCIM version
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:50px" | Remarks
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | Remarks
 
|-
 
|-
−
|  
+
| -
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/eOverdracht-Overdrachtsbericht-volwassenen-phase-one|eOverdracht Overdrachtsbericht volwassenen phase one}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/eOverdracht-Overdrachtsbericht-volwassenen-phase-one|Overdrachtsbericht phase 1}}
 
| Composition
 
| Composition
 
| -
 
| -
 
| -
 
| -
−
| Declaration of the Send Overdrachtsbericht volwassenen phase one transaction.
+
| The Composition resource used to assemble the document
 
|-
 
|-
 
|-
 
|-
 
| Datum overplaatsing
 
| Datum overplaatsing
 
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/eOverdracht-TransferDate|eOverdracht-TransferDate}}
 
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/eOverdracht-TransferDate|eOverdracht-TransferDate}}
 +
| ''extension''
 
| -
 
| -
 
| -
 
| -
−
| -
+
| extension in the Composition resource
−
| DateTime extension used in eOverdracht composition profiles
 
 
|-
 
|-
 
| rowspan="2"|Persoonsgegevens
 
| rowspan="2"|Persoonsgegevens
Regel 132: Regel 135:
 
| -
 
| -
 
| -
 
| -
−
| Should be used to send unstructured PDF data.
+
| Used to send unstructured PDF data
 
|}
 
|}
  
 
=Use case 3A: Send Aanmeldbericht (PUSH)=
 
=Use case 3A: Send Aanmeldbericht (PUSH)=
 
==Introduction==
 
==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 [[vpk:V3.1_Opbouw_eOverdracht_aanmelding|Opbouw eOverdracht aanmelding]]. For the pilot a limited subset is implemented.
+
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 [[vpk:V3.1_Opbouw_eOverdracht_aanmelding|Opbouw Aanmeldbericht]]. For the pilot a limited subset is implemented.
 
==Actors==
 
==Actors==
 
{| class="wikitable" "cellpadding="10"
 
{| class="wikitable" "cellpadding="10"
Regel 145: Regel 148:
 
! style="text-align:left;"| '''Role'''
 
! style="text-align:left;"| '''Role'''
 
|-
 
|-
−
|style="background-color: white;vertical-align:top;" rowspan="2"|Send eOverdracht Aanmeldbericht(PUSH)
+
|style="background-color: white;" rowspan="2"|Send Aanmeldbericht(PUSH)
−
|style="background-color: white;vertical-align:top;"|Send aanmeldbericht request
+
|style="background-color: white;"|Send Aanmeldbericht
−
|style="background-color: white;vertical-align:top;"|Healthcare professional (using a XIS)
+
|style="background-color: white;"|Healthcare professional at organization A (using a XIS)
−
|style="background-color: white;vertical-align:top;"|Sends aanmeldbericht to the receiving XIS
+
|style="background-color: white;"|Sends Aanmeldbericht
 
|-
 
|-
−
|style="background-color: white;vertical-align:top;"|Send aanmeldbericht response
+
|style="background-color: white;"|Healthcare professional at organization B (using a XIS)
−
|style="background-color: white;vertical-align:top;"|Receiving XIS
+
|style="background-color: white;"|Receives Aanmeldbericht
−
|style="background-color: white;vertical-align:top;"|Sends acknowledgement message to sending XIS
 
 
|}
 
|}
−
==Invocations==
+
==Invocation==
 
The Send Aanmeldbericht transaction is an HTTP POST method on the target XIS's base:
 
The Send Aanmeldbericht transaction is an HTTP POST method on the target XIS's base:
 
  POST [base] {?_format=[mime-type]}
 
  POST [base] {?_format=[mime-type]}
−
where the body of the POST request is the assembled Bundle.
+
where the body of the POST request is a FHIR document (see [[#Structure of the Aanmeldbericht (4 HCIMs + PDF)]]).
 
===Trigger events===
 
===Trigger events===
−
This transaction is invoked when the patiënt is ready for transfer, and the sending XIS wants to confirm a recieving XIS.
+
This transaction is invoked when the sending XIS needs to send the Overdrachtsbericht to the receiving XIS.
−
===Server response===
+
===Expected response===
 +
The document Bundle should be processed as a [http://hl7.org/fhir/STU3/http.html#transaction transaction] by the receiving XIS and each <code>Bundle.entry</code> should be treated as a <code>create</code> interaction for the <code>Bundle.entry.resource</code>. When the receiving XIS cannot create a new resource because of incorrect data or business rules, it should perform a rollback of the creation of any previous entries.
  
−
==Structure of the Aanmeldbericht phase 1==
+
On success, the target XIS SHALL respond:
−
Both the Aanmeldbericht as the eOverdrachtbericht are sent as a [https://www.hl7.org/fhir/STU3/documents.html FHIR Document]. To create this document, a FHIR Composition resource should be created according to the relevant [https://simplifier.net/NictizSTU3-Zib2017/~resources?text=eoverdracht&category=Profile&corebasetype=Composition Composition] profiles.  
+
* 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. The sender may use the returned Bundle to track the outcomes of processing the entry, and the identities assigned to the resources by the server.
  
−
The Aanmeldbericht consists of multiple FHIR resources, which are assembled into a FHIR [http://hl7.org/fhir/STU3/bundle.html Bundle]. The table below lists the FHIR StructureDefinitions that are applicable for the pilot implementation of the 'Aanmeldbericht' transactions.
+
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, the status code should be 400 Bad Request.
 +
** When the server rejects the content of the resource because of business rules, the status code should be 422 Unprocessable Entity.
 +
** Additional HTTP status code may be used if more appropriate.
 +
* With a response body set to a FHIR [http://hl7.org/fhir/STU3/operationoutcome.html OperationOutcome] resource with detailed error messages describing the reason for the error.
 +
==Structure of the Aanmeldbericht (4 HCIMs + PDF)==
 +
The Aanmeldbericht consists of multiple FHIR resources, which are assembled into a FHIR [https://www.hl7.org/fhir/STU3/documents.html FHIR Document]. To create this document, a FHIR Composition resource should be created that references the relevant resources. The Composition resource is then bundled together with all referenced resources in a Bundle of type "document". The Composition resource SHOULD be the first entry. During phase 1, the Overdrachtsbericht is based on the same 4 HCIMs as the Aanmeldbericht (Patient, Betaler, Contactpersoon en Zorgaanbieder).  
 +
 
 +
The table below lists the FHIR profiles<ref name="nopackage"/> that are applicable for the pilot implementation of the Overdrachtsbericht transaction. All resources SHALL conform to the profiles listed in this table and SHALL include the profile canonical URL in the <code>meta.profile</code> element.
  
 
{| class="wikitable" style="horizontal-align: right"
 
{| class="wikitable" style="horizontal-align: right"
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:400px" | Section
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | Section
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:400px" | FHIR profile
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | FHIR profile
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:50px" | FHIR resource
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | FHIR resource
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:50px" | HCIM name
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | HCIM name
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:50px" | HCIM version
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | HCIM version
−
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left; background-color: #E3E3E3 width:50px" | Remarks
+
!style="background-color: #4AB8A7; color: white; font-weight: bold; text-align:left;" | Remarks
 
|-
 
|-
 
| -
 
| -
−
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/eOverdracht-aanmeldbericht-phase-one|eOverdracht aanmeldbericht phase one}}
+
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/eOverdracht-aanmeldbericht-phase-one|Aanmeldbericht phase 1}}
 
| Composition
 
| Composition
 
| -
 
| -
 
| -
 
| -
−
| Declaration of the Send Aanmeldbericht transaction.
+
| The Composition resource used to assemble the document
 +
|-
 
|-
 
|-
 
| Datum overplaatsing
 
| Datum overplaatsing
 
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/eOverdracht-TransferDate|eOverdracht-TransferDate}}
 
| {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/eOverdracht-TransferDate|eOverdracht-TransferDate}}
 +
| ''extension''
 
| -
 
| -
 
| -
 
| -
−
| -
+
| extension in the Composition resource
−
| DateTime extension used in eOverdracht composition profiles
 
 
|-
 
|-
 
| rowspan="2"|Persoonsgegevens
 
| rowspan="2"|Persoonsgegevens
Regel 202: Regel 217:
 
| -
 
| -
 
|-
 
|-
−
| Sturende organisatie
+
| rowspan="3"|Sturende organisatie
 
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nl-core-organization}}
 
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nl-core-organization}}
−
| rowspan="2"|Organization
+
| Organization
−
| rowspan="2"|Zorgaanbieder
+
| Zorgaanbieder
−
| rowspan="2"|v3.1.1(2017NL)
+
| v3.1.1(2017NL)
−
| rowspan="2"|-
+
| -
 
|-
 
|-
 
| Ontvangende organisatie
 
| Ontvangende organisatie
 
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nl-core-organization}}
 
| {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nl-core-organization}}
 +
| Organization
 +
| Zorgaanbieder
 +
| v3.1.1(2017NL)
 +
| -
 
|-
 
|-
 
| PDF
 
| PDF
Regel 217: Regel 236:
 
| -
 
| -
 
| -
 
| -
−
| Should be used to send unstructured PDF data.
+
| Used to send unstructured PDF data
 
|}
 
|}
−
 
 
=FHIR CapabilityStatements=
 
=FHIR CapabilityStatements=
 
* {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/eOverdracht-servercapabilities-phase-one|CapabilityStatement server}}
 
* {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/eOverdracht-servercapabilities-phase-one|CapabilityStatement server}}
 
* {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/eOverdracht-clientcapabilities-phase-one|CapabilityStatement server}}
 
* {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/eOverdracht-clientcapabilities-phase-one|CapabilityStatement server}}
−
=FHIR Examples=
 
−
Example instances can be found on Simplifier:
 
−
* [https://simplifier.net/nictiz-stu3-eoverdracht/~resources?category=Example&exampletype=Composition Composition examples]
 
−
* [https://simplifier.net/nictiz-stu3-eoverdracht/~resources?category=Example&exampletype=Bundle Bundle examples]
 

Versie van 8 apr 2020 09:55

Introduction

This page details the HL7 FHIR requirements for exchanging the data in the eOverdracht Proeftuin pilot described in the functional design.

This FHIR implementation guide assumes the sending XIS is able to make a connection with the receiving XIS. It does not provide information on finding the right XIS nor does it provide information about security.

Em.png

Basic knowledge of FHIR(STU3) is assumed.

TODO 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 exist 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. 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. /TODO

Package and dependencies

eOverdracht uses the FHIR Packaging mechanism to conveniently bundle all examples, profiles and other conformance resources you need into a single download. The eOverdracht package has a dependency on the Nictiz Zib2017 package .

Examples

Example instances of the FHIR messages can be found on Simplifier:

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 Overdrachtsbericht Volwassenen. For the pilot a limited subset is implemented.

Actors

Transaction group Transaction Actor Role
Send Overdrachtbericht (PUSH) Send Overdrachtsbericht Healthcare professional at organization A (using a XIS) Sends Overdrachtsbericht
Healthcare professional at organization B (using a XIS) Receives Overdrachtsbericht

Invocation

The Send Overdrachtsbericht 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 a FHIR document (see #Structure of the Overdrachtsbericht (4 HCIMs + PDF)).

Trigger events

This transaction is invoked when the sending XIS needs to send the Overdrachtsbericht 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 receiving XIS cannot create a new resource because of incorrect data or business rules, it should perform a rollback of the creation of any previous entries.

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. The sender may use the returned Bundle to track the outcomes of processing the entry, and the identities assigned to the resources by the server.

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, the status code should be 400 Bad Request.
    • When the server rejects the content of the resource because of business rules, the status code should be 422 Unprocessable Entity.
    • 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 Overdrachtsbericht (4 HCIMs + PDF)

The Overdrachtsbericht consists of multiple FHIR resources, which are assembled into a FHIR FHIR Document. To create this document, a FHIR Composition resource should be created that references the relevant resources. The Composition resource is then bundled together with all referenced resources in a Bundle of type "document". The Composition resource SHOULD be the first entry. During phase 1, the Overdrachtsbericht is based on the same 4 HCIMs as the Aanmeldbericht (Patient, Betaler, Contactpersoon en Zorgaanbieder).

The table below lists the FHIR profiles[1] that are applicable for the pilot implementation of the Overdrachtsbericht transaction. All resources SHALL conform to the profiles listed in this table and SHALL include the profile canonical URL in the meta.profile element.

Section FHIR profile FHIR resource HCIM name HCIM version Remarks
- phase 1@ http://nictiz.nl/fhir/StructureDefinition/eOverdracht-Overdrachtsbericht-volwassenen-phase-one Composition - - The Composition resource used to assemble the document
Datum overplaatsing http://nictiz.nl/fhir/StructureDefinition/eOverdracht-TransferDate extension - - extension in the Composition resource
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) -
http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner Practitioner Zorgverlener v3.2(2017NL) -
http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole PractitionerRole
Ontvangende organisatie http://fhir.nl/fhir/StructureDefinition/nl-core-organization Organization Zorgaanbieder v3.1.1(2017NL) -
http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner Practitioner Zorgverlener v3.2(2017NL) -
http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole PractitionerRole
PDF Binary Binary - - Used to send unstructured PDF data

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 Aanmeldbericht. For the pilot a limited subset is implemented.

Actors

Transaction group Transaction Actor Role
Send Aanmeldbericht(PUSH) Send Aanmeldbericht Healthcare professional at organization A (using a XIS) Sends Aanmeldbericht
Healthcare professional at organization B (using a XIS) Receives Aanmeldbericht

Invocation

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 a FHIR document (see #Structure of the Aanmeldbericht (4 HCIMs + PDF)).

Trigger events

This transaction is invoked when the sending XIS needs to send the Overdrachtsbericht 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 receiving XIS cannot create a new resource because of incorrect data or business rules, it should perform a rollback of the creation of any previous entries.

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. The sender may use the returned Bundle to track the outcomes of processing the entry, and the identities assigned to the resources by the server.

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, the status code should be 400 Bad Request.
    • When the server rejects the content of the resource because of business rules, the status code should be 422 Unprocessable Entity.
    • 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 Aanmeldbericht (4 HCIMs + PDF)

The Aanmeldbericht consists of multiple FHIR resources, which are assembled into a FHIR FHIR Document. To create this document, a FHIR Composition resource should be created that references the relevant resources. The Composition resource is then bundled together with all referenced resources in a Bundle of type "document". The Composition resource SHOULD be the first entry. During phase 1, the Overdrachtsbericht is based on the same 4 HCIMs as the Aanmeldbericht (Patient, Betaler, Contactpersoon en Zorgaanbieder).

The table below lists the FHIR profiles[1] that are applicable for the pilot implementation of the Overdrachtsbericht transaction. All resources SHALL conform to the profiles listed in this table and SHALL include the profile canonical URL in the meta.profile element.

Section FHIR profile FHIR resource HCIM name HCIM version Remarks
- phase 1@ http://nictiz.nl/fhir/StructureDefinition/eOverdracht-aanmeldbericht-phase-one Composition - - The Composition resource used to assemble the document
Datum overplaatsing http://nictiz.nl/fhir/StructureDefinition/eOverdracht-TransferDate extension - - extension in the Composition resource
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 Organization Zorgaanbieder v3.1.1(2017NL) -
PDF Binary Binary - - Used to send unstructured PDF data

FHIR CapabilityStatements

  1. ↑ 1,0 1,1 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.
Overgenomen van "https://informatiestandaarden.test-nictiz.nl/index.php?title=vpk:Vdraft_FHIR_eOverdracht_Proeftuin&oldid=25750"