vpk:Vdraft FHIR eOverdracht

{{#customtitle:FHIR Implementation Guide eOverdracht v3.1|FHIR Implementation Guide eOverdracht v3.1}}

Introduction

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

Use case: Send eOverdracht Aanmeldbericht

Introduction

The send eOverdracht Aanmeldbericht transaction is used by the sending XIS to send the relevant data to the receiving XIS. In addition to the functional design, the structure of this transaction is described in Opbouw eOverdracht aanmelding.

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

Sending XIS: request message

The send eOverdracht Aanmeldbericht message uses the HTTP POST method on the target XIS's base.

Trigger Events

This message is invoked when the XIS needs to send an eOverdracht Aanmeldbericht to the receiving XIS.

Message Semantics

Because the data needed in the Aanmeldbericht will most likely consist of multiple FHIR resources, a document Bundle is used. This allows for bundling and sending a set of resources in a single interaction.

The interaction is performed by an HTTP POST command as shown:

POST [base] {?_format=[mime-type]}

The body of the post submission is a Bundle with Bundle.type = document. The first entry contains a Composition resource, and each subsequent entry contains a resource that is referenced from the Composition resource. By sending it to the target's base, the document Bundle will be processed as a transaction and each Bundle.entry will be treated as a create interaction for the entry.resource.

Read more:

• documents
• transaction
• create

The Composition resource in the Bundle SHALL conform to the eOverdracht Aanmeldbericht profile listed below. The table also lists profiles that represent ZIBs that can be used for the data exchange of the referenced resources.

The resources in the message SHALL be a valid instance of these profiles. All resources SHALL include their related profile canonical URL in the meta.profile element in order to show compliance.

The Bundle resource SHALL contain all resources that are referenced from the Composition resource, each in a separate Bundle.entry.

Examples

Aanmeldbericht

• Aanmeldbericht Composition

Bundle

• Aanmeldbericht Bundle

Expected Actions

On receipt of the submission, the receiving XIS shall validate the resources and respond with an appropriate HTTP code. If the XIS encounters any errors or if validation fails, the XIS shall return an error as documented in the Message Semantics of the response message.

XIS: response message

The target XIS returns an HTTP Status code appropriate to the processing outcome and returns a Bundle, of type transaction-response, that contains one entry for each entry in the request, in the same order, with the outcome of processing the entry.

Trigger Events

The target XIS completed processing of the send eOverdracht Aanmeldbericht message.

Message Semantics

The target XIS SHALL return a Bundle with type set to transaction-response that contains one entry for each entry in the request, in the same order, with the outcome of processing the entry.

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.

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. In either case, the server SHOULD include a response body containing an OperationOutcome with detailed error messages describing the reason for the error, and perform a rollback of the creation of any previous entries.

Common HTTP Status codes returned on FHIR-related errors (in addition to normal HTTP errors related to security, header and content type negotiation issues):

• 400 Bad Request - resource could not be parsed or failed basic FHIR validation rules
• 404 Not Found - resource type not supported, or not a FHIR end-point
• 422 Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail

Read more: create transaction

Expected Actions

The sending XIS processes the results according to application-defined rules.

List of StructureDefinitions

The profiles listed in the table below represent their entire respective HCIM and are applicable in a broader context than the exchange of eOverdracht information.

A package is available that conveniently bundles all examples, profiles and other conformance resources you need into a single download. This version of the information standard depends on Nictiz package 1.1.x 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.

The FHIR Packaging mechanism to support consistent versioning of profiles and related conformance resources such as OperationDefinitions. FHIR Packaging is based on the NPM Packaging mechanism and offers developers a convenient way to include the conformance resources in their favorite IDE. The relevant package version is indicated and linked in the information standards technical design page.

For even more background information:

• What is the problem that packaging could address
• Introducing the Simplifier FHIR Package Server (includes what problem packaging addresses)
• Firely Torinox introduction (this is one of the tools that's useful for working with FHIR packages)
• The HL7 wiki that outlines the base specification

Zib naam	Zib versie	FHIR Resource	FHIR Profile
-	-	Composition	http://nictiz.nl/fhir/StructureDefinition/eOverdrachtAanmeldbericht
Patiënt	v3.1(2017NL)	Patient	http://fhir.nl/fhir/StructureDefinition/nl-core-patient
Betaler	v3.1(2017NL)	Coverage	http://nictiz.nl/fhir/StructureDefinition/zib-Payer
Zorgaanbieder	v3.1.1(2017NL)	Organization	http://fhir.nl/fhir/StructureDefinition/nl-core-organization
Zorgverlener	v3.2(2017NL)	Practitioner	http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner
		PractitionerRole	http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole
Probleem	v4.1(2017NL)	Condition	http://nictiz.nl/fhir/StructureDefinition/zib-Problem
Alert	v3.2(2017NL)	Flag	http://nictiz.nl/fhir/StructureDefinition/zib-Alert
VrijheidsbeperkendeMaatregelen	v3.1(2017NL)	Procedure	http://nictiz.nl/fhir/StructureDefinition/zib-FreedomRestrictingMeasures
GeplandeZorgActiviteit	v3.1(2017NL)	ProcedureRequest	http://nictiz.nl/fhir/StructureDefinition/zib-ProcedureRequest
SondeSysteem	v3.2(2017NL)	DeviceUseStatement	http://nictiz.nl/fhir/StructureDefinition/zib-FeedingTubeSystem
Infuus	v3.2(2017NL)	DeviceUseStatement	http://nictiz.nl/fhir/StructureDefinition/zib-Infusion
Stoma	v3.2(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-Stoma

List of StructureDefinitions - eOverdracht pilot

The table below lists the StructureDefinitions that are applicable for the pilot implementation of the transaction 'Aanmeldbericht'. Implementation of the transaction 'Aanmeldbericht' is spread over multiple phases. Phase one consists of the implementation of four HCIMs. The remaining information from eOverdracht may be sent unstructured in a PDF file, through the addition of a Composition.section that references a Binary resource, which shall be placed inside the FHIR document Bundle. The profile on Composition, listed in the table below, provides the details.

Zib naam	Zib versie	FHIR Resource	FHIR Profile
-	-	Composition	http://nictiz.nl/fhir/StructureDefinition/eOverdrachtAanmeldbericht-phase-one
Patient	v3.1(2017NL)	Patient	http://fhir.nl/fhir/StructureDefinition/nl-core-patient
Betaler	v3.1(2017NL)	Coverage	http://nictiz.nl/fhir/StructureDefinition/zib-Payer
Zorgaanbieder	v3.1.1(2017NL)	Organization	http://fhir.nl/fhir/StructureDefinition/nl-core-organization
Zorgverlener	v3.2(2017NL)	Practitioner	http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner
		PractitionerRole	http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole

Examples - eOverdracht pilot

Aanmeldbericht

• Aanmeldbericht Composition

Bundle

• Aanmeldbericht Bundle

Interactions, operations, search parameters

Interactions

The following logical interactions are needed for the send eOverdracht Aanmeldbericht transaction:

• create
• batch/transaction

Operations

No operations are defined or needed for this transaction.

Search parameters

No search parameters are defined or needed for this transaction.

Use case: Send eOverdracht Overdrachtsbericht Volwassenen

Introduction

The send eOverdracht Overdrachtsbericht Volwassenen transaction is used by the sending XIS to send the relevant data to the receiving XIS. In addition to the functional design, the structure of this transaction is described in Opbouw eOverdracht Volwassenen.

Actors

Transaction group	Transaction	Actor	Role
Send eOverdracht Overdrachtsbericht Volwassenen(PUSH)	Send Overdrachtsbericht request	Healthcare professional (using a XIS)	Sends Overdrachtsbericht to the receiving XIS
	Send Overdrachtsbericht response	Receiving XIS	Sends acknowledgement message to sending XIS

Invocations

Sending XIS: request message

The send eOverdracht Overdrachtsbericht Volwassenen message uses the HTTP POST method on the target XIS's base.

Trigger Events

This message is invoked when the XIS needs to send an eOverdracht Overdrachtsbericht Volwassenen to the receiving XIS.

Message Semantics

Because the data needed in the eOverdrach Overdrachtsbericht Volwassenen will most likely consist of multiple FHIR resources, a document Bundle is used. This allows for bundling and sending a set of resources in a single interaction.

The interaction is performed by an HTTP POST command as shown:

POST [base] {?_format=[mime-type]}

The body of the post submission is a Bundle with Bundle.type = document. The first entry contains a Composition resource, and each subsequent entry contains a resource that is referenced from the Composition resource. By sending it to the target's base, the document Bundle will be processed as a transaction and each Bundle.entry will be treated as a create interaction for the entry.resource.

Read more:

• documents
• transaction
• create

The Composition resource in the Bundle SHALL conform to the eOverdracht Overdrachtsbericht profile listed below. The table also lists profiles that represent ZIBs that can be used for the data exchange of the referenced resources.

The resources in the message SHALL be a valid instance of these profiles. All resources SHALL include their related profile canonical URL in the meta.profile element in order to show compliance.

The Bundle resource SHALL contain all resources that are referenced from the Composition resource, each in a separate Bundle.entry.

Examples

Overdrachtsbericht

• TODO

Bundle

• TODO

Expected Actions

On receipt of the submission, the receiving XIS shall validate the resources and respond with an appropriate HTTP code. If the XIS encounters any errors or if validation fails, the XIS shall return an error as documented in the Message Semantics of the response message.

XIS: response message

The target XIS returns an HTTP Status code appropriate to the processing outcome and returns a Bundle, of type transaction-response, that contains one entry for each entry in the request, in the same order, with the outcome of processing the entry.

Trigger Events

The target XIS completed processing of the send eOverdracht Overdrachtsbericht Volwassenen message.

Message Semantics

The target XIS SHALL return a Bundle with type set to transaction-response that contains one entry for each entry in the request, in the same order, with the outcome of processing the entry.

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.

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. In either case, the server SHOULD include a response body containing an OperationOutcome with detailed error messages describing the reason for the error, and perform a rollback of the creation of any previous entries.

Common HTTP Status codes returned on FHIR-related errors (in addition to normal HTTP errors related to security, header and content type negotiation issues):

• 400 Bad Request - resource could not be parsed or failed basic FHIR validation rules
• 404 Not Found - resource type not supported, or not a FHIR end-point
• 422 Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail

Read more: create transaction

Expected Actions

The sending XIS processes the results according to application-defined rules.

List of StructureDefinitions

The profiles listed in the table below represent their entire respective HCIM and are applicable in a broader context than the exchange of eOverdracht information.

A package is available that conveniently bundles all examples, profiles and other conformance resources you need into a single download. This version of the information standard depends on Nictiz package 1.1.x 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.

The FHIR Packaging mechanism to support consistent versioning of profiles and related conformance resources such as OperationDefinitions. FHIR Packaging is based on the NPM Packaging mechanism and offers developers a convenient way to include the conformance resources in their favorite IDE. The relevant package version is indicated and linked in the information standards technical design page.

For even more background information:

• What is the problem that packaging could address
• Introducing the Simplifier FHIR Package Server (includes what problem packaging addresses)
• Firely Torinox introduction (this is one of the tools that's useful for working with FHIR packages)
• The HL7 wiki that outlines the base specification

Zib naam	Zib versie	FHIR Resource	FHIR Profile
-	-	Composition	TODO
Patiënt	v3.1(2017NL)	Patient	http://fhir.nl/fhir/StructureDefinition/nl-core-patient
Betaler	v3.1(2017NL)	Coverage	http://nictiz.nl/fhir/StructureDefinition/zib-Payer
Contactpersoon	v3.1(2017NL)	Patient	http://fhir.nl/fhir/StructureDefinition/nl-core-patient
		RelatedPerson	http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson
Zorgaanbieder	v3.1(2017NL)	Organization	http://fhir.nl/fhir/StructureDefinition/nl-core-organization
Zorgverlener	v3.2(2017NL)	Practitioner	http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner
		PractitionerRole	http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole
Gezinssituatie	v3.0(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-FamilySituation
Woonsituatie	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-LivingSituation
Levensovertuiging	v3.1(2017NL)	TODO	TODO
Wilsverklaring	v3.1(2017NL)	Consent	http://nictiz.nl/fhir/StructureDefinition/zib-AdvanceDirective
ParticipatieInMaatschappij	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-ParticipationInSociety
HulpVanAnderen	v3.1(2017NL)	CarePlan	http://nictiz.nl/fhir/StructureDefinition/zib-HelpFromOthers
Taalvaardigheid	v3.1(2017NL)	Patient	http://fhir.nl/fhir/StructureDefinition/nl-core-patient
Probleem	v4.1(2017NL)	Condition	http://nictiz.nl/fhir/StructureDefinition/zib-Problem
AllergieIntolerantie	v3.2(2017NL)	AllergyIntolerance	http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance
Alert	v3.2(2017NL)	Flag	http://nictiz.nl/fhir/StructureDefinition/zib-Alert
VrijheidsbeperkendeMaatregelen	v3.1(2017NL)	Procedure	http://nictiz.nl/fhir/StructureDefinition/zib-FreedomRestrictingMeasures
Bloeddruk	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-BloodPressure
Polsfrequentie	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-PulseRate
Lichaamstemperatuur	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-BodyTemperature
Ademhaling	v3.1(2017NL)	TODO	TODO
Lichaamsgewicht	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-BodyWeight
Lichaamslengte	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-BodyHeight
AlgemeneMeting	v3.0(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-GeneralMeasurement
Pijnscore	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-PainScore (draft)
Behandeldoel	v3.1(2017NL)	Goal	http://nictiz.nl/fhir/StructureDefinition/zib-TreatmentObjective (draft)
VerpleegkundigeInterventie	v3.1(2017NL)	Procedure	http://nictiz.nl/fhir/StructureDefinition/zib-NursingIntervention
UitkomstVanZorg	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-OutcomeOfCare (draft)
OverdrachtGeplandeZorgActiviteit	v3.1(2017NL)	Appointment	http://nictiz.nl/fhir/StructureDefinition/eAfspraak-Appointment
		ImmunizationRecommendation	http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation
		ProcedureRequest	http://nictiz.nl/fhir/StructureDefinition/zib-ProcedureRequest
VermogenTotDrinken	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-AbilityToDrink (draft)
VermogenTotEten	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-AbilityToEat (draft)
VermogenTotMondverzorging	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-AbilityToPerformMouthcareActivities (draft)
		DeviceUseStatement	http://nictiz.nl/fhir/StructureDefinition/zib-AbilityToPerformMouthcareActivities-MedicalDevice (draft)
		Device	http://nictiz.nl/fhir/StructureDefinition/zib-AbilityToPerformMouthcareActivities-MedicalDeviceProduct (draft)
VermogenTotZichWassen	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-AbilityToWashOneSelf (draft)
VermogenTotZichKleden	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-AbilityToDressOneself (draft)
VermogenTotUiterlijkeVerzorging	v1.0(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-AbilityToGroome (draft)
VermogenTotToiletgang	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-AbilityToUseToilet (draft)
VermogenTotZelfstandigMedicatiegebruik	v1.0(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-AbilityToManageMedication (draft)
Mobiliteit	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-Mobility (draft)
Voedingsadvies	v3.1(2017NL)	NutritionOrder	http://nictiz.nl/fhir/StructureDefinition/zib-NutritionAdvice
SNAQScore	v3.1(2017NL)	TODO	TODO
SNAQrcScore	v3.1(2017NL)	TODO	TODO
SNAQ65+Score	v3.1(2017NL)	TODO	TODO
MUSTScore	v3.1(2017NL)	TODO	TODO
Vochtbalans	v1.0(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-FluidBalance (draft)
SondeSysteem	v3.1(2017NL)	DeviceUseStatement	http://nictiz.nl/fhir/StructureDefinition/zib-FeedingTubeSystem
		Device	http://nictiz.nl/fhir/StructureDefinition/zib-FeedingTubeSystem-Product
Infuus	v3.1(2017NL)	DeviceUseStatement	http://nictiz.nl/fhir/StructureDefinition/zib-Infusion
		Device	http://nictiz.nl/fhir/StructureDefinition/zib-Infusion-Product
Blaasfunctie	v3.1(2017NL)	TODO	TODO
Darmfunctie	v3.1(2017NL)	TODO	TODO
Stoma	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-Stoma
Brandwond	v3.1(2017NL)	TODO	TODO
DecubitusWond	v3.1(2017NL)	TODO	TODO
Huidaandoening	v3.1(2017NL)	TODO	TODO
Wond	v3.1(2017NL)	TODO	TODO
FunctieHoren	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-HearingFunction (draft)
		DeviceUseStatement	http://nictiz.nl/fhir/StructureDefinition/zib-HearingFunction-HearingAid (draft)
		Device	http://nictiz.nl/fhir/StructureDefinition/zib-HearingFunction-HearingAid-Product (draft)
FunctieZien	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-VisualFunction (draft)
		DeviceUseStatement	http://nictiz.nl/fhir/StructureDefinition/zib-VisualFunction-VisualAid (draft)
		Device	http://nictiz.nl/fhir/StructureDefinition/zib-VisualFunction-VisualAid-Product (draft)
ZiekteBeleving	v3.1(2017NL)	TODO	TODO
Zwangerschap	v3.1(2017NL)	TODO	TODO
FunctioneleOfMentaleStatus	v3.1(2017NL)	Observation	http://nictiz.nl/fhir/StructureDefinition/zib-FunctionalOrMentalStatus

Interactions, operations, search parameters

Interactions

TODO

Operations

TODO

Search parameters

TODO