TA Notified Pull - Exchange and Transfer
Status: Draft, outline only · Version: 0.1
Introduction
This document describes how healthcare organizations in the Netherlands exchange patient data using the clinical workflow pattern to support transfer or referral of patients.
The clinical workflow pattern is based on the notified pull pattern, and the term notified pull is commonly used for agreements on patient transfer and referral. The notified pull pattern can also be used without the clinical workflow pattern. This TA covers only use cases that use the clinical workflow pattern, and is therefore not a general TA for notified pull. Implementation guides for use cases without it can be based on TA Notifications.
An implementation guide needs to cover identification, authentication an authorization. These will be specified in the TA I&A&A, which is not available yet. This version of the TA therefore lacks a section covering these topics. They will be added once TA I&A&A is available.
Conventions. The conformance verbs SHALL, SHALL NOT, SHOULD, SHOULD NOT and MAY in this document are to be interpreted as defined in FHIR R4 (Conformance Rules, Conformance Language), when, and only when, they appear in capitals. Open points are marked as follows, with an identifier:
OPEN [identifier]: description of the open point.
Context
Dutch healthcare organizations already exchange patient data between systems for referrals, orders and transfers. They do so with separately developed agreements. The Technical Agreement Exchanging FHIR Data using a generic Notified Pull mechanism (TA NP) specifies the exchange of the BgZ in a referral. The eOverdracht supplier specification specifies the nursing handover. Each defines its own notification, its own way of tracking the status of the work, and its own way of authorizing the exchange.
Two national agreements for closely related problems cannot both remain the reference for new implementers. A system built for one cannot exchange with a system built for the other, and a vendor that supports both has to maintain two implementations of what is, underneath, the same mechanism. The two exchanges can also belong to one transfer, for instance when an admitted patient moves between hospitals and the medical and the nursing handover run together. Harmonizing the two agreements is therefore required. This document is intended to serve as this harmonized implementation guide.
Scope
In scope
-
The concepts of notifications, of clinical workflow, and of identification, authentication and authorization, and how they are used together for notified pull.
-
Notified pull in the three requests: creating the Subscription, sending the notification and pulling the data, each with its authentication and authorization.
-
Clinical workflow as a TA on top of notified pull.
Out of Scope
-
The detailed specification of the notification, of the clinical workflow, of identification, authentication and authorization, and of the retrieval. These are in TA Notifications, TA Workflow, TA I&A&A and TA Pull.
-
The content of the standard datasets that are exchanged. The information standard that owns a standard dataset defines it.
-
Registering and finding the endpoints of organizations and services, which GF Addressing governs.
-
The clinical content of an exchange, and how the receiving organization uses the data after retrieval.
-
An implementation guide for use cases that do not make use of TA Workflow. These use cases can be based on TA Notifications alone.
Vocabulary
Terms that the vocabularies of TA Notifications and TA Workflow define, such as Subscription, Notification, SubscriptionTopic, Placer, Fulfiller, Request, Coordination Task and standard dataset, are used as defined there. This vocabulary defines the other terms of this document.
|
Term |
Definition |
|
Sender/Placer |
The party that holds the data and sends the notification. The TA Notifications uses the term sender, the TA Workflow placer. We will be using placer |
|
Receiver/Fulfiller |
The party that needs the data and retrieves it after the notification. The TA Notifications uses the term receiver, the TA Workflow fulfiller. We will be using fulfiller |
|
Clinical workflow |
The exchange of the status of a referral, order or transfer between the placer and the fulfiller, until the work is done |
|
Generic agreement |
An agreement that specifies one aspect of an exchange independent of a use case, such as TA Notifications, also called a building block. |
|
Use case |
One specific exchange of data, for which an implementation guide states how the generic agreements are used |
|
Notified pull |
The exchange pattern in which a sender notifies a receiver that data is available, after which the receiver retrieves the data. It consists of three requests: creating the Subscription, sending the notification and pulling the data |
|
TA NP |
The Technical Agreement Exchanging FHIR Data using a generic Notified Pull mechanism, the existing agreement for the referral with the BgZ |
|
eOverdracht |
The existing supplier specification (leveranciersspecificatie) of the Nuts initiative for the nursing handover |
|
BgZ |
Basisgegevensset Zorg, the Dutch basic dataset for care that is sent with a referral |
|
EPS |
European Patient Summary, a dataset that a referral can also carry |
|
Referral |
The sending of a patient to another organization for further care |
|
Transfer |
The moving of a patient from one organization to another, including the medical and the nursing handover |
|
BSN |
Burgerservicenummer, the Dutch citizen service number, a business identifier of a patient |
|
WGBO |
Wet op de geneeskundige behandelovereenkomst, the Dutch law on medical treatment agreements |
|
SNOMED CT |
A clinical terminology. This guide uses two of its codes, for the type of work and for the requested service |
|
Library |
The FHIR Library resource that describes the standard dataset of a requested service. The ActivityDefinition or PlanDefinition of the service refers to it |
|
HealthcareService |
The service of a fulfiller that is asked to carry out the work. A fulfiller handles tasks through one or more of its HealthcareServices, and |
Implementation guides and generic agreements
The agreements that this document deals with are of two kinds:
An implementation guide tells an implementer how to build a solution for a use case, from start to finish: who does what, which data is exchanged, how it is retrieved and how it is secured. It does not need to contain every detailed requirement itself. It can refer to the generic agreements for those, and its job is then to make clear which parts to use, in what order, and with which choices. TA NP (for the BgZ referral) and the eOverdracht supplier specification (the leveranciersspecificatie, for the nursing handover) are implementation guides.
A generic agreement specifies one aspect in a generic way, independent of any use case. TA Notifications covers only the notification, TA Workflow only the tracking of the work, TA I&A&A only identification, authentication and authorization, and TA Pull only the retrieval that follows a notification. A generic agreement is not enough to build an exchange from. It deliberately leaves open the choices that depend on the use case. An implementation guide makes these choices.
This document is an implementation guide, harmonizing the two existing agreements. When using this agreement, two limitations should be considered:
-
The agreement is limited to what we consider implementable at the current time. Bidding is therefore not included.
-
An information model is not specified, that is left to the implementer.
The generic agreements
Each is normative for what it covers.
|
Generic agreement |
What it covers |
Version used here |
Status |
|
TA Notifications |
How a sending organization notifies a receiving organization: FHIR Subscriptions (R4, on the Subscriptions R5 Backport IG), notification format and payload modes, delivery, retry, recovery after missed notifications |
0.10 |
Working version |
|
TA Workflow |
How a referral, order or transfer is sent from one organization to another and tracked until the work is done: the Coordination Task, the patterns for one or several candidate receivers, bidding, cancellation |
0.4 |
Working version |
|
TA I&A&A |
Identification, authentication and authorization of the parties, systems and users involved |
To be filled in |
Forthcoming |
|
TA Pull |
The retrieval of the content that follows a notification |
To be filled in |
Forthcoming |
Three further documents are referred to by these generic agreements and are relevant here:
-
GF Addressing, for registering and finding the endpoints of an organization or service.
-
GF Authorization and GF Consent, for the authorization and the processing basis (including patient consent) for an exchange.
-
TA Routing, for how a received request is routed internally to the right service and location.
Choices made by this guide
Both TA Notifications and TA Workflow can be seen as profiles on FHIR implementation guides. They make choices on items these guides leave open, but not on all of them. Some choices are explicitly left for the implementation guide to make.
TA Workflow furthermore is, among other things, a profile on TA Notifications. It makes choices that TA Notifications has left for the implementation guides. As well as removing some choices TA Workflow does introduce new ones as well.
This section makes all these open choices for the referral with the BgZ or the EPS and for the nursing handover. Each group of choices starts with what TA Workflow fixes.
Choices for creating the Subscription
Follows from TA Workflow.
-
The topic monitors Task, is triggered by create and update, and allows a filter on the owner.
-
A task carries exactly one entry of type type-of-work in
Task.input, and the topic narrows on it. -
Heartbeats SHALL be used for every topic. The placer sets the interval when it creates the Subscription out-of-band.
-
The placer SHALL NOT create a task for a service and topic unless a Subscription for them exists.
Specified by this guide.
|
Choice |
Value |
|
The canonical URL of the topic |
https://landelijkafsprakenstelsel.nl/fhir/SubscriptionTopic/clinical-workflow. This value is a placeholder for now. |
|
The condition that triggers the topic |
The type-of-work entry has SNOMED CT 3457005 (patient referral) for the referral and SNOMED CT 308292007 (transfer of care) for the nursing handover |
|
Who creates the Subscription |
The placer, out-of-band, when the HealthcareService of the fulfiller is onboarded. |
|
The interval between heartbeats |
SHALL be 30 minutes |
|
How long a failed event, handshake or heartbeat is retried |
The placer retries transient errors as TA Notifications specifies. After the maximum retry duration the Subscription is set to off. The duration SHALL be 48 hours for an event notification, 12 hours for the handshake, and one heartbeat interval for a heartbeat |
|
How long events are retained for replay |
SHALL be 7 days |
|
Whether the $events operation is required |
No. TA Workflow does not require it, and specifies a search of the placer’s server for recovery. |
Choices for sending the notification
Follows from TA Workflow.
-
The notification is id-only. It carries a reference to the Coordination Task and no content.
-
A notification SHALL NOT carry an authorization value, whether the Subscription was created in-band or out-of-band. This rule will be reconsidered if TA I&A&A introduces an authorization value bound to a notification.
Specified by this guide.
|
Choice |
Value |
|
Whether related-query is used |
It is not used |
|
Which authorization base applies |
The base is the WGBO (Wet op de geneeskundige behandelovereenkomst). The placer acts on a legal obligation, and the fulfiller may process personal data, including the BSN, once it is agreed who the fulfiller is and the patient has consented to the referral or transfer. |
Choices for pulling the data
Follows from TA Workflow.
-
The placer states in
Task.inputwhat it makes available. An entry of type available-resource refers to one resource, and an entry of type available-query carries a search relative to the FHIR base of the placer. The fulfiller retrieves what the entries refer to. -
The placer’s server SHALL publish a CapabilityStatement that declares what TA Notifications and TA Workflow require. This covers the Subscription, the Task, the Request and the Patient resource. It also declares the
readinteraction on each resource that an entry of type available-resource refers to, and the interactions and search parameters that each search in an entry of type available-query uses. -
A change of
Task.inputis a change of the Coordination Task and is notified like any other update. -
With a single fulfiller, the placer adds these entries at creation, and the fulfiller can read the Request and the Patient resource from the start.
-
The placer SHALL withdraw the read access of the fulfiller to the Request and the Patient resource when it cancels the Coordination Task.
Specified by this guide.
|
Choice |
Value |
|
Which standard dataset is used |
This guide leaves the standard dataset open. The effects of the choice are described in Choosing the standard dataset. Updates of the data are shared as a delta: the placer adds entries for the changed data to |
|
When the data is available |
The resources are available to the fulfiller as long as the task is open. Where the placer specifies |
Choosing the standard dataset
This guide does not specify an information standard. It leaves the standard dataset to the implementer. The owner of an information standard defines which resources belong to a standard dataset and publishes the Library that describes it. This guide does not define the content of any standard dataset.
The standard datasets of the two original use cases can be used, but more recent standard datasets can be used as well. For the referral, TA NP used the BgZ, but the EPS is an option as well. For the nursing handover, eOverdracht used the offer message (aanmeldbericht) and the handover message (overdrachtsbericht) of the information standard of the nursing handover. Choosing one of these, or another standard dataset, is a choice of the implementation, not of this guide.
The rest of this section follows from TA Workflow. It is summarized here to guide an implementer who chooses a standard dataset.
A standard dataset is a guideline, not a requirement. It states what a fulfiller expects. It neither obliges the placer to make all of it available nor limits the placer to it. A fulfiller that misses information it expects can ask for it, with the business status awaiting-information.
ServiceRequest.instantiatesCanonical can be empty. A Request that refers to no definition is valid, and it has no standard dataset. Where the element refers to an ActivityDefinition or PlanDefinition, that definition can refer in its library element to the Library of a standard dataset. A Request has a standard dataset only where its definition does.
The fulfiller publishes the services it supports as codes in HealthcareService.type of its HealthcareService. It can also publish the ActivityDefinitions and PlanDefinitions that describe them, and lists only those it supports. TA Workflow says that the fulfiller should be able to process a Request that refers to one of them, and that it may decline any Request by rejecting the task. A fulfiller that supports a standard dataset publishes the ActivityDefinition whose Library describes it.
Choices for clinical workflow
Follows from TA Workflow.
-
In the single fulfiller pattern, the task code is fulfill from creation, and
Task.owneridentifies the HealthcareService of the one fulfiller. -
The fulfiller moves the task to
acceptedbeforein-progress. It can decline withrejectedand give up withfailed, each with a reason inTask.statusReason. -
The placer cancels the task itself before the work has started. After that it creates a Cancellation Request Task, which withdraws the Request. If the fulfiller accepts, it sets the task to
cancelledand the Request is revoked. If it rejects, the work continues. -
The Request and the task refer to the patient by the opaque id of the Patient resource. Business identifiers are carried only in
Patient.identifier. -
ServiceRequest.codestates the requested service. The type of work is a separate entry inTask.input. -
The fulfiller routes the Request internally on the definition that it refers to, or on
ServiceRequest.codealone if there is none, and onTask.locationwhere present. It can decline any Request by rejecting the task, also one that refers to a definition it supports. -
When a task ends, the placer decides what happens to the Request. After completed it normally completes the Request. After
failedorrejectedit creates a new task for another or the same fulfiller, or revokes the Request. -
No business status is mandatory. The values are agreed per use case.
Specified by this guide.
|
Choice |
Value |
|
Which code states the requested service |
Where the Request refers to no ActivityDefinition, ServiceRequest.code SHALL be the same as the type-of-work entry in Task.input. Where it refers to a definition that has a code, the code follows that definition, as TA Workflow specifies |
|
Which code is the type of work |
The type-of-work entry in Task.input SHALL carry SNOMED CT 3457005 (patient referral) for the referral and SNOMED CT 308292007 (transfer of care) for the nursing handover. |
|
From which point the fulfiller may set the status to in-progress |
For the referral, when the fulfiller starts processing the referral, for example by preparing the first visit. For the nursing handover, when it starts preparing the admission of the patient. This is not visible through the Coordination Task |
|
Which business statuses the use case agrees |
The fulfiller MAY set two business statuses within a task status: awaiting-information and visit-scheduled. With awaiting-information it states in Task.statusReason.text what it needs from the placer. With visit-scheduled a visit with the patient is scheduled. No other values SHALL be used |
|
Whether multiple fulfillers and bidding are supported |
Not supported. The single fulfiller pattern applies, so the placer has selected the fulfiller before it creates the task, and the Patient resource is readable from the start |
|
Which identifiers of the patient are used |
Besides the opaque id used in the task, the BSN SHALL be carried in Patient.identifier. (For the nursing handover this differs from eOverdracht, where the task contained no data with which the patient could be identified) |
|
Which reasons the placer may give for cancelling |
The placer states the reason when it cancels the task or asks for work to be stopped, for example withdrawal of the referral or the transfer, or a wrongly chosen fulfiller |
|
On which grounds the fulfiller may reject a cancellation request |
Not limited. The fulfiller decides |
|
What the placer does when a task ends without the work being done |
When a task ends as rejected or failed, the placer creates a new task for another fulfiller, or withdraws the referral or the transfer |
|
What the fulfiller shares in Task.output, during and at the end of the workflow |
The fulfiller is not required to fill anything beyond the status. The fulfiller MAY add resources to the output during, and at the end of the workflow. |