Twiin Workflow
0.4.0-draft - Draft – normative only when referenced by the Twiin afsprakenstelsel

This page is part of the Twiin Workflow (v0.4.0-draft: Release 1 Draft) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

Twiin Workflow Placer Server

Requirements for the FHIR server of the Placer under TA Workflow (TA section Placer server capabilities). Imports the Twiin Subscription Server of TA Notifications for Subscription.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

Task owner-assigner

The URA of the organization that assigned the identifier of the HealthcareService in Task.owner, which is the organization that provides that HealthcareService. Used to filter one Subscription for all HealthcareServices of an organization, and to search for the Tasks of that organization.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Twiin Authorization Cancellation Request Task

Authorization Cancellation Request Task under TA Workflow, used by a Fulfiller to ask the Placer to withdraw the Request itself (TA sections Summary of the profiles → Authorization Cancellation Request Task; Cancellation by the Fulfiller). COW IG defines no profile for this Task. requester and owner identify the Fulfiller and the Placer as organizations, by their URA.

Twiin Cancellation Request Task

Cancellation Request Task under TA Workflow, used by the Placer to ask the Fulfiller to stop work that has started (TA sections Summary of the profiles → Cancellation Request Task; Cancellation Request Task; Type of work on the Task).

Twiin Coordination Task

Coordination Task under TA Workflow (TA sections Summary of the profiles → Coordination Task; Coordination Task; Status of the Coordination Task; Patient context and readability; Type of work on the Task; Sharing additional content; Search parameters; Codes of this TA).

Twiin Workflow ServiceRequest

The Request under TA Workflow (TA sections Summary of the profiles → ServiceRequest; Request; Patient context and readability). subject refers to a Patient and is not masked; code states the requested service; instantiatesCanonical MAY refer to the ActivityDefinition or PlanDefinition of the requested service.

Twiin Workflow Subscription

Subscription under TA Workflow, on top of the Twiin Subscription of TA Notifications (TA sections Summary of the profiles → Subscription; Subscription). The payload mode is id-only, the filter is owner:identifier=[system]|[value] (one HealthcareService) or owner-assigner=[system]|[value] (all HealthcareServices of one organization, by its URA), and a heartbeat period is required.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

TA Workflow Business Status

Codes for Task.businessStatus of the Coordination Task under TA Workflow (TA sections Business status; Codes of this TA). Extensible: a use case MAY define further codes. selected is reserved for the Placer.

TA Workflow Status Reason

Codes for Task.statusReason of the Coordination Task under TA Workflow. Extensible: a use case or a Fulfiller MAY use other reasons, for instance when it rejects a Task; not-selected is reserved for the Placer.

TA Workflow Task Code

Codes for Task.code of the Coordination Task under TA Workflow.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

TA Workflow Codes

Codes defined by TA Workflow for Task.code, Task.businessStatus, Task.statusReason and Task.input.type.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Authorization Cancellation Request Task

A Fulfiller asks the Placer to withdraw the Request (TA section Cancellation by the Fulfiller). requester identifies the Fulfiller and owner the Placer, each by its URA. reasonCode carries the reason of the Fulfiller.

Cancellation Request Task

The Placer asks the Fulfiller to stop work that has started. focus refers to the Coordination Task, owner and the type of work are the same as on that Task (TA sections Cancellation Request Task; Cancellation Request (After in-progress)).

Coordination Task: candidate invited

A bidding task in the Multiple Fulfillers Pattern before selection: code request-fulfillment (TA sections Multiple Fulfillers Pattern; Patient context and readability). Task.input also carries a non-identifying entry with its content inline, as allowed before selection (TA sections Sharing additional content; Patient context and readability).

Coordination Task: candidate not selected

The Coordination Task of a candidate that was not selected: status cancelled with statusReason not-selected and the text not selected (TA section Reason for cancelling a non-selected candidate).

Coordination Task: candidate selected

The Coordination Task of the selected candidate: businessStatus selected, code fulfill set in the same update (TA sections Multiple Fulfillers Pattern; Patient context and readability). The candidate had accepted and recorded a bid in output.

Coordination Task: reselection step 1, A accepted

Step 1. The Coordination Task of candidate A after A accepted: code request-fulfillment, only the type of work in input (TA sections Multiple Fulfillers Pattern; Patient context and readability).

Coordination Task: reselection step 1, B accepted

Step 1. The Coordination Task of candidate B after B accepted: code request-fulfillment, only the type of work in input (TA sections Multiple Fulfillers Pattern; Patient context and readability).

Coordination Task: reselection step 2, A selected

Step 2. The Coordination Task of A when the Placer selects A: businessStatus selected, code fulfill set in the same update (TA sections Multiple Fulfillers Pattern; Patient context and readability). The Request has performer set to A.

Coordination Task: reselection step 2, B not selected

Step 2. The Coordination Task of B when A is selected: status cancelled with statusReason not-selected (TA section Reason for cancelling a non-selected candidate).

Coordination Task: reselection step 3, A cancelled

Step 3. The Placer cancels the Coordination Task of the selected A before in-progress, while the Request continues (TA section Cancellation (Before in-progress)). statusReason.text gives the reason; the code not-selected is not used, because no other candidate has been selected. The Request has performer unset again.

Coordination Task: reselection step 4, B invited again

Step 4. A new Coordination Task for B on the same Request, after the earlier Task of B ended (TA sections Multiple Fulfillers Pattern; Handling the End of a Coordination Task). code request-fulfillment.

Coordination Task: reselection step 4, C invited

Step 4. A Coordination Task for the new candidate C on the same Request (TA sections Multiple Fulfillers Pattern; Patient context and readability). code request-fulfillment.

Coordination Task: reselection step 5, B not selected

Step 5. The new Coordination Task of B when C is selected: status cancelled with statusReason not-selected (TA section Reason for cancelling a non-selected candidate).

Coordination Task: reselection step 5, C selected

Step 5. The Coordination Task of C when the Placer selects C, after C accepted (TA section Multiple Fulfillers Pattern: the Placer selects only a candidate whose Task has status accepted). businessStatus selected, code fulfill set in the same update.

Coordination Task: sharing step 1, content shared before selection

Step 1. The Placer invites the candidate and adds an entry to input with its content inline, without a reference, since before selection a candidate may read the Request but not the Patient or other resources at the Placer. The entry does not identify the patient (TA sections Sharing additional content; Patient context and readability). The type Dressing type is fictitious: the use case defines the type and states why the content is not identifying.

Coordination Task: sharing step 2, candidate awaits information

Step 2. The candidate accepted, sets businessStatus awaiting-information and states in statusReason.text what it needs (TA section Business status).

Coordination Task: sharing step 3, Placer answers in input

Step 3. The Placer provides the information by adding an entry to input, again with its content inline (TA sections Business status; Sharing additional content). The Fulfiller then sets another value or removes businessStatus.

Coordination Task: sharing step 4, candidate has the information

Step 4. The candidate removes businessStatus and statusReason (TA section Business status).

Coordination Task: sharing step 5, available resource after selection

Step 5. The Placer selects the candidate: businessStatus selected, code fulfill set in the same update, together with an entry with type available-resource that refers to a resource at the Placer (TA sections Sharing additional content; Patient context and readability).

Coordination Task: single Fulfiller, awaiting information

The Fulfiller awaits information from the Placer (TA section Business status).

Coordination Task: single Fulfiller, in progress

Single Fulfiller Pattern: code fulfill from creation; the Fulfiller has started the work. Task.input also carries an available-resource and an available-query entry (TA sections Single Fulfiller Pattern; Sharing additional content).

Observation: updated wound assessment

A resource at the Placer to which the Coordination Task refers after selection, in an entry with type available-resource (TA section Sharing additional content). The content is fictitious.

Patient

The Patient to which the Request refers. Carries the BSN in Patient.identifier (TA section Patient context and readability).

Scenario 1, step 1: created

The Placer creates the Coordination Task with code fulfill, and with the entries it makes available, since in the Single Fulfiller Pattern there is no selection.

Scenario 1, step 2: accepted

The Fulfiller accepts the Coordination Task.

Scenario 1, step 3: in progress

The Fulfiller starts the work: status in-progress and executionPeriod.start.

Scenario 1, step 4: completed

The Fulfiller completes the work: status completed and executionPeriod.end set when the status moves from in-progress.

Scenario 1: Request, single Fulfiller

The Request of scenario 1. The Single Fulfiller Pattern applies: performer refers to the HealthcareService of A. priority is populated, as the Placer SHOULD do.

Scenario 2, step 1: A accepted with a bid

Candidate A accepts its Coordination Task (code request-fulfillment) and records a bid in output.

Scenario 2, step 1: B accepted with a bid

Candidate B accepts its Coordination Task (code request-fulfillment) and records a bid in output.

Scenario 2, step 2: A selected

The Placer selects A: businessStatus selected, code fulfill set in one update, together with the entries with type available-resource and available-query that it makes available.

Scenario 2, step 2: B not selected

In the same step the Placer cancels the Coordination Task of B with statusReason not-selected.

Scenario 2: Request, multiple Fulfillers

The Request of scenario 2. performer is unset: the Multiple Fulfillers Pattern applies. Candidates may read the Request from the creation of their Coordination Task; the Request contains no data that directly identifies the patient beyond the reference in subject.

Scenario 4, step 1: accepted

The Fulfiller has accepted; the work has not started.

Scenario 4, step 2: cancelled by the Placer

Before in-progress the Placer cancels the Coordination Task itself, with its reason in statusReason.text.

Scenario 4: Request

The Request of scenario 4, Single Fulfiller Pattern.

Scenario 5, step 1: Request active

The Request of scenario 5 while the work is in progress.

Scenario 5, step 1: in progress

The Fulfiller has started the work.

Scenario 5, step 2: Cancellation Request Task requested

The Placer asks the Fulfiller to stop the work, with its reason in reasonCode.

Scenario 5, step 3: Cancellation Request Task accepted

The Fulfiller accepts the Cancellation Request Task.

Scenario 5, step 3: cancelled after the Cancellation Request

After accepting the Cancellation Request Task the Fulfiller sets the Coordination Task to cancelled (not failed) and sets executionPeriod.end.

Scenario 5, step 4: Request revoked

The Placer revokes the Request. Same identifier as step 1: one resource in successive states.

Scenario 6, step 1: Authorization Cancellation Request requested

The Fulfiller asks the Placer to withdraw the Request: intent proposal, code abort, focus the Request, reason in reasonCode.

Scenario 6, step 2: Authorization Cancellation Request accepted

The Placer accepts the request to withdraw the Request.

Scenario 7, step 1: Fulfiller requests information

The Fulfiller sets businessStatus awaiting-information with statusReason.text, and adds an entry with type information-request to input.

Scenario 7, step 2: Placer answers

The Placer answers with a further entry in input, with type available-resource, that refers to the wound assessment.

Scenario 7, step 3: Fulfiller has the information

The Fulfiller removes businessStatus, statusReason and its information-request entry.

Scenario 7: wound assessment

The resource at the Placer with which the Placer answers the information request. The content is fictitious.

ServiceRequest: no definition

A Request that follows no predefined definition and has no standard dataset; it is routed on ServiceRequest.code alone (TA sections Request; Routing by the Fulfiller).

ServiceRequest: reselection step 2, performer set to A

The Request of the reselection scenario at step 2, after A was selected: performer refers to the HealthcareService of A (TA section Multiple Fulfillers Pattern). At step 3 the Placer clears performer again; that state is the Request with performer unset. Same identifier as the other variants.

ServiceRequest: reselection step 5, performer set to C

The Request of the reselection scenario at step 5, after C was selected: performer refers to the HealthcareService of C (TA section Multiple Fulfillers Pattern). Same identifier as the other two variants: they are one resource in successive states.

ServiceRequest: reselection, performer unset

The Request of the reselection scenario while solicitation is open: performer unset (TA section Multiple Fulfillers Pattern). This is its state at steps 1, 3 and 4, and the state to which the Coordination Tasks of the scenario refer. Same identifier as the other two variants: they are one resource in successive states.

ServiceRequest: sharing additional content

The Request of the scenario sharing additional content. performer is unset: the Multiple Fulfillers Pattern applies.

ServiceRequest: transfer of care

The Request, with subject a Patient and instantiatesCanonical referring to the definition of the requested service (TA sections Request; Patient context and readability). performer is unset: the Multiple Fulfillers Pattern applies.

Subscription for a HealthcareService

Subscription for one HealthcareService and one topic at the base URL of the Placer: filter owner:identifier, id-only, heartbeat period (TA section Subscription). The topic URL is an example; topics are defined per use case.

Subscription for an organization

Subscription for all HealthcareServices of Fulfiller A, also those registered later: filter owner-assigner with the URA of the organization; channel.endpoint begins with the address of an Endpoint in Organization.endpoint. The topic URL is an example.