Brontekst bekijken van vpk:V3.1 FHIR eOverdracht Proeftuin

{{#customtitle:FHIR Implementation guide Proeftuinen eOverdracht v3.1 (InZicht)}}

=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]].

Implementation of these transactions is spread over multiple phases. Phase one consists of the implementation of four HCIMs for both the Aanmeldbericht and the Overdrachtsbericht. The remaining information from eOverdracht may be sent unstructured in a PDF file.

=Use case: Aanmeldbericht=

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

==Actors and transactions==

{| class="wikitable" style="horizontal-align: right"
! Actor
! Role
! Transaction
! CapabilityStatement
|-
| Sending XIS
| Sends signup message to the receiving XIS 
| Send Aanmeldbericht
|
|-
| Receiving XIS
| Acknowledges the signup message with sending XIS
| Aanmeldbericht response
| 
|-
|}

==Structure of the Aanmeldbericht phase 1==

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.

{| 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;  background-color: #E3E3E3 width:400px" | 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;  background-color: #E3E3E3 width:50px" | 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;  background-color: #E3E3E3 width:50px" | Remarks
|-
| 
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eOverdrachtAanmeldbericht eOverdrachtAanmeldbericht]
| Composition
| -
| -
| Declaration of the Send Aanmeldbericht transaction.
|-
|-
| Datum overplaatsing
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eOverdracht-TransferDate eOverdracht-TransferDate]
| Extension
| -
| -
| DateTime extension used in eOverdracht composition profiles
|-
| rowspan="3"|Persoonsgegevens
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-patient nl-core-patient]
| Patient
| Patient
| v3.1(2017NL)
| -
|-
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Payer zib-Payer]
| Coverage
| Betaler
| v3.1(2017NL)
| -
|-
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson zib-ContactPerson]
| RelatedPerson
| Contactpersoon
| v3.1(2017NL)
| -
|-
| Sturende organisatie
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-organization nl-core-organization]
| Organization
| Zorgaanbieder
| v3.1.1(2017NL)
| -
|-
| Ontvangende organisatie
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-organization nl-core-organization]
| Organization
| Zorgaanbieder
| v3.1.1(2017NL)
| -
|-
| PDF
| [https://www.hl7.org/fhir/binary.html Binary]
| Binary
| -
| -
| Should be used to send unstructured PDF data.
|}

==Structure of the Aanmeldbericht phase 2 (complete)==

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.

{| 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;  background-color: #E3E3E3 width:400px" | 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;  background-color: #E3E3E3 width:50px" | 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;  background-color: #E3E3E3 width:50px" | Remarks
|-
| 
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eOverdrachtAanmeldbericht eOverdrachtAanmeldbericht]
| Composition
| -
| -
| Declaration of the Send Aanmeldbericht transaction.
|-
|-
| Datum overplaatsing
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eOverdracht-TransferDate eOverdracht-TransferDate]
| Extension
| -
| -
| DateTime extension used in eOverdracht composition profiles
|-
| rowspan="3"|Persoonsgegevens
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-patient nl-core-patient]
| Patient
| Patient
| v3.1(2017NL)
| -
|-
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Payer zib-Payer]
| Coverage
| Betaler
| v3.1(2017NL)
| -
|-
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson zib-ContactPerson]
| RelatedPerson
| Contactpersoon
| v3.1(2017NL)
| -
|-
| Sturende organisatie
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-organization nl-core-organization]
| Organization
| Zorgaanbieder
| v3.1.1(2017NL)
| -
|-
| Ontvangende organisatie
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-organization nl-core-organization]
| Organization
| Zorgaanbieder
| v3.1.1(2017NL)
| -
|-
| Medische diagnose
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Problem zib-Problem]
| Condition
| Probleem
| v4.1(2017NL
| -
|-
|-
| Voorgeschiedenis
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Problem zib-Problem]
| Condition
| Probleem
| v4.1(2017NL
| -
|-
| Let op
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Alert zib-Alert]
| Flag
| Alert
| v3.2(2017NL)
| -
|-
| Vrijheidsbeperking
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-FreedomRestrictingMeasures zib-FreedomRestrictingMeasures]
| Procedure
| VrijheidsBeperkendeMaatregelen
| v3.1(2017NL)
| -
|-
| Actuele patiëntenproblemen
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Problem zib-Problem]
| Condition
| Probleem
| v4.1(2017NL)
| -
|-
| Afspraken patiënt
| [https://simplifier.net/resolve?target=simplifier&canonical=hhttp://nictiz.nl/fhir/StructureDefinition/zib-ProcedureRequest zib-ProcedureRequest]
| ProcedureRequest
| OverdrachtGeplandeZorgActiviteit
| v3.1(2017NL)
| -
|-
| Wensen en behoeften patiënt en/of naasten
| -
| -
| -
| -
| Declared as a text section. See [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eOverdrachtAanmeldbericht composition] profile.
|-
| rowspan="2"| Voeding/vocht
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-FeedingTubeSystem zib-FeedingTubeSystem]
| DeviceUseStatement
| SondeSysteem
| v3.2(2017NL)
| -
|-
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Infusion zib-Infusion]
| DeviceUseStatement
| Infuus
| v3.2(2017NL)
| -
|- 
| Uitscheiding
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Stoma zib-Stoma]
| Observation
| Stoma
| v3.2(2017NL)
| -
|}

==Invocations==
===Send Aanmeldbericht (PUSH)===
====Trigger events====
This transaction is invoked when the XIS needs to send the Aanmeldbericht to the receiving XIS.

====Message Semantics====
The Aanmeldbericht is 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 [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eOverdrachtAanmeldbericht-phase-one eOverdrachtAanmeldbericht-phase-one profile]. This Composition resource references each of the relevant resources included in the Aanmeldbericht. The Composition resource and the relevant resources are subsequently assembed into a FHIR [http://hl7.org/fhir/STU3/bundle.html Bundle] resource which ''Bundle.type'' set to ''document''. The Composition resource should be the first entry in the Bundle.

For the Bundle, the following rules apply:
* The Bundle resource SHALL include all the resources listed as described in [[#Structure_of_the_Aanmeldbericht|Structure of the Aanmeldbericht]], each in a ''separate Bundle.entry''.
* The resources in the message SHALL be a valid instances of these profiles listed in [[#Structure_of_the_Aanmeldbericht|Structure of the Aanmeldbericht]]
* All resources SHALL include their related profile canonical URL in the ''meta.profile'' element in order to show compliance.
* The Bundle SHOULD include the resources that are linked from the included resources

{{NoteBox|A FHIR Document is an immutable statement which can't be updated once it's created, it can only be superseded by a new Document. Updating falls outside the scope of the current design.}}

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.

====Expected actions====
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''.

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 (see below).

===Aanmeldbericht response (PUSH)===
====Trigger events====
The target XIS completed processing of the Send Aanmeldbericht transaction.

====Message semantics====
The target XIS responds to the Send Aanmeldbericht transaction with an HTTP Response, where:
* The status code SHALL be 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.
* On success, the response body SHALL be set to a FHIR Bundle resource containing one entry for each entry in the request, in the same order, with the outcome of processing the entry.
* On failure, the response body SHOULD be set to a FHIR [http://hl7.org/fhir/STU3/operationoutcome.html OperationOutcome] resource with detailed error messages describing the reason for the error, and perform a rollback of the creation of any previous entries.

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.

==Examples==
* [https://simplifier.net/nictizstu3-zib2017/eOverdracht-Aanmeldbericht-phase-one-example Aanmeldbericht phase one Composition]
* [https://simplifier.net/nictizstu3-zib2017/eOverdracht-Aanmeldbericht-phase-one-Bundle-example Aanmeldbericht phase one Bundle]
* [https://simplifier.net/NictizSTU3-Zib2017/eOverdracht-Aanmeldbericht-Composition Aanmeldbericht Composition]
* [https://simplifier.net/nictizstu3-zib2017/eoverdracht-aanmeldbericht-bundle Aanmeldbericht Bundle]

=Use case: Overdrachtsbericht=
==Introduction==
During the pilot, the transfer information is based on a subset of the [[vpk:V3.1_Ontwerp_eOverdracht#Use_Case_1A_-_Verpleegkundige_overdracht:_Overdrachtsbericht_-_volwassenen_.28PUSH.29|Overdrachtsbericht Volwassenen]] (transfer message for adults). Phase one consists of the implementation of four HCIMs. The remaining information from eOverdracht may be sent unstructured in a PDF file.

==Actors and transactions==

{| class="wikitable" style="horizontal-align: right"
! Actor
! Role
! Transaction
|-
| Sending XIS
| Sends transfer message to the receiving XIS 
| Send Overdrachtsbericht
|-
| Receiving XIS
| Acknowledges transfer message to sending XIS
| Overdrachtsbericht response
|-
|}

==Structure of the Overdrachtsbericht phase 1: 4 HCIMs + PDF==

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"
!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;  background-color: #E3E3E3 width:400px" | 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;  background-color: #E3E3E3 width:50px" | 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;  background-color: #E3E3E3 width:50px" | Remarks
|-
| 
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eOverdracht-Overdrachtsbericht-volwassenen-phase-one eOverdracht-Overdrachtsbericht-volwassenen-phase-one]
| Composition
| -
| -
| Declaration of the Send Overdrachtsbericht volwassenen phase one transaction.
|-
|-
| Datum overplaatsing
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eOverdracht-TransferDate eOverdracht-TransferDate]
| Extension
| -
| -
| DateTime extension used in eOverdracht composition profiles
|-
| rowspan="3"|Persoonsgegevens
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-patient nl-core-patient]
| Patient
| Patient
| v3.1(2017NL)
| -
|-
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Payer zib-Payer]
| Coverage
| Betaler
| v3.1(2017NL)
| -
|-
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson zib-ContactPerson]
| RelatedPerson
| Contactpersoon
| v3.1(2017NL)
| -
|-
| Sturende organisatie
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-organization nl-core-organization]
| Organization
| Zorgaanbieder
| v3.1.1(2017NL)
| -
|-
| Ontvangende organisatie
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-organization nl-core-organization]
| Organization
| Zorgaanbieder
| v3.1.1(2017NL)
| -
|-
| PDF
| [https://www.hl7.org/fhir/binary.html Binary]
| Binary
| -
| -
| Should be used to send unstructured PDF data.
|}

==Structure of the Overdrachtsbericht phase 2: 15 HCIMs + PDF==

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 2, the Overdrachtsbericht is based on the same 15 HCIMs as the aanmeldbericht. The remaining information is made available via an unstructured PDF.

{| 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;  background-color: #E3E3E3 width:400px" | 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;  background-color: #E3E3E3 width:50px" | 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;  background-color: #E3E3E3 width:50px" | Remarks
|-
| 
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eOverdrachtOverdrachtsbericht-volwassenen-phase-two eOverdrachtOverdrachtsbericht-volwassenen-phase-two]
| Composition
| -
| -
| Declaration of the Send Overdrachtsbericht volwassenen phase two transaction.
|-
|-
| Datum overplaatsing
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eOverdracht-TransferDate eOverdracht-TransferDate]
| Extension
| -
| -
| DateTime extension used in eOverdracht composition profiles
|-
| rowspan="3"|Persoonsgegevens
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-patient nl-core-patient]
| Patient
| Patient
| v3.1(2017NL)
| -
|-
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Payer zib-Payer]
| Coverage
| Betaler
| v3.1(2017NL)
| -
|-
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson zib-ContactPerson]
| RelatedPerson
| Contactpersoon
| v3.1(2017NL)
| -
|-
| Sturende organisatie
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-organization nl-core-organization]
| Organization
| Zorgaanbieder
| v3.1.1(2017NL)
| -
|-
| Ontvangende organisatie
| [https://simplifier.net/resolve?target=simplifier&canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-organization nl-core-organization]
| Organization
| Zorgaanbieder
| v3.1.1(2017NL)
| -
|-
| Medische diagnose
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Problem zib-Problem]
| Condition
| Probleem
| v4.1(2017NL
| -
|-
|-
| Voorgeschiedenis
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Problem zib-Problem]
| Condition
| Probleem
| v4.1(2017NL
| -
|-
| Let op
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Alert zib-Alert]
| Flag
| Alert
| v3.2(2017NL)
| -
|-
| Vrijheidsbeperking
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-FreedomRestrictingMeasures zib-FreedomRestrictingMeasures]
| Procedure
| VrijheidsBeperkendeMaatregelen
| v3.1(2017NL)
| -
|-
| Actuele patiëntenproblemen
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Problem zib-Problem]
| Condition
| Probleem
| v4.1(2017NL)
| -
|-
| Afspraken patiënt
| [https://simplifier.net/resolve?target=simplifier&canonical=hhttp://nictiz.nl/fhir/StructureDefinition/zib-ProcedureRequest zib-ProcedureRequest]
| ProcedureRequest
| OverdrachtGeplandeZorgActiviteit
| v3.1(2017NL)
| -
|-
| Wensen en behoeften patiënt en/of naasten
| -
| -
| -
| -
| Declared as a text section. See [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eOverdrachtOverdrachtsbericht-volwassenen-phase-two composition] profile.
|-
| rowspan="2"| Voeding/vocht
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-FeedingTubeSystem zib-FeedingTubeSystem]
| DeviceUseStatement
| SondeSysteem
| v3.2(2017NL)
| -
|-
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Infusion zib-Infusion]
| DeviceUseStatement
| Infuus
| v3.2(2017NL)
| -
|- 
| Uitscheiding
| [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-Stoma zib-Stoma]
| Observation
| Stoma
| v3.2(2017NL)
| -
|-
| PDF
| [https://www.hl7.org/fhir/binary.html Binary]
| Binary
| -
| -
| Should be used to send unstructured PDF data.
|}

==FHIR CapabilityStatements==
===Phase one===
* Link to Server CapabilityStatement 
* Link to Client CapabilityStatement

===Phase two===
* Link to Server CapabilityStatement 
* Link to Client CapabilityStatement

==Invocations==

===Send Aanmeldbericht (PUSH)===
====Trigger events====
This transaction is invoked when the XIS needs to send the Overdrachtbericht to the receiving XIS.

====Message Semantics====
The Overdrachtsbericht is 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 [https://simplifier.net/resolve?target=simplifier&canonical=http://nictiz.nl/fhir/StructureDefinition/eOverdracht-OverdrachtsberichtVolwassenen-phase-one eOverdracht-OverdrachtsberichtVolwassenen-phase-one profile]. This Composition resource references each of the resources included in the Overdrachtsbericht. The Composition resource and the relevant resources are subsequently assembed into a FHIR [http://hl7.org/fhir/STU3/bundle.html Bundle] resource which ''Bundle.type'' set to ''document''. The Composition resource should be the first entry in the Bundle.

For the Bundle, the following rules apply:
* The Bundle resource SHALL include all the resources listed in [[#Structure_of_the_Overdrachtbericht_phase_1:_4_HCIMs_.2B_PDF|Structure of the Overdrachtsbericht phase 1]] or [[#Structure_of_the_Overdrachtbericht_phase_2:_15_HCIMs_.2B_PDF|Structure of the Overdrachtsbericht phase 2]], each in a ''separate Bundle.entry''.
* The resources in the message SHALL be a valid instances of these profiles listed in [[#Structure_of_the_Overdrachtbericht_phase_1:_4_HCIMs_.2B_PDF|Structure of the Overdrachtsbericht phase 1]] or [[#Structure_of_the_Overdrachtbericht_phase_2:_15_HCIMs_.2B_PDF|Structure of the Overdrachtsbericht phase 2]].
* All resources SHALL include their related profile canonical URL in the ''meta.profile'' element in order to show compliance.
* The Bundle SHOULD include the resources that are linked from the included resources

{{NoteBox|A FHIR Document is an immutable statement which can't be updated once it's created, it can only be superseded by a new Document. Updating falls outside the scope of the current design.}}

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.

====Expected actions====
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''. 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.

===Aanmeldbericht response (PUSH)===
====Trigger events====
The target XIS completed processing of the Send Overdrachtsbericht transaction.

====Message semantics====
The target XIS responds to the Send Overdrachtsbericht transaction with an HTTP Response, where:
* The status code SHALL be 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. 
* On success, the response body SHALL be set to a FHIR Bundle resource containing one entry for each entry in the request, in the same order, with the outcome of processing the entry.
* On failure, the response body SHOULD be set to a FHIR OperationOutcome resource with detailed error messages describing the reason for the error, and perform a rollback of the creation of any previous entries.

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.

==Examples==
* [https://simplifier.net/nictizstu3-zib2017/eOverdracht-OverdrachtsberichtVolwassenen-phase-one-example-1 Overdrachtsbericht Composition phase 1]
* [https://simplifier.net/nictizstu3-zib2017/eOverdracht-OverdrachtsberichtVolwassenen-phase-one-example-bundle Overdrachtsbericht Bundle phase 1]