Integrating the Healthcare Enterprise
IHE Radiology
Technical Framework Supplement
5
Cross-Enterprise Remote Read
Workflow Definition
(XRR-WD)
10
Draft for Public Comment
15
20
25
Date:
April 22, 2016
Author:
IHE Radiology Technical Committee
Email:
radiology@ihe.net
Please verify you have the most recent version of this document. See here for Trial
Implementation and Final Text versions and here for Public Comment versions.
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Foreword
30
35
This is a supplement to the IHE Radiology Technical Framework V14.0. Each supplement
undergoes a process of public comment and trial implementation before being incorporated into
the volumes of the Technical Frameworks.
This supplement is published on April 22, 2016 for public comment. Comments are invited and
may be submitted at http://www.ihe.net/Radiology_Public_Comments. In order to be considered
in development of the trial implementation version of the supplement, comments must be
received by May 22, 2016.
This supplement describes changes to the existing technical framework documents.
“Boxed” instructions like the sample below indicate to the Volume Editor how to integrate the
relevant section(s) into the relevant Technical Framework volume.
Amend Section X.X by the following:
40
Where the amendment adds text, make the added text bold underline. Where the amendment
removes text, make the removed text bold strikethrough. When entire new sections are added,
introduce with editor’s instructions to “add new text” or similar, which for readability are not
bolded or underlined.
45
General information about IHE can be found at: www.ihe.net.
Information about the IHE Radiology domain can be found at: ihe.net/IHE_Domains.
Information about the organization of IHE Technical Frameworks and Supplements and the
process used to create them can be found at: http://ihe.net/IHE_Process and
http://ihe.net/Profiles.
50
The current version of the IHE Radiology Technical Framework can be found at:
http://www.ihe.net/Technical_Frameworks.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
2
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
CONTENTS
55
60
65
70
75
80
85
90
95
Introduction to this Supplement ...................................................................................................... 9
Open Issues and Questions ........................................................................................................ 9
Closed Issues ............................................................................................................................ 10
Volume 1 – Profiles ..................................................................................................................... 11
Copyright Permission ............................................................................................................... 11
Domain-specific additions ....................................................................................................... 11
X Cross-Enterprise Remote Read (XRR-WD) Profile ................................................................. 12
X.1 XRR-WD Actors, Transactions, and Content Modules .................................................... 12
X.1.1 Actor Descriptions and Actor Profile Requirements ................................................. 14
X.1.1.1 Remote Read Requester..................................................................................... 14
X.1.1.2 Remote Read Dispatcher ................................................................................... 14
X.1.1.3 Remote Read Performer .................................................................................... 15
X.1.1.4 Workflow Monitor ............................................................................................. 15
X.2 XRR-WD Actor Options ................................................................................................... 15
X.2.1 XDS Option ............................................................................................................... 16
X.3 XRR-WD Required Actor Groupings ............................................................................... 16
X.4 XRR-WD Overview .......................................................................................................... 18
X.4.1 Concepts .................................................................................................................... 18
X.4.1.1 Collaboration Group .......................................................................................... 18
X.4.1.2 Workflow Stakeholders ..................................................................................... 18
X.4.1.3 Remote Read Documents .................................................................................. 19
X.4.1.4 XDW Workflow Definition Profile representation ........................................... 19
X.4.1.5 Delivery of Notifications ................................................................................... 24
X.4.1.5.1 Workflow Status Update Notification for the Read Requester.................. 24
X.4.1.5.2 Read Request Workflow Task Creation Notification to the Read
Dispatcher ................................................................................................. 25
X.4.1.5.3 Read Request Workflow Task Availability/Assignment Notification ...... 25
X.4.1.5.4 Referring/Attending Physician Report and Critical Findings Availability
Notification ............................................................................................... 26
X.4.1.5.5 Workflow Notification Pull ....................................................................... 26
X.4.2 Use Cases .................................................................................................................. 26
X.4.2.1 Use Case #1: Basic Remote Read Process ........................................................ 27
X.4.2.1.1 Basic Remote Read Process Use Case Description ................................... 27
X.4.2.1.2 Basic Remote Read Process Flow ............................................................. 29
X.4.2.2 Use Case #2: Remote Read, Preliminary Urgent Read Request Scenario ........ 31
X.4.2.2.1 Remote Read, Preliminary Urgent Read Request Scenario use-case
description ................................................................................................. 32
X.4.2.3 Use Case #3: Remote Read, Sub-Specialty Read Request Scenario ................. 32
X.4.2.3.1 Remote Read, Sub-Specialty Read Request use-case description ............. 32
X.4.2.4 Use Case 4#: Remote Read Over Read Consult Scenario ................................. 33
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
3
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
100
105
110
115
120
125
130
135
X.4.2.4.1 Remote Read Over Read Consult use-case description ............................. 33
X.4.2.5 Use case 5#: Remote Read, Request Cancellation ............................................ 33
X.4.2.5.1 Remote Read, Request Cancellation use-case description ........................ 33
X.4.2.5.2 Remote Read, Request Cancellation process flow .................................... 34
X.4.2.6 Use case 6#: Production of an Addendum......................................................... 34
X.4.2.6.1 Production of an Addendum use-case description ..................................... 34
X.4.2.6.2 Production of an Addendum process flow ................................................. 35
X.4.2.7 Use case 7# Remote Read, Assign Cancellation ............................................... 35
X.4.2.7.1 Remote Read, Assign Cancellation use case description .......................... 35
X.4.2.7.2 Remote Read, Assign Cancellation process-flow ...................................... 36
X.4.2.8 Use case 8# Open-Assignment .......................................................................... 36
X.4.2.8.1 Open-Assignment use case description ..................................................... 37
X.4.2.8.2 Open-Assignment process-flow ................................................................. 37
X.4.2.9 Use case 9# Open-Assignment and race-condition ........................................... 37
X.4.2.9.1 Open-Assignment and race-condition use case description ...................... 37
X.4.2.9.2 Open-Assignment and race-condition process-flow .................................. 38
X.5 XRR-WD Security Considerations ................................................................................... 39
X.6 XRR-WD Cross Profile Considerations............................................................................ 40
Appendices .................................................................................................................................... 41
Appendix A - Actor Summary Definitions ................................................................................... 41
Appendix B - Transaction Summary Definitions ......................................................................... 41
Glossary ........................................................................................................................................ 41
Volume 2 – Transactions ............................................................................................................ 42
3.QQ Submit Read Request [RAD-QQ] .................................................................................. 42
3.QQ.1 Scope ...................................................................................................................... 42
3.QQ.2 Actor Roles ............................................................................................................. 42
3.QQ.3 Referenced Standards ............................................................................................. 42
3.QQ.4 Interaction Diagram ................................................................................................ 43
3.QQ.4.1 Submit Read Request ...................................................................................... 43
3.QQ.4.1.1 Trigger Events ......................................................................................... 43
3.QQ.4.1.2 Message Semantics ................................................................................. 43
3.QQ.4.1.2.1 Remote Read Workflow Document Content Requirements ........... 44
3.QQ.4.1.2.1.1 Workflow Document Elements ............................................... 44
3.QQ.4.1.2.2 Read Request Content Requirements .............................................. 46
3.QQ.4.1.2.3 Document Sharing Metadata requirements ..................................... 46
3.QQ.4.2 Provide and Register Document set-b Response ............................................ 47
3.QQ.4.2.1 Trigger Events ......................................................................................... 47
3.QQ.4.2.2 Message Semantics ................................................................................. 47
3.QQ.4.2.3 Expected Actions .................................................................................... 47
3.QQ.5 Security Considerations .......................................................................................... 48
3.QQ.5.1 Security Audit Considerations ........................................................................ 48
3.YY Assign Remote Read [RAD-YY] ................................................................................... 48
3.YY.1 Scope ...................................................................................................................... 48
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
4
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
140
145
150
155
160
165
170
175
180
3.YY.2 Actor Roles ............................................................................................................ 48
3.YY.3 Referenced Standards ............................................................................................. 48
3.YY.4 Interaction Diagram ................................................................................................ 48
3.YY.4.1 Submit Dispatch.............................................................................................. 49
3.YY.4.1.1 Trigger Events ......................................................................................... 49
3.YY.4.1.2 Message Semantics ................................................................................. 50
3.YY.4.1.2.1 Remote Read Workflow Document Content Requirements ........... 50
3.YY.4.1.2.1.1 Workflow Document Elements ............................................... 50
3.YY.4.1.2.2 Document Sharing Metadata requirements ..................................... 52
3.YY.4.1.3 Expected Actions .................................................................................... 53
3.YY.4.2 Provide and Register Document set-b Response ............................................ 53
3.YY.4.2.1 Trigger Events ......................................................................................... 53
3.YY.4.2.2 Message Semantics ................................................................................. 53
3.YY.4.2.3 Expected Actions .................................................................................... 53
3.YY.5 Security Considerations .......................................................................................... 53
3.YY.5.1 Security Audit Considerations ........................................................................ 53
3.VV Accept/Reject or Release Assignment [RAD-VV] ........................................................ 54
3.VV.1 Scope ...................................................................................................................... 54
3.VV.2 Actor Roles ............................................................................................................ 54
3.VV.3 Referenced Standards ............................................................................................. 54
3.VV.4 Interaction Diagram ................................................................................................ 54
3.VV.4.1 Submit Assignment ......................................................................................... 55
3.VV.4.1.1 Trigger Events ......................................................................................... 55
3.VV.4.1.2 Message Semantics ................................................................................. 56
3.VV.4.1.2.1 Remote Read Workflow Document Content Requirements ........... 56
3.VV.4.1.2.1.1 Workflow Document Elements ............................................... 56
3.VV.4.1.2.2 Document Sharing Metadata requirements ..................................... 57
3.VV.4.1.3 Expected Actions .................................................................................... 57
3.VV.4.2 Provide and Register Document set-b Response ............................................ 57
3.VV.4.2.1 Trigger Events ......................................................................................... 57
3.VV.4.2.2 Message Semantics ................................................................................. 57
3.VV.4.2.3 Expected Actions .................................................................................... 57
3.VV.5 Security Considerations .......................................................................................... 58
3.VV.5.1 Security Audit Considerations ........................................................................ 58
3.KK Complete Remote Read [RAD-KK]............................................................................... 58
3.KK.1 Scope ...................................................................................................................... 58
3.KK.2 Actor Roles ............................................................................................................ 58
3.KK.3 Referenced Standards ............................................................................................. 58
3.KK.4 Interaction Diagram ................................................................................................ 58
3.KK.4.1 Submit Read Completion ................................................................................ 59
3.KK.4.1.1 Trigger Events ......................................................................................... 59
3.KK.4.1.2 Message Semantics ................................................................................. 60
3.KK.4.1.2.1 Remote Read Workflow Document Content Requirements ........... 60
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
5
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
185
190
195
200
205
210
215
220
3.KK.4.1.2.1.1 Workflow Document Elements ............................................... 60
3.KK.4.1.2.2 Final Report Content Requirements ................................................ 60
3.KK.4.1.2.3 Document Sharing Metadata requirements ..................................... 60
3.KK.4.1.3 Expected Actions .................................................................................... 61
3.KK.4.2 Provide and Register Document set-b Response ............................................ 61
3.KK.4.2.1 Trigger Events ......................................................................................... 61
3.KK.4.2.2 Message Semantics ................................................................................. 61
3.KK.4.2.3 Expected Actions .................................................................................... 61
3.KK.5 Security Considerations .......................................................................................... 62
3.KK.5.1 Security Audit Considerations ........................................................................ 62
3.ZZ Acknowledge Read Completion [RAD-ZZ] ................................................................... 62
3.ZZ.1 Scope ....................................................................................................................... 62
3.ZZ.2 Actor Roles ............................................................................................................. 62
3.ZZ.3 Referenced Standards .............................................................................................. 62
3.ZZ.4 Interaction Diagram ................................................................................................. 62
3.ZZ.4.1 Submit Ack ...................................................................................................... 63
3.ZZ.4.1.1 Trigger Events.......................................................................................... 63
3.ZZ.4.1.2 Message Semantics .................................................................................. 64
3.ZZ.4.1.2.1 Remote Read Workflow Document Content Requirements ............ 64
3.ZZ.4.1.2.1.1 Workflow Document Elements ................................................ 64
3.ZZ.4.1.2.2 Document Sharing Metadata requirements ...................................... 66
3.ZZ.4.1.3 Expected Actions ..................................................................................... 66
3.ZZ.4.2 Provide and Register Document set-b Response ............................................. 66
3.ZZ.4.2.1 Trigger Events.......................................................................................... 66
3.ZZ.4.2.2 Message Semantics .................................................................................. 67
3.ZZ.4.2.3 Expected Actions ..................................................................................... 67
3.ZZ.5 Security Considerations ........................................................................................... 67
3.ZZ.5.1 Security Audit Considerations ......................................................................... 67
3.XX Fail Read [RAD-XX] ..................................................................................................... 67
3.XX.1 Scope ...................................................................................................................... 67
3.XX.2 Actor Roles ............................................................................................................ 67
3.XX.3 Referenced Standards ............................................................................................. 67
3.XX.4 Interaction Diagram ................................................................................................ 68
3.XX.4.1 Submit Fail...................................................................................................... 68
3.XX.4.1.1 Trigger Events ......................................................................................... 68
3.XX.4.1.2 Message Semantics ................................................................................. 70
3.XX.4.1.2.1 Remote Read Workflow Document Content Requirements ........... 70
3.XX.4.1.2.1.1 Workflow Document Elements ............................................... 70
3.XX.4.1.2.2 Document Sharing Metadata requirements ..................................... 70
3.XX.4.1.3 Expected Actions .................................................................................... 71
3.XX.4.2 Provide and Register Document set-b Response ............................................ 71
3.XX.4.2.1 Trigger Events ......................................................................................... 71
3.XX.4.2.2 Message Semantics ................................................................................. 71
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
6
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
225
230
235
240
245
250
255
260
265
3.XX.4.2.3 Expected Actions .................................................................................... 71
3.XX.5 Security Considerations .......................................................................................... 71
3.XX.5.1 Security Audit Considerations ........................................................................ 71
3.JJ Revoke Assigned Read [RAD-JJ] ..................................................................................... 71
3.JJ.1 Scope ......................................................................................................................... 71
3.JJ.2 Actor Roles............................................................................................................... 72
3.JJ.3 Referenced Standards ................................................................................................ 72
3.JJ.4 Interaction Diagram .................................................................................................. 72
3.JJ.4.1 Submit Revoke .................................................................................................. 72
3.JJ.4.1.1 Trigger Events ........................................................................................... 72
3.JJ.4.1.2 Message Semantics .................................................................................... 73
3.JJ.4.1.2.1 Remote Read Workflow Document Content Requirements .............. 73
3.JJ.4.1.2.1.1 Workflow Document Elements .................................................. 73
3.JJ.4.1.2.2 Document Sharing Metadata requirements........................................ 74
3.JJ.4.1.3 Expected Actions ....................................................................................... 74
3.JJ.4.2 Provide and Register Document set-b Response ............................................... 74
3.JJ.4.2.1 Trigger Events ........................................................................................... 74
3.JJ.4.2.2 Message Semantics .................................................................................... 74
3.JJ.4.2.3 Expected Actions ....................................................................................... 75
3.JJ.5 Security Considerations ............................................................................................ 75
3.JJ.5.1 Security Audit Considerations........................................................................... 75
3.HH Claim a Read [RAD-HH] ............................................................................................... 75
3.HH.1 Scope ...................................................................................................................... 75
3.HH.2 Actor Roles ............................................................................................................ 75
3.HH.3 Referenced Standards ............................................................................................. 75
3.HH.4 Interaction Diagram ................................................................................................ 76
3.HH.4.1 Submit Open-Assignment Claim .................................................................... 76
3.HH.4.1.1 Trigger Events ......................................................................................... 76
3.HH.4.1.2 Message Semantics ................................................................................. 77
3.HH.4.1.2.1 Remote Read Workflow Document Content Requirements ........... 77
3.HH.4.1.2.1.1 Workflow Document Elements ............................................... 77
3.HH.4.1.2.2 Document Sharing Metadata requirements ..................................... 77
3.HH.4.1.3 Expected Actions .................................................................................... 78
3.HH.4.2 Provide and Register Document set-b Response ............................................ 78
3.HH.4.2.1 Trigger Events ......................................................................................... 78
3.HH.4.2.2 Message Semantics ................................................................................. 78
3.HH.4.2.3 Expected Actions .................................................................................... 78
3.HH.5 Security Considerations .......................................................................................... 78
3.HH.5.1 Security Audit Considerations ........................................................................ 78
3.WW Update Content [RAD-WW] ........................................................................................ 79
3.WW.1 Scope..................................................................................................................... 79
3.WW.2 Actor Roles .......................................................................................................... 79
3.WW.3 Referenced Standards ........................................................................................... 79
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
7
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
270
275
280
285
3.WW.4 Interaction Diagram .............................................................................................. 80
3.WW.4.1 Update Task .................................................................................................. 80
3.WW.4.1.1 Trigger Events ....................................................................................... 80
3.WW.4.1.2 Message Semantics ............................................................................... 81
3.WW.4.1.2.1 Remote Read Workflow Document Content Requirements ......... 81
3.WW.4.1.2.1.1 Workflow Document Elements ............................................. 81
3.WW.4.1.2.2 Preliminary Report Content Requirements ................................... 82
3.WW.4.1.2.3 Addendum Content Requirements ................................................ 82
3.WW.4.1.2.4 Document Sharing Metadata requirements ................................... 82
3.WW.4.1.3 Expected Actions .................................................................................. 83
3.WW.4.2 Provide and Register Document set-b Response .......................................... 83
3.WW.4.2.1 Trigger Events ....................................................................................... 83
3.WW.4.2.2 Message Semantics ............................................................................... 83
3.WW.4.2.3 Expected Actions .................................................................................. 83
3.WW.5 Security Considerations ........................................................................................ 83
3.WW.5.1 Security Audit Considerations ...................................................................... 83
Volume 2 Namespace Additions .................................................................................................. 83
Volume 3 – Content Modules ..................................................................................................... 85
Volume 4 – National Extensions ................................................................................................ 86
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
8
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Introduction to this Supplement
290
295
300
The Cross-Enterprise Remote Read Workflow Definition (XRR-WD) Profile is a Workflow
Definition profile based on the ITI XDW (Cross-Enterprise Document Workflow) Profile. This
workflow definition establishes a common set of rules for participants involved in a CrossEnterprise Read of Images workflow.
A Remote Read process can be managed within many different sharing infrastructures. In this
profile, we present a workflow that uses the XDS-I.b infrastructure to share both the Workflow
Documents that manage the Remote Read and also the DICOM®1 manifest and images for the
study being read.
In Volume 1 we present the typical use-cases to illustrate some of the many possible evolutions
of the related workflow. We define the Workflow Participants involved and their responsibilities
within the workflow itself.
In Volume 3 we explain how to use a Workflow Document to track and manage this workflow.
In particular, we specify transaction to manage each step of the workflow, and rules to follow to
go through these steps.
305
At the end of the supplement, Appendix A contains a complete example of a Workflow
Document produced during a Cross-Enterprise Read of Imaging workflow.
Open Issues and Questions
1. The current version of the supplement mandates the sharing of Workflow Documents
using the XDS.b. Readers should provide feedback on this topic. Should XCA XDR
MHD also be addressed?
310
2. The current version of the supplement mandates the sharing of Clinical Documents (other
than the Workflow Document) using the XDS infrastructure. Is this a reasonable
requirement? Are we introducing some limitation to the profile implementation? Should
environments such as XCA XDR or MHD also be addressed? (These would be added as
a new Options in future)
315
3. We are now use priority to convey the urgency of a task. Could this create problems or
conflicts with WS-HumanTask specification/implementation?
From WS-HumanTask: “priority: This element is used to specify the priority of the task.
It is an optional element which value is an integer expression. If present, the WSHumanTask Definition MUST specify a value between 0 and 10, where 0 is the highest
priority and 10 is the lowest. If not present, the priority of the task is considered as 5. The
result of the expression evaluation is of type htt:tPriority”
320
1
DICOM is the registered trademark of the National Electrical Manufacturers Association for its standards
publications relating to digital communications of medical information.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
9
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
4. Is priority an appropriate way to request a Preliminary Report?
325
5. Should the Performer be allowed to close a workflow entirely with a failure status? Or
should it be limited to EXITED the Perform task only, and leave the closure of the
workflow to the Requester only?
6. Much behavior is deferred to “business rules” of the implementation. Will this inhibit
interoperability?
7. What should be covered in the security considerations, given the complexity of multinational shared affinity domains?
330
8. Does the required grouping with DSUB introduce too much complexity?
9. What deployment considerations should be done to manage in acceptable workflow
management? Should we address timing issues in vol.1?
Closed Issues
None
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
10
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Volume 1 – Profiles
335
Copyright Permission
None
Domain-specific additions
340
None
Add Section X…
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
11
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
X Cross-Enterprise Remote Read (XRR-WD) Profile
345
Remote Reading Workflow is the practice of having medical images interpreted (read) by a
reading specialist who is not present at the site where the image study was acquired and is not
reporting using the local PACS and dictation system at the acquiring site. More specifically, the
reading specialist is being asked to read an exam from another organization with a separate
Hospital Information System, Radiology Information System and PACS.
350
This is particularly important for smaller clinical institutions, including urgent care units,
imaging centers, private practices and mobile imaging services with limited credentialed 24/7
staff to handle the reading workload. It may also be important for subspecialties like Nuclear
Medicine or Neuro-radiology where these professionals are generally located at large institutions
in major metropolitan areas.
355
Cross-Enterprise Remote Read Workflow Definition Profile is a Workflow Definition profile for
Remote Reading Workflow, which builds upon the ITI Cross-Enterprise Document Workflow
(XDW) Profile to manage the workflow between facilities performing the workflow tasks.
360
With the introduction of cross-enterprise document and image sharing profiles, such as XDS and
XDS-I, providing cross-institutional access of the patient’s clinical images, the ability to manage
reading workload within an affinity domain community is the next logical step. Institutions today
share studies for better treatment of their patients. This image-sharing infrastructure is already
producing improved patient care outcomes and reducing the need for duplicate procedures.
365
Managing the workflow related to clinical processes complements the use of clinical documents
by different departments of document sharing related IHE profiles with their different types of
document and information. IHE ITI has defined the Cross-Enterprise Document Workflow
profile to specify technical infrastructure to manage a clinical workflow and not on the definition
of the clinical processes, work left to the different IHE Domains.
370
This XRR-WD Profile reduces integration burdens in environments that offer XDS-I sharing
Infrastructures already established. In addition to that, due to the fact that this profile is based on
a XDW workflow management infrastructure, it allows the creation of a network of interactions
between the remote read workflow and other types of clinical workflows (such as Referrals,
Consultations, etc.).
X.1 XRR-WD Actors, Transactions, and Content Modules
This section defines the actors, transactions, and/or content modules which are required to
implement this profile. General definitions of actors are given in the Technical Frameworks
General Introduction Appendix A at http://www.ihe.net/Technical_Frameworks.
375
Figure X.1-1 shows the actors directly involved in the XRR-WD Profile and the relevant
transactions between them. If needed for context, other actors that may be indirectly involved
due to their participation in other related profiles are shown in dotted lines. Actors which have a
mandatory grouping are shown in conjoined boxes.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
12
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
380
Figure X.1-1: XRR-WD Actor Diagram
385
Table X.1-1 lists the transactions for each actor directly involved in the XRR-WD Profile. In
order to claim support of this Profile, an implementation of an actor must perform the required
transactions (labeled “R”) and may support the optional transactions (labeled “O”). Actor
groupings are further described in Section X.3.
Table X.1-1: XRR-WD Profile - Actors and Transactions
Actors
Remote Read
Requester
Remote Read
Dispatcher
Transactions
Optionality
Section in Vol. 3
Submit Read Request [RADQQ]
R
RAD TF-3: 3.QQ
Fail Read [RAD-XX]
R
RAD TF-3: 3.XX
Acknowledge Read
Completion [RAD-ZZ]
R
RAD TF-3: 3.ZZ
Revoke Assigned Read
[RAD-JJ]
R
RAD TF-3: 3.JJ
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
13
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Actors
Remote Read
Performer
Workflow
Monitor
Transactions
Optionality
Section in Vol. 3
Assign Remote Read [RADYY]
R
RAD TF-3: 3.YY
Complete Read [RAD-KK]
R
RAD TF-3: 3.KK
Accept/Reject or Release
Assignment [RAD-VV]
R
RAD TF-3: 3.VV
Update Content [RAD-WW]
R
RAD TF-3: 3.WW
Fail Read [RAD-XX]
R
RAD TF-3: 3.XX
None (Note 1)
-
-
Note 1: The Workflow Monitor Actor supports transactions based on the required groupings (see Section X.3)
390
X.1.1 Actor Descriptions and Actor Profile Requirements
The transaction and content requirements are documented in Transactions (Volume 2) and
Content Modules (Volume 3). This section documents requirements on profile actors.
395
This profile is designed to provide maximum flexibility between the local workflow supported
by each actor, based upon an agreed to set of business rules between the entities deploying these
actors. The business rules associated with each actor is out of scope for this profile.
X.1.1.1 Remote Read Requester
The Remote Read Requester is responsible for initiating the workflow by creating the Read
Request Workflow Document as part of the Submit Read Request [RAD-QQ] transaction.
400
The Remote Read Requester is responsible for completing the workflow by receiving the Final
Report, and acknowledging the receipt of that report as part of the Acknowledge Read
Completion [RAD-ZZ] transaction to close the workflow.
The Remote Read Requester can cancel a request of read initiating the Fail Read [RAD-XX]
transaction, closing the workflow.
405
X.1.1.2 Remote Read Dispatcher
The Remote Read Dispatcher is responsible for receiving the Read Request Workflow Document
from a Remote Read Requester and then assigning the read request to a Remote Read Performer
as part of the Assign Remote Read [RAD-YY] transaction.
410
The Remote Read Dispatcher can revoke the assignment of a Read Request initiating the Revoke
Assigned Read [RAD-JJ] transaction.
The Remote Read Dispatcher can re-assign a Read Request initiating the Assign Remote Read
[RAD-YY] transaction.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
14
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
X.1.1.3 Remote Read Performer
415
The Remote Read Performer is responsible for accepting/refusing the Read Request received
from a Remote Read Dispatcher initiating the Accept/Reject Read [RAD-VV] transaction.
The Remote Read Performer is responsible for performing the Read as part of the Complete
Read [RAD-KK] transaction.
The Remote Read Performer is responsible for the fail of the Read process initiating the Fail
Read [RAD-XX] transaction.
420
The Remote Read Performer can produce and share additional clinical content (Preliminary
report, Addendum etc. ) initiating the transaction [RAD-WW] Update Content.
X.1.1.4 Workflow Monitor
425
430
The Workflow Monitor Actor tracks/monitors the evolution of the workflow. Required
Groupings for the Workflow Monitor are defined in Section X.3. These grouped actors support
transactions that enable the Workflow Monitor to track the status of workflow tasks in this
profile.
The Workflow Monitor shall be capable of reporting on the status of workflow tasks. The
format, contents and analysis in such reports are not defined by IHE. Such details should be
worked out as part of the product design. Possibilities include display, processing, printing,
export, etc.
X.2 XRR-WD Actor Options
Options that may be selected for each actor in this profile, if any, are listed in the TableX.2-1
along with the actors to which they apply. Dependencies between options when applicable are
specified in notes.
435
Table X.2-1: XRR-WD - Actors and Options
Actor
Option Name
TF Volume and
Section
Remote Read Requester
XDS Option1
RAD TF-1:X.2.1
Remote Read Performer
XDS Option1
RAD TF-1:X.2.1
Remote Read Dispatcher
XDS Option1
RAD TF-1:X.2.1
1
RAD TF-1:X.2.1
Workflow Monitor
XDS Option
Note 1: All the actors involved in this profile shall support at least the XDS Environment Option.
Note 2: Options for other environments are expected to be added in the future.
440
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
15
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
X.2.1 XDS Option
445
If actors involved in the Remote Read Workflow support this option, they shall be grouped with
actors in the Cross-Enterprise Document Sharing (XDS.b) and Multi-Patient Query (MPQ)
Profiles to perform the sharing of the Workflow Document (groupings are defined in Section
X.3). If an actor supports this option all the documents produced and/or shared within the
workflow shall be submitted to an XDS Document Repository and registered in the XDS
Document Registry of reference for the XDS Affinity Domain.
X.3 XRR-WD Required Actor Groupings
450
455
460
465
An actor from this profile (Column 1) must implement all of the required transactions and/or
content modules in this profile in addition to all of the transactions required for the grouped
actor (Column 2). If this is a content profile, and actors from this profile are grouped with actors
from a workflow or transport profile, “content bindings” required by the transport profile may be
defined to describe how data from the content module is mapped into data elements from the
workflow or transport transactions.
In some cases, required groupings are defined as at least one of an enumerated set of possible
actors; this is designated by merging column one into a single cell spanning multiple potential
grouped actors. Notes are used to highlight this situation.
XRR-WD actors shall be grouped with XDW actors to support the creation, consumption and
update of the XDW workflow document. This allows the workflow definition actors, at any point
in the workflow to access the most current status of the workflow and share the tasks performed
with all other workflow definition actors.
XRR-WD actors shall be grouped with Document Metadata Subscription (DSUB) actors to
enable an interoperable system for task status update notification. DSUB infrastructure is
intended to provide specific notifications to the participants of the Remote Read workflow when
an XDS.b environment is the XDW infrastructure for workflow sharing infrastructure.
Section X.5 describes some optional groupings that may be of interest for security considerations
and Section X.6 describes some optional groupings in other related profiles.
Table X.3-1: XRR-WD Required Actor Groupings
WRR-WD Actor
Remote Read Requester
Actor to be
grouped with
TF Volume and
Section
Content
Bindings
Reference
XDW Content
Creator
ITI TF-1: 30.1.1
ITI TF-3:5.4
XDW Content
Updater
ITI TF-1: 30.1.3
ITI TF-3:5.4
XDW Content
Consumer
ITI TF-1: 30.1.2
ITI TF-3:5.4
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
16
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
WRR-WD Actor
Remote Read Dispatcher
Remote Read Performer
Actor to be
grouped with
TF Volume and
Section
Content
Bindings
Reference
XDS.b Document
Source
ITI TF-1: 10.1.1.1
--
XDS.b Document
Consumer
ITI TF-1: 10.1.1.2
--
DSUB Document
Metadata Subscriber
ITI TF-1: 26.1.1.2
--
DSUB Notification
Recipient
ITI TF-1: 26.1.1.4
--
XDS-I.b Imaging
Document Consumer
RAD TF-1: 18
--
XDW Content
Updater
ITI TF-1: 30.1.3
ITI TF-3:5.4
XDW Content
Consumer
ITI TF-1: 30.1.2
ITI TF-3:5.4
XDS Document
Source
ITI TF-1: 10.1.1.1
--
XDS.b Document
Consumer
ITI TF-1: 10.1.1.2
--
DSUB Document
Metadata Subscriber
ITI TF-1: 26.1.1.2
--
DSUB Notification
Recipient
ITI TF-1: 26.1.1.4
--
MPQ Document
Consumer
ITI TF-1: 25.1
--
XDW Content
Updater
ITI TF-1: 30.1.3
ITI TF-3:5.4
XDW Content
Consumer
ITI TF-1: 30.1.2
ITI TF-3:5.4
XDS.b Document
Source
ITI TF-1: 10.1.1.1
--
XDS Document
Consumer
ITI TF-1: 10.1.1.2
--
DSUB Document
Metadata Subscriber
ITI TF-1: 26.1.1.2
--
DSUB Notification
Recipient
ITI TF-1: 26.1.1.4
--
XDS-I.b Imaging
Document Consumer
RAD TF-1: 18
--
XDS-I.b Imaging
Document Source
RAD TF-1: 18
--
MPQ Document
Consumer
ITI TF-1: 25.1
--
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
17
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
WRR-WD Actor
Workflow Monitor
Actor to be
grouped with
TF Volume and
Section
Content
Bindings
Reference
DSUB Document
Metadata Subscriber
ITI TF-1: 26.1.1.2
--
DSUB Notification
Recipient
ITI TF-1: 26.1.1.4
--
XDW Content
Consumer
ITI TF-1: 30.1.2
ITI TF-3:5
MPQ Document
Consumer
ITI TF-1: 25.1
--
470
X.4 XRR-WD Overview
Cross-Enterprise Remote Read Workflow Definition Profile is a Workflow Definition profile for
Remote Reading Workflow, which builds upon the ITI Cross-Enterprise Document Workflow
(XDW) Profile to manage the workflow between facilities performing the workflow tasks.
475
Remote Reading Workflow is the practice of having medical images interpreted (read) by a
reading specialist who is not present at the site where the image study was acquired and is not
reporting using the local PACS and dictation system at the acquiring site. More specifically, the
reading specialist is being asked to read an exam from another organization with a separate
Hospital Information System, Radiology Information System and PACS.
480
X.4.1 Concepts
X.4.1.1 Collaboration Group
XRR-WD focuses on technical aspects to enable Remote Reading. Deployments also need to
address the business relationship, including the business rules associated with the Remote Read
process. These are out-of-scope to for this profile; however, the basic concept is described here.
485
490
The Collaboration Group is a group of legal entities bound by a business agreement to request
and perform radiology reads. The content of this agreement may vary based on regional
regulations and institutional policies. This activity is left to the coordinating activities of the
Collaboration Group.
As part of the collaboration agreement, the entities involved could share additional services other
than the actual read. Those services are out of scope for this profile.
X.4.1.2 Workflow Stakeholders
The Workflow Stakeholder is an abstraction of the systems and users involved in the Remote
Read process. They can be identified, based on their roles in the process. Each of the Workflow
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
18
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
495
Stakeholders have specific rights and duties in the process. They drive the process from one step
to another, performing determinate actions on the workflow.
Workflow Stakeholder
Definition
Attending Physician
Physician who oversees the care of the patient.
Technologist
Qualified Individual to perform an imaging procedure.
Referring Physician
Physician who referred the patient for the imaging procedure. Note that this could be
the attending physician.
Imaging Facility
Facility where clinical imaging procedures are performed to create the remote exams.
This healthcare facility initiates and completes the cross-enterprise read for an imaging
study.
Reading Facility
Facility where the cross-enterprise read of the remote exams are read.
Image Share Service
Services managed on behalf of a healthcare community for the purpose of exchanging
clinical records and workflow collaboration. This includes workflow dispatch and
monitoring related to imaging.
Radiologist
A clinical physician who is credentialed to read clinical images per local regulations.
X.4.1.3 Remote Read Documents
This section describes the Documents and other objects involved in the Remote Read process.
500
The Remote Read process includes the following objects:
Document Types
Definition
Final Report
The clinical imaging report signed by a credentialed Radiologist.
Preliminary Report
The clinical imaging report, which may be provided in advance of a Final Report.
Image Manifest
Document identifying the image set that is subject of the Read Request
Image Set
Clinical images referenced in the Image Manifest.
Read Request
Request for a Radiologist to perform a clinical read of images acquired for a Requested
Procedure.
Relevant Clinical
Documents
Any Clinical Document deemed to be relevant for the remote read. This may include the
original Referral or a supporting Laboratory Report, as examples. It may include Image
Manifests and image reports of prior image studies
Relevant Images
Image Manifests and image reports of prior image studies that are considered relevant
for the read process.
X.4.1.4 XDW Workflow Definition Profile representation
505
The Cross-Enterprise Remote Read Workflow manages the Remote Read process. This XRRWD Profile is built upon the ITI XDW Profile for this purpose.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
19
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
A Workflow Document manages each Cross-Enterprise Remote Read and the steps in the
workflow are modeled in tasks within a Workflow Document as represented in Figure X.4.1.4-1
and outlined below. Section X.4.2.1.2 describes how XRR-WD actors use transactions to
exchange the Workflow Document as these tasks are added and updated.
510
•
Request Remote Read task: This task represents submission of a new Read Request.
The Remote Read Requester creates a new Workflow Document to represent the Read
Request. It adds the Request Remote Read task to the Workflow document, specifying
the reading task to be performed and providing the references to images (Image Manifest)
and relevant clinical documents.
515
•
520
•
See Table X.4.1.4-1 for status values and input and output documents for the Request
Remote Read task.
•
See RAD TF-3: 3.QQ.4.1.2.1 for the Workflow Document content specification
created by the Remote Read Requester.
Dispatch Remote Read task: This task represents assigning a read request to a Read
Performer.
The Remote Read Dispatcher assigns the Read Request by completing the Dispatch
Remote Read task in the Workflow Document.
525
•
530
•
See Table X.4.1.4-1 for status values and input documents for the Dispatch Remote
Read task.
•
See RAD TF-3: 3.YY.4.1.2.1 for the Workflow Document content specification
updated by the Remote Read Dispatcher.
Perform Remote Read task: This task represents the activities of the Read Performer
after assigned a Read Request.
The Read Performer first accepts, or optionally claims the assignment of the Read
Request before processing the Read Request by updating the Perform Remote Read task
in the Workflow Document. The Read Performer then processes the Read Request. The
final, intermediate or updated Report (Image Report) and any evidence documents as
output of this task are referenced.
•
See Table X.4.1.4-1 for status values and input and output documents for the Perform
Remote Read task.
•
See RAD TF-3: 3.VV.4.1.2.1 for the Workflow Document content specification
updated by the Read Performer for accepting the Remote Read.
•
See RAD TF-3: 3.WW.4.1.2.1 for the Workflow Document content specification
updated by the Read Performer for providing intermediate or updated report and any
evidence documents.
535
540
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
20
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
•
•
Complete Remote Read task: The Remote Read Requester accepts the Final Report and
completes the Workflow.
•
The Remote Read Requester accepts the Final Report and processes the completion of the
Remote Read.
545
550
555
See RAD TF-3: 3.KK.4.1.2.1 for the Workflow Document content specification
updated by the Read Performer for providing final report and any evidence
documents.
•
See Table X.4.1.4-1 for status values and input and output documents for the
Complete Remote Read task.
•
See RAD TF-3: 3.ZZ.4.1.2.1 for the Workflow Document content specification
updated by the Read Requestor for accepting the Final Report and completes the
Workflow.
Figure X.4.1.4-1: Workflow Tasks for the Remote Read process
The XRR-WD process flow, including the task states/status is shown in Figure X.4.1.4-2.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
21
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
560
Figure X.4.1.4-2: Cross-Enterprise Remote Read Workflow Definition complete process
flow
Table X.4.1.4-1 lists the various documents that may be referenced as either input or output
documents for each workflow task/status pair defined by the XRR-WD Profile.
565
The values used in the Optionality column are defined as follows:
R: Required. Compliant XDS Document Source Actors shall provide the document as
referenced.
RE: Required if present.
570
C: Conditional. Compliant XDS Document Source Actors shall provide the document referenced
if the document is available.
O: Optional. Compliant XDS Document Source Actors may choose to provide the document
reference.
N/A: Not Applicable.
575
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
22
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Table X.4.1.4-1: Tasks/Status/Documents related to the Cross-Enterprise Remote Read
process
Workflow
Task
Request
Remote
Read
Dispatch
Remote
Read
Perform
Remote
Read
Task Status
COMPLETED
Input
Documents
Optionality
Output Documents
Optionality
Read Request
R
Image Manifest
R
Relevant
Clinical
Document
RE
Relevant
Manifest
RE
Previous Read
Process
Reference
C (R if this is a
“Read Over
Read” )
FAILED
N/A
-
-
READY
N/A
-
N/A
-
IN-PROGRESS
N/A
-
N/A
-
COMPLETED
Image Manifest
R
N/A
-
Read Request
R
FAILED
N/A
-
READY
Read Request
R
Image Manifest
R
Relevant
Clinical
Document
RE
Relevant
Manifest
RE
IN-PROGRESS
N/A
COMPLETED
N/A
-
-
Preliminary Report
O
N/A
-
Final Image Report
R
FAILED
N/A
-
N/A
EXITED
N/A
N/A
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
23
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Workflow
Task
Complete
Remote
Read
Task Status
Input
Documents
Optionality
Output Documents
Optionality
COMPLETE
Final Report
R
N/A
-
IN_PROGRESS
Final Report
O
N/A
-
FAILED
N/A
-
N/A
X.4.1.5 Delivery of Notifications
XRR-WD actors are grouped with actors in the DSUB Profile to enable sending notifications
about workflow status updates.
585
The following sections describe how DSUB subscriptions should be used in the context of the
Remote Read workflow by actors involved in the XRR-WD Profile. Other uses of DSUB filters
for subscriptions are not forbidden.
X.4.1.5.1 Workflow Status Update Notification for the Read Requester
590
Once a Remote Read Request is submitted, the Remote Read Requester may require notifications
of progress on the workflow.
The Remote Read Requester would create a subscription that identifies the specific Workflow
Instance Id as a filter parameter to create notifications for the Read Request workflow document
just submitted. This subscription would be submitted via transaction [ITI-52] Document
Metadata Subscribe with the following parameters:
595
•
TerminationTime = unspecified. To create a subscription without an expiration date/time;
•
topics = “ihe:FullDocumentEntry”. To receive notifications that convey the full
documentEntry metadata related to the Workflow Document published.
•
Subscription Filter = “urn:uuid:aa2332d0-f8fe-11e0-be50-0800200c9a66” (Subscriptions
for DocumentEntry metadata). To subscribe for documents published with specific
metadata.
•
$XDSDocumentEntryReferenceIdList filter = workflow Instance Id.
600
This subscription ensures that Remote Read Requester is notified about any update to the
Workflow Document.
605
The Remote Read Requester can create additional subscriptions, for example for the specific
Accession Number related to the patient. This allows the Remote Read Requester to be notified
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
24
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
about additional documents created or modified with the associated accession number for this
patient. The Remote Read Requester may integrate these updates to their local workflow process.
X.4.1.5.2 Read Request Workflow Task Creation Notification to the Read
Dispatcher
610
615
620
The Remote Read Dispatcher requires a notification about the availability of a new Read Request
Workflow to process. In order to do that, once configured, the Remote Read Dispatcher creates a
subscription via [ITI-52] Document Metadata Subscribe transaction, characterized by the
following parameters:
•
TerminationTime = unspecified. To create a subscription without an expiration date/time;
•
topics = “ihe:FullDocumentEntry”. To receive notifications that convey the full
documentEntry metadata related to the Workflow Document published.
•
Subscription Filter = “urn:uuid:742790e0-aba6-43d6-9f1f-e43ed9790b79” (PatientIndependent Subscriptions for Document metadata). To subscribe for document
characterized by specific metadata.
•
$XDSDocumentEntryTypeCode = XRR-WD. To create notification for each Remote
Read Workflow Document published.
•
$XDSDocumentEntryEventCodeList = Dispatch Read Ready OR Read Request Failed
OR Perform Read Exited (see RAD TF:3 Table 1.3-1 for details about these values). This
allows the Read Dispatcher to be notified for Read Request completed or aborted and/or
Read Request that need to be reassigned.
625
X.4.1.5.3 Read Request Workflow Task Availability/Assignment Notification
630
The Remote Read Dispatcher routes availability and assignment of read requests to the Remote
Read Performers qualified to perform the requested read. The Workflow Document updated by
the Read Dispatcher is published identifying the Read Performer as intended recipient for the
submission (using the intendedRecipient submissionSet metadata). The Read Performer, once
configured, shall create a subscription characterized by the following parameters.
•
TerminationTime = unspecified. This allows to create a subscription without an
expiration date/time;
•
topics = “ihe:SubmissionSetMetadata”. This allows receiving notifications that convey
the submissionSet metadata, related to a submission of documents targeted to the Read
Performer itself.
•
Subscription Filter = “urn:uuid:868cad3d-ec09-4565-b66c-1be10d034399” (PatientIndependent Subscriptions for SubmissionSet metadata). This allows subscribing for
submissions intended to a specific recipient.
635
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
25
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
640
645
•
$XDSSubmissionSetIntendedRecipient = the Read Performer. It is out of scope for this
profile to define how to identify the Read Performer. This should be defined by local
policies and by Affinity Domain configurations.
The Read Performer Read Performer is notified when a Remote Read Dispatcher identifies the
Remote Read Performer as intended recipient in the submission of the Remote Read Workflow
Document. The Read Performer integrates this request to its local workflow process.
X.4.1.5.4 Referring/Attending Physician Report and Critical Findings Availability
Notification
650
The Referring Physician and Attending Physician (if different) may request notification of the
availability for when the image report, whether preliminary or final is available. It may also
include a priority to signify that the report includes critical findings and requires urgent attention.
The Remote Read Requester would create a related subscription with the following parameters:
•
TerminationTime = unspecified. This allows to create a subscription without an
expiration date/time;
•
topics = “ihe:FullDocumentEntry”. This allows receiving notifications that convey the
full documentEntry metadata related to the Workflow Document published.
•
Subscription Filter = “urn:uuid:aa2332d0-f8fe-11e0-be50-0800200c9a66” (Subscriptions
for DocumentEntry metadata). This allows to subscribe for documents published with
specific metadata.
•
$XDSDocumentEntryReferenceIdList filter = workflow Instance Id.
•
ConsumerReference = The attending/referring physician. It is out of scope for this profile
the definition of how the Remote Requester can discover the SOAP address associated to
the Notification Recipient of reference for the Attending/Referring doctor.
655
660
665
Other subscriptions based on the Accession Number as the filter parameters can be created for
similar purposes. In that case any Image Read Report document created by the Remote Read
Performer for the patient with the associated Accession Number will result in the creation and
delivery of a notification to the Referring Physician and Attending Physician (if different).
X.4.1.5.5 Workflow Notification Pull
670
As an alternative method for a Workflow Definition actor receiving workflow notifications,
which is also grouped with the Document Metadata Subscriber, may also be grouped with the
Notification Puller. This would enable the capability for this actor to query for notifications in
addition to receiving the notifications (Pull-style approach vs. Push-style approach for
notification delivery).
X.4.2 Use Cases
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
26
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
X.4.2.1 Use Case #1: Basic Remote Read Process
675
This use-case describes a basic Remote Read Process in a cross-enterprise environment. In this
use-case an Imaging Facility, which performs imaging procedures, does not have credentialed
Radiologists to read performed image studies after hours. However this facility participate in a
community (HIE) in which other enterprises share Imaging Read services.
X.4.2.1.1 Basic Remote Read Process Use Case Description
680
685
690
695
An example of the common workflow pathway that best illustrates the basic process enabled by
the XRR-WD is afterhours reading. This is where an Imaging Facility which performs imaging
procedures does not have credentialed Radiologists to read performed image studies after hours.
For this example, the Northern Community Hospital (NCH) has an Imaging Facility, which
performs imaging procedures on patients after 5:00 PM. There is an attending physician
requesting the imaging procedures performed by a qualified Technologist. However, after hours,
the site’s Reading Facility lacks the credentialed Radiologists to perform the read.
Capital Health Alliance (CHA) is a community Health Information Exchange. The charter of this
exchange is to provide the infrastructure and services for the purpose of sharing clinical patient
records among its members. The members of this cooperative are clinical institutions and
facilities, which provide patient care in this community. CHA includes the infrastructure and
services for sharing image studies between its members. The services include reading workload
sharing of images.
NCH is a member of CHA. NCH has a business agreement with CHA to share clinical images
with its members. It also has a business agreement with a collaboration group within CHA to
share reading workload.
Greater City Hospital (GCH) has a Reading Facility with credentialed Radiologists who perform
reading of radiographic images. It is a member of the CHA Health Information Exchange. It
participates in the image sharing services. This group has a business agreement to provide,
pending staff availability, reading workload sharing of radiographic images.
700
1. This use case is initiated by a patient arriving at the Northern Community Hospital
referred for a CT head scan. The CT Technologist preps the patient, performs and
completes the scan.
2. The workflow to have this Image Study remotely read is conducted in the following
steps:
705
Create Read Request:
Once the scan is complete, the relevant clinical information is gathered and the read request is
created. This read request should include:
•
Scan procedure and protocol
•
CT Technologist
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
27
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
710
715
•
Attending Physician
•
Referring Physician (note that Attending and Referring Physician may be the same)
•
Urgency
•
Collaboration Group
•
Sub-specialty required
•
Preliminary Read Request, if needed
Attached with the Read Request:
720
•
Image Manifest, referencing the images acquired
•
Referral, if available containing the reason for exam, patient history, requisition
•
Exam/Tech Notes, to include observations during the scan
Request Remote Read- completed and Dispatch Remote Read - ready:
The Read Request is submitted to the Capital Health Alliance (CHA) with NCH’s Remote Read
Requester software. This is notified to the cross-enterprise Dispatcher software of reference for
the CHA. The Dispatcher validates the read request.
725
Perform Remote Read- Ready and Dispatch Remote Read- completed (Dispatch Remote
Read Request to Read Performers):
The CHA Dispatcher, notifies Greater City Hospital, a Read Performer, based on Collaboration
Group’s business agreement of the available read request to perform.
Perform Remote Read-In Progress (Confirm Availability):
730
Greater City Hospital’s (GCH) Read Performer software receives the notification from the
Dispatcher software. Internally, it confirms that it has the available credentialed Radiology staff
to perform the read request. GCH’s Read Performer software notifies CHA’s X-Dispatcher that it
can perform the read. The Read Request Assignment is confirmed.
Perform Remote Read-InProgress (Preliminary Report):
735
740
GCH’s Read Performer Software, upon receipt of the assignment to the site, preps the reading
facility’s software systems for the read at the site. The prep process may include moving the
images into its local PACS and creating a local patient ID and local workitem with its own
accession number. The reading workflow is managed as if the study was acquired locally. The
Radiologist performs the remote read. While the Radiologist is performing the remote read,
additional evidence documents may be created, such as CAD reports or Key Image Notes or
Presentation States.
If Preliminary Report is requested in the Request Remote Read, then this Preliminary Report is
expected in advance to the Final Read. The Preliminary Report is to be provided to the Attending
Physician before the Final Report is provided.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
28
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Perform Remote Read-Completed (Final Report):
745
750
Upon completion of the read, the Radiologist submits a Final Report. If the Preliminary Report is
performed, the Final Report should include confirmation of the Preliminary Report. The Reading
Facility’s Read Performer software gathers the Final Report and other evidence Documents
created and submits it to the CHA HIE for distribution back to NCA’s Read Request Software.
All clinical content submitted will include the originating patient and procedure identifiers and
the original Accession tracking number.
Complete Read, Complete Imaging Study Procedure:
755
NCH’s Remote Read Requester software receives the final report and the relevant Evidence
Documents submitted by GCH. NCH completes the imaging procedure workflow. This may
include importing the evidence documents and Final Report into the local RIS/PACS. It may
include the business transactions to reimburse the Reading Facility for services rendered.
Once the Imaging Study Procedure is completed, the Read Request Workflow process is closed.
X.4.2.1.2 Basic Remote Read Process Flow
The following sequence of tasks within the workflow describes the typical process flow for the
Common Workflow scenario.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
29
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
760
Figure X.4.2.1.2-1: XRR-WD Basic process flow (1/2)
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
30
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Figure X.4.2.1.2-2: XRR-WD Basic process flow (2/2)
765
X.4.2.2 Use Case #2: Remote Read, Preliminary Urgent Read Request Scenario
This scenario describes the use-case in which the Remote Read Requester would start an Urgent
Remote Read process.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
31
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
X.4.2.2.1 Remote Read, Preliminary Urgent Read Request Scenario use-case
description
770
775
A Preliminary Urgent Read Request workflow pathway is where an Imaging Facility, which
performs imaging procedures has an urgent need for a Preliminary Report of the performed
image studies in advance of a Final Report. This pathway may be a trauma case read for an ER
department.
The Urgent Read Request pathway is a specialized scenario of the Common Workflow Scenario
described in Section X.4.1 with the following exceptions:
1. Emergency Department physician is the attending physician identified in the read request.
2. The Read Request includes an Urgency code of STAT and a request for a preliminary
read.
780
3. The Collaboration Group may be constrained to include only Read Performers capable of
handling Urgent Read Requests. The Remote Read Dispatcher shall identify only Read
Performers that are of this group.
4. The process is identified as critical by the Remote Read Performer system because it
interprets the high priority set by the Remote Read Requester.
785
5. A preliminary report is provided back to the Read Requestor and the attending physician
before a Final Report is created.
6. The Final report will be created as described in the Common Workflow Scenario process.
Note that reconciliation of the Preliminary Read with the Final Read will need to be done.
However, this would be considered part of the Perform Read process step.
X.4.2.3 Use Case #3: Remote Read, Sub-Specialty Read Request Scenario
790
This scenario describes the need to request a Read for a specific sub-specialty.
X.4.2.3.1 Remote Read, Sub-Specialty Read Request use-case description
A Sub-Specialty Read Request workflow pathway is the scenario where an imaging facility has a
need to request a Sub-specialist to perform the read.
795
800
The Sub-Specialty Request Remote Read pathway is a specialized scenario of the Common
Workflow Scenario described in Section X.4.1.4.1. To illustrate, as an example, a community
hospital has an Attending Physician who is providing the oversight of the Technologist
performing a Nuclear Medicine (NM) SPECT procedure. The Imaging Facility lacks a
credentialed NM Radiologist to read NM SPECT. A read by a credentialed NM Radiologist is
required. The pathway follows the Common Workflow Scenario with the following exceptions:
1. The Read Request identifies sub-specialty reader qualifications as NM Radiologist.
2. The Collaboration Group may be constrained to include only Remote Read Performers
with credentialed NM Radiologists.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
32
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3. The Remote Read Dispatcher assigns only to a Remote Read Performer, which has
credentialed NM Radiologist as members of their staff.
805
4. A credentialed NM Radiologist authors the Final Report.
X.4.2.4 Use Case 4#: Remote Read Over Read Consult Scenario
This use-case describes the scenario in which the Remote read Requester decides to request a
second Read of a Final Report.
X.4.2.4.1 Remote Read Over Read Consult use-case description
810
815
The Remote Read Over Read Consult Request pathway is the scenario where an imaging facility
has an imaging Report and needs to request an Over Read Consult. This is often done for
purposes of quality assurance. As an example, a requesting physician has a Final Report, but is
concerned regarding the quality. The pathway follows the Common Workflow Scenario
described in X.4.1.4.1 with the following exceptions:
1. The Read Request is identified by a specific type “Over Read”
2. The Request Remote Read task shall identify as input the previous Remote Read
Document. The original author of the initial Final Report is identified in the request.
820
3. The Remote Read Performer must ensure that the original author of the initial Final
Report does not perform this workitem. Note that a Read Performer may have several
Radiologist which may be credentialed to perform the Read task.
4. The over read consulting physician either agrees or disagrees with the original report’s
content. In the case of an agreement the second Remote Read author can either modify
the original Report adding a new additional ‘Verifying Observer’ or can create a new
Final Report. In the case of a disagreement, a discrepancy report is generated.
825
X.4.2.5 Use case 5#: Remote Read, Request Cancellation
This use-case describes the need to cancel a Pending Read Request, because the Request is no
longer valid.
X.4.2.5.1 Remote Read, Request Cancellation use-case description
830
The Remote Read, Request Cancellation is the pathway scenario where a requesting imaging
facility has a need to cancel a request because the Read is no longer needed (for example,
because the Read Request was made wrongly, or the read can be completed within the Imaging
Facility).
In this case the Remote Read Requester shall update the Workflow Document moving into status
FAILED the Request Remote Read task and closing the workflow itself.
835
This update is notified to all the participants of the workflow. After the closure a CrossEnterprise Remote Read Workflow Document cannot be updated by any participant.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
33
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
X.4.2.5.2 Remote Read, Request Cancellation process flow
Figure X.4.2.6.2-1: Request Cancellation Process flow
840
X.4.2.6 Use case 6#: Production of an Addendum
This use-case describes the scenario in which the Remote Read Performer produces an
Addendum to the Final Report after the acceptance of the Final Report by the Remote Read
Requester.
845
X.4.2.6.1 Production of an Addendum use-case description
If the Remote Read Performer needs to communicate the production of an Addendum to the
Remote Read Requester, the Remote Read Performer retrieves the CLOSED workflow document
and updates it adding the reference to the Addendum as output to the Perform Remote Read task.
The status of the Perform Remote Read task is unchanged.
850
This update is notified to the Remote Read Requester, that can subsequently retrieve the
Addendum from the XDS sharing infrastructure.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
34
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
X.4.2.6.2 Production of an Addendum process flow
X.4.2.7 Use case 7# Remote Read, Assign Cancellation
855
This use-case describe the scenario in which the Remote Read Dispatcher wants to revoke the
assignment of a task that can or cannot be already claimed
X.4.2.7.1 Remote Read, Assign Cancellation use case description
860
The HIE Remote Read Dispatcher system, is configured to revoke task assigned to Remote Read
Performer systems that have not accomplish their activities within six working hours form their
assignment (E.g., the Great Community Hospital has network problems and after the claiming
the Remote Read Performer could not communicate the completion of the Read). The Remote
Read Dispatcher can revoke the assignment of the Perform Remote Read task at any time before
task completion. This actor can update the Perform Remote Read task moving it into status
EXITED.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
35
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
865
The revoke requires that the Dispatch Remote Read task will be moved into status
IN_PROGRESS before the Remote Read Dispatcher assigns the Read process to another Remote
Read Performer.
The Remote Read Dispatcher could assign the read to a new Remote Read Performer if needed.
870
(Note: Local policies could further constrain the set of workflow statuses that allows the Remote
Read Dispatcher to revoke the assignment of a Perform Remote Read task)
X.4.2.7.2 Remote Read, Assign Cancellation process-flow
X.4.2.8 Use case 8# Open-Assignment
875
This use-case describes the scenario in which the Remote Read Performer can directly query for
pending Read Request that can be taken in charge.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
36
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
X.4.2.8.1 Open-Assignment use case description
880
When the Remote Read Requester starts a remote read process, the Workflow Document and the
pending Read Request are submitted to the sharing infrastructure via [RAD-XX] Submit Read
Request transaction. The Remote Read Performer members of the collaboration group can
periodically access Pending Read Requests using a Multiple Patient Query, or it could be
notified via DSUB notification. If a Remote Read Performer discovers a Read Request that can
be taken in charge, it starts a [RAD-HH] Claim a Read transaction. Since this time the Remote
Read process is assigned to the Remote Read Performer and follows the normal process flow.
X.4.2.8.2 Open-Assignment process-flow
885
Figure X.4.7.2-1: Open-Assignment process flow
X.4.2.9 Use case 9# Open-Assignment and race-condition
890
This use-case describes the scenario in which a Remote Read Performer can directly query for
pending Read Requests but when it tries to claim a Read Request, it gets an error because the
same Read Request has been already claimed by another Remote Read Performer.
X.4.2.9.1 Open-Assignment and race-condition use case description
895
When the Remote Read Requester starts a remote read process, the Workflow Document and the
pending Read Request are submitted to the sharing infrastructure via [RAD-XX] Submit Read
Request transaction. A Remote Read Performer can be notified for pending Read Requests in
many different ways (e.g., via DSUB notification if it subscribed for those documents). When a
Remote Read Performer member of the collaboration group is notified for the creation of a new
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
37
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
900
905
Remote Read workflow, it could discover all the information related to the Request, using an
[ITI-18] Registry Stored Query transaction. The same Read Request can be examined by many
different Remote Read Performers at the same time. When a Remote Read Performer wants to
claim the Read Request examined, it starts a [RAD-HH] Claim a Read transaction. In some
cases, a second Remote Read Performer can try to claim the same Read Request after the first
one using a [RAD-HH] Claim a Read transaction. This second transaction occurs in an error. In
this case the Remote Read Performer can perform a new query to discover the updated status of
the workflow. Starting form this time the Remote Read process is assigned to the first Remote
Read Performer and follows the normal process flow.
X.4.2.9.2 Open-Assignment and race-condition process-flow
Figure X.4.2.9.2-1: Open-Assignment and race-condition process flow
910
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
38
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
X.5 XRR-WD Security Considerations
915
920
This profile relies on XDW workflow management infrastructure and on XDS.b document
sharing platform. In accordance to those dependencies implementers should take in consideration
security considerations related to those profile (refer to the ITI TF-1: 30.5 and ITI TF-1: 10.7).
This profile does not define additional audit constraints for workflow events, because the Remote
Read Workflow Document defined in XRR-WD tracks clinical/administrative events related to
the workflow itself. In case of failure conditions, reasons for the failure are tracked inside a
comment section of the specific task of the Workflow Document that originates the failure (see
section 3.XX.4.1.2.1.1.1 for technical details).
This profile has some special security considerations beyond the considerations that would apply
to any XDS deployment. Some of these issues are:
•
Issues of cross-border law, contract, data protection, etc. may arise. IHE cannot profile or
predict exactly how these will affect technical details. The transactions in this profile
make use of ATNA for machine authentication, communications protection, and event
logging. Machine authentication acts as a proxy for many legal considerations. By
establishing the identity of the machines involved, the applicable laws, contracts can be
established so that appropriate security rules are followed. This will have significant
policy implications for the security rules engines that will need to be part of both risk
assessment and policy determination.
930
•
Some actors, such as the Reader, are likely to be members of multiple affinity domains
when independent organizations share the services of a common remote reading
organization. The IHE recommendations for setting up an affinity domain assume that
actors are members of only one domain. Some actors that comply with this profile will
need additional capabilities to support membership in multiple affinity domains.
935
•
All of the actors in this profile must have create and update permission for the registry
and repository involved. This introduces responsibility to maintain authentication and
authorization relationships between multiple organizations. If a reading organization
terminates an employee, it will be necessary to inform the security and authorization
services of all the different affinity domains involved.
940
•
Security and audit logs will have more complex management relationships because each
of the different affinity domains will be interested in different aspects of these security
logs.
•
Event management, breach management, change notification, and other security related
activities will be of potential interest to multiple affinity domains. Corrective action taken
by an actor in multiple affinity domains affects all of the affinity domains and must be
properly coordinated with all of the affinity domains.
925
945
All of the security considerations associated with membership in an affinity domain and with the
underlying ITI transactions also apply.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
39
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
X.6 XRR-WD Cross Profile Considerations
950
955
960
This section identifies some relationships between this profile and other profiles. These
dependencies shall not be considered additional requirements for Actors involved in the CrossEnterprise Remote Read workflow.
The Document Metadata Subscription Profile (DSUB) does provide a notification platform that
supports the pull-style approach in accessing notification content. This is recommended for
certain fault conditions where notifications may not be reliably received by the Remote Read
Dispatcher. To avoid loss of information, the Remote Read Dispatcher should be able to Pull
workflow documents of interest. This can be done via two mechanisms:
•
Multi-Patient Stored Query [ITI-51], to obtain documents of interest;
•
Pull-style approach for notifications, that makes the DSUB notification delivery
mechanism reliable;
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
40
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Appendices
Appendix A - Actor Summary Definitions
965
Actor
Definition
Remote Read Requester
Submits a read request
Remote Read Dispatcher
Dispatches a read request
Remote Read Performer
Executes a read
Workflow Monitor
Monitors the evolution of a workflow
Appendix B - Transaction Summary Definitions
Transaction
Definition
[RAD-QQ] Submit Read Request
Submits the Workflow Document that initiate the read workflow
[RAD-XX] Fail a Read
Closes the read workflow with a failure condition
[RAD-ZZ] Acknowledge Read Completion
Tracks the result of the acknowledge for Final Report publication
[RAD-KK] Complete Read
Tracks the publishing of the Final Report
[RAD-VV] Accept/Reject Read
Claims a remote read pre-assigned
[RAD-HH] Claim a Read
Claims an open-assigned remote read
[RAD-WW] Update Content
Updates content of a Perform Remote Read task
[RAD-YY] Assign Read Request
Assigns a Read Request to a Remote Read Performer
[RAD-JJ] Revoke Assigned Read
Revokes the assignment of a Perform Remote Read task
Glossary
970
No new terms
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
41
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Volume 2 – Transactions
Add Section 3.Y
975
3.QQ Submit Read Request [RAD-QQ]
3.QQ.1 Scope
The Submit Read Request transaction passes a Read Request Submission Request from a
Remote Read Requester to start a remote read process.
A Submit Read Request transaction carries:
980
•
•
•
•
985
Metadata describing one or more new documents
Within metadata, one XDSDocumentEntry object per document
Submission Set definition along with the linkage to new documents and references to
existing documents
Two or more documents
3.QQ.2 Actor Roles
Actor:
Remote Read Requester
Role:
Submits the Read Request documents with associated metadata to a Document
Repository
Actor(s): Document Repository
Role:
Receives and stores the Workflow Document
3.QQ.3 Referenced Standards
990
XDS.b (Cross-Enterprise Document Sharing): For a list of the standards for the underlying
Provide and Register Document Set-b [ITI-41] transaction, see ITI TF-2b: 3.41.3.
XDW (Cross-Enterprise Document Workflow): For requirements and standards related to the
Remote Read Workflow Document, see ITI TF-1:20 and ITI TF-3:4.5.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
42
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3.QQ.4 Interaction Diagram
995
3.QQ.4.1 Submit Read Request
This message initiates the Remote Read workflow by sharing the Remote Read Workflow
Document and Read Request Document with the Document Repository.
3.QQ.4.1.1 Trigger Events
1000
The Remote Read Requester sends this message when it is ready to initiate the Remote Read
process and has acquired and collected all the information needed.
The information needed is:
•
Read Request Document: the request for a Radiologist to perform a clinical read of
images acquired for a Requested Procedure.
•
Image Manifest: a document identifying the image set that is the subject of the Read
Request.
•
Image Report: If the Read process is classified as a “Read Over the Read” by the
Remote Read Requester.
•
Final Report: If the Remote Read process is preceded by a Read process not
managed/tracked by a Remote Read Workflow Document.
1005
1010
3.QQ.4.1.2 Message Semantics
This message is a Provide and Register Document Set-b Request message. This message shall
comply with the message semantics defined for the Provide and Register Document Set-b
Request message in ITI TF-2b: 3.41.4.1.2. The Remote Read Requester is the Document Source.
This section also defines:
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
43
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1015
•
the Remote Read Workflow Document Content submitted in the Provide and Register.
(see Section 3.QQ.4.1.2.1)
•
the Read Request Document submitted in the Provide and Register (see Section
3.QQ.4.1.2.2)
•
the Document Sharing Metadata requirements for the Submission Set and Document
Entry (see Section 3.QQ.4.1.2.3)
1020
This specification does not require that all the documents referenced as input or output
documents within the Workflow Document are included in the same submissionSet.
3.QQ.4.1.2.1 Remote Read Workflow Document Content Requirements
1025
The Remote Read Requester initiates the workflow by creating a new Remote Read Workflow
Document.
3.QQ.4.1.2.1.1 Workflow Document Elements
The Remote Read Requester shall create a new Remote Read Workflow Document according to
the definition of an XDW Workflow Document in ITI TF-3: 5.4 with the following constraints:
1030
•
<workflowStatus> shall be set to “OPEN”
•
<workflowDefinitionReference> shall be set to “1.2.3.4.5.6.7.8.9.0”
•
for <TaskList> constraints see Section 3.QQ.4.1.2.1.1.1
3.QQ.4.1.2.1.1.1 Workflow Document TaskList Element
This element shall be structured according to ITI TF-3:5.4.2.3 “XDW Workflow Document
Elements from the OASIS Human Task,” with the additional constraints specified below.
1035
1040
The Remote Read Requester shall put in the <TaskList> element:
•
A required <XDWTask> child element that represents the Request Remote Read task
(see Section 3.QQ.4.1.2.1.1.1.1).
•
Optionally an additional <XDWTask> child element that represents the Dispatch
Remote Read task just activated. This task shall be added to the TaskList if the
Remote Read Requester wants to start a Read process mediated by a Remote Read
Dispatcher (see Section 3.QQ.4.1.2.1.1.1.2).
Further requirements are defined in the next sections.
3.QQ.4.1.2.1.1.1.1 XDWTask “Request Remote Read”
1045
The <XDWTask> sub element <taskDetails> describes the Request Remote Read task
details:
The <taskType> child element shall have the value “Request Remote Read”
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
44
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
The <status> child element shall have value “COMPLETED”.
1050
The Remote Read Requester shall set the value of the element
taskData/taskDetails/priority based on the urgency of the Read Request
referenced. The following mapping represents the default value set for priority; however, local
policies/settings may define more fine-grain values:
1055
•
“1”: Emergency (equivalent to “1” HL7 2 v2 priorityCode)
•
“5”: Urgent (equivalent to “2” HL7 v2 priorityCode)
•
“9”: Elective (equivalent to “3” HL7 v2 priorityCode)
Note: priority values “0” and “10” are left to local use/definition
The Remote Read Requester may set the value of additional elements that characterize the nature
and the execution of the Read Requested:
1060
1065
•
taskData/taskDetails/expirationTime: this elements allows the Remote Read Requester to
specify a date/time by which the Read needs to be completed
•
taskData/taskDetails/notificationRecipients: this elements identifies user/organization
that needs to be notified. If this element has one or more values, the same
user/organization shall be identified as SubmissionSet.intendedRecipient for the
submission that will result in the publication of the Workflow Document itself.
The element <XDWTask> shall have a child element taskData/input/part for each
input document referenced. The documents referenced as input are listed below. Further details
about attachment encoding within taskData/input/part are specified ITI TF-3: Table
5.4.3-9 AttachmentInfo Element):
1070
•
part/@name=”ImageManifest”: (1..1) this is a required input that identifies the Image
Manifest of the images that can be. This reference shall be present.
•
part/@name =”ReadRequest”: (1..1) this is a required input that identifies the Read
Request Document. See Section 3.QQ 4.1.2.2.
•
part/@name =”ClinicalDocuments”: (0..N) this is an optional and repeatable input that
identifies relevant Clinical Document(s).
•
part/@name =”relevantImageManifest”: (0..N) this is an optional and repeatable input
that identifies relevant Image Manifest(s) that are not object of the Read.
•
part/@name =”previousRead” (0..1) conditional: this attachment shall be present if the
Read started is a “Read Over the Read” that identifies the Final Report produced as
output of the previous Read process.
1075
2
HL7 is the registered trademark of Health Level Seven International.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
45
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1080
The element <XDWTask> shall have the child element taskEventHistory/taskEvent.
characterized by <status> = “COMPLETED”. Further requirements for the
taskEventHistory child element are specified at ITI TF-3: Table 5.4.3-11.
3.QQ.4.1.2.1.1.1.2 XDWTask “Dispatch Remote Read”
1085
If the Remote Read Requester dispatches the Request Remote Read task above, it shall also add
a <XDWTask> element with a <taskDetails> that describes the Dispatch Remove Read
task details:
The <taskType> child element shall have the value “Dispatch Remote Read”.
The <status> child element shall be “READY”.
3.QQ.4.1.2.2 Read Request Content Requirements
1090
This document shall contain the content of the original imaging service request. This
specification does not mandate any specific structure for this document. It is the responsibility of
the Collaboration Group (RAD TF-1: X.4.4.1) to define the structure and content of the Read
Request document.
3.QQ.4.1.2.3 Document Sharing Metadata requirements
1095
Document metadata for this transaction shall comply with the requirements in ITI TF-3:4
“Metadata used in Document Sharing Profiles”.
This section specifies additional Document Sharing Metadata requirements for the both the Read
Request Workflow Document and for the Read Request document.
The DocumentEntry metadata of the Remote Read Workflow Document shall meet the
following constraints:
1100
•
The eventCodeList metadata attribute is used to document the current status of the
workflow and the status of task(s) within the workflow. This enables queries or DSUB
notifications about status based on the values in eventCodeList:
•
A single entry of eventCodeList shall convey the actual status (OPEN) of the
workflow: code = “urn:ihe:iti:xdw:2011:eventCode:open” codingScheme=”
1.3.6.1.4.1.19376.1.2.3”.
•
A single entry of the eventCodeList shall convey the actual status of the Request
Remote Read task: code=”urn:ihe:rad:xrrwd:2015:eventCodeTaskStatus:RequestReadCompleted”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”.
•
The eventCodeList shall be used to convey Acquisition Modality and Anatomic
Region in accordance with Metadata requirements defined in RAD TF-3: Table
4.68.4.1.2.3-1.
1105
1110
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
46
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
•
1115
•
The practiceSettingsCode metadata shall provide the high-level imaging specialty;
•
The referenceIdList metadata shall provide the accession number in accordance with
RAD TF-3: Table 4.68.4.1.2.3-1.
•
1120
The intendedRecipient metadata may contain the identifier of the organization, group of
people or organizations, or the person intended to execute the Read.
The DocumentEntry metadata of the Read Request document shall meet the following
constraints:
•
1130
The typeCode shall convey the following code: “XRR-WD” codingScheme:
1.2.3.4.5.6.7.8.9.0.
The SubmissionSet metadata of the Remote Read Workflow Document shall meet the
following constraints:
•
1125
The eventCodeList shall be used to convey the Procedure Code Sequence
(0008,1032) of the performed procedure.
A single entry of eventCodeList metadata shall convey the type of the Read just
requested. The value shall be one of:
•
If the Read requested does not have specific workflow requirements, code:
“urn:ihe:rad:xrr-wd:2015:normalRead” ,codingScheme=”1.3.6.1.4.1.19376.1.2.1”.
•
If the Remote Read Requester is asking for a Read over the Read, code:
“urn:ihe:rad:xrr-wd:2015:readOverRead” codingScheme=”1.3.6.1.4.1.19376.1.2.1”.
3.QQ.4.2 Provide and Register Document set-b Response
This specification does not add additional requirements for the Provide and Register Document
Set-b Response message defined in ITI TF-2b:3.41.4.2.
1135
3.QQ.4.2.1 Trigger Events
See ITI TF-2b:3.41.4.2.1.
3.QQ.4.2.2 Message Semantics
See ITI TF-2b:3.41.4.2.2.
3.QQ.4.2.3 Expected Actions
1140
See ITI TF-2b:3.41.4.2.3.
In addition to the Expected Actions defined for the Provide and Register Document Set-b
Response message, when the Document Repository sends a Response of Success (see ITI TF-3:
4.2.4.2), the Remote Read Requester shall use the workflowInstanceId associated with the
workflow for subsequent subscriptions or queries.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
47
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1145
If an error is generated by the Document Repository, that error should be managed by the
Remote Read Requester in accordance with local defined behaviors, and in accordance with
XDW actor behaviors (race condition) defined in ITI TF-3: 5.4.5.1
3.QQ.5 Security Considerations
See ITI TF-2b:3.41.5.
1150
3.QQ.5.1 Security Audit Considerations
See ITI TF-2b:3.41.5.1.
3.YY Assign Remote Read [RAD-YY]
3.YY.1 Scope
1155
This transaction records the result of assignment in a Workflow Document. The result can be an
assignment to a specific Read Performer or the fail of that assignment.
3.YY.2 Actor Roles
Actor:
Remote Read Dispatcher
Role:
Identifies a Remote Read Performer that can execute the read and updates the
Workflow Document accordingly.
Actor:
Document Repository
Role:
Receives and stores Workflow Document updates
3.YY.3 Referenced Standards
1160
XDS.b (Cross-Enterprise Document Sharing): For a list of the standards for the underlying
Provide and Register Document Set-b [ITI-41] transaction, see ITI TF-2b: 3.41.3.
XDW (Cross-Enterprise Document Workflow): For requirements and standards related to the
Remote Read Workflow Document, see ITI TF-1:20 and ITI TF-3:4.5.
3.YY.4 Interaction Diagram
1165
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
48
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3.YY.4.1 Submit Dispatch
This message records the result of an assignment of a Remote Read process.
1170
3.YY.4.1.1 Trigger Events
The Remote Read Dispatcher sends this message when it learns of Read Requests ready to be
dispatched. The mechanism to learn this is not defined by this transaction (e.g., via notification
or by pulling the Remote Read Workflow Document).
1175
The Remote Read Dispatcher sends this message only if the Read Request is “pending”, either it
has just been created or a previous dispatch is failed/skipped and it has been dispatched again.
This means that the Remote Read Dispatcher shall be able to identify a group of Remote Read
Performers able to complete the Read, but rules for assignment are out of scope for this
specification, and should be locally defined by domain policies.
This message can be triggered by:
1180
1. a Dispatch Remote Read task is activated the Remote Read Requester;
OR
2. a previous assignment is revoked by a Remote Read Dispatcher;
OR
3. an assignment is rejected by a Remote Read Performer
1185
The pre-conditions are encoded as:
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
49
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1190
1195
1200
1205
1. The Dispatch Remote Read task is activated
(WorkflowDocument/workflowStatus=”OPEN”) and
(WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/sta
tus=”READY” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Dispatch Remote Read”)
2. A previous assignment is revoked by the Remote Read Dispatcher
(WorkflowDocument/workflowStatus=”OPEN”) and
(WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”IN_PROGRESS” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Dispatch Remote Read”)
3. The previous assignment is rejected by the Remote Read Performer
(WorkflowDocument/workflowStatus=”OPEN”) and each Perform Remote read
task is “EXITED”
(WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”EXITED” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Perform Remote Read”)
3.YY.4.1.2 Message Semantics
This message is a Provide and Register Document Set-b Request. This message shall comply
with the message semantics defined for the Provide and Register Document Set-b Request
message ITI TF-2b:3.41.4.1.2. The Remote Read Dispatcher is the Document Source.
This section also defines:
1210
•
Remote Read Workflow Document Content.
•
Document Sharing Metadata requirements.
3.YY.4.1.2.1 Remote Read Workflow Document Content Requirements
The Remote Read Workflow Document is updated by the Remote Read Dispatcher.
3.YY.4.1.2.1.1 Workflow Document Elements
1215
The Remote Read Requester shall update the Remote Read Workflow Document according to
the definition of an XDW Workflow Document in ITI TF-3: 5.4 with the following constraints:
•
for <TaskList> constraints see Section 3.YY.4.1.2.1.1.1
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
50
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3.YY.4.1.2.1.1.1 Workflow Document TaskList Element
1220
This element shall be structured according to ITI TF-3:5.4.2.3 “XDW Workflow Document
Elements from the OASIS Human Task,” with the additional constraints in Sections
3.YY.4.1.2.1.1 and 3.YY.4.1.2.1.1.2 .
3.YY.4.1.2.1.1.1.1 XDWTask “Dispatch Remote Read”
If the Remote Read Dispatcher is able to identify a Remote Read Performer to be assigned:
•
It shall add a new “Perform Remote Read” task as a <XDWTask> child element of the
<TaskList> element
•
It shall add a <taskEvent> element within the Dispatch Remote Read task to record
the result of the assignment.
•
the <XDWTask> child element “Dispatch Remote Read” shall have a <status> child
element with value “COMPLETED”.
1225
1230
1235
If the Remote Read Dispatcher is not able to identify a Remote Read Performer to be assigned:
•
It shall add a <taskEvent> element within the Dispatch Remote Read task to record
the result of the assignment.
•
The <XDWTask> child element “Dispatch Remote Read” shall have a <status> child
element with value “EXITED”.
3.YY.4.1.2.1.1.1.2 XDWTask “Perform Remote Read”
The <XDWTask> child element “Perform Remote Read” shall have a <status> child element
with value “READY”.
1240
1245
The Remote Read Dispatcher shall set the value of the <priority> element based on the
urgency of the Read Request referenced or based on other domain policies (e.g., if this is not the
first assignment, it could be reasonable to force a higher priority for the process instead of the
one specified by the Remote Read Requester). The following mapping represents the default
value set for priority:
•
“1”: Emergency (equivalent to HL7 v2 priorityCode “1”)
•
“5”: Urgent (equivalent to HL7 v2 priorityCode “2”)
•
“9”: Elective (equivalent to HL7 v2 priorityCode “3”)
Note: priority values “0” and “10” and intermediate priorities between 1, 5 and 9 are left to local
policies/definition
The Remote Read Dispatcher shall specify the identified Remote Read Performer in the
<potentialOwners> element:
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
51
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1250
1255
•
The Remote Read Dispatcher shall specify the Remote Read Performer identified as a
“notificationRecipient” for the task:
•
1260
taskData/taskDetails/potentialOwners: this element allows to “reserve” the task for a
Remote Read Performer. A Remote Read Performer can be a user or a group of users (see
OASIS WS-HumanTask standards for further details). Only the identified Remote Read
Performer can claim the task. This transaction does not define how to identify a Remote
Read Performer.
taskData/taskDetails/notificationRecipients: this element specifies user/organization that
needs to be notified.
The Remote Read Dispatcher could set the value of additional elements that characterize the
nature and the execution of the Read:
•
taskData/taskDetails/expirationTime: this element specifies a date/time by which the
Read needs to be completed
3.YY.4.1.2.2 Document Sharing Metadata requirements
1265
Document metadata for this transaction shall comply with the requirements in ITI TF-3:4
“Metadata used in Document Sharing Profiles”.
This section specifies additional Document Sharing Metadata requirements for the Read Request
Workflow Document.
The DocumentEntry metadata of the Remote Read Workflow Document shall meet the
following constraints:
1270
•
The eventCodeList metadata attribute is used to document the current status of the
workflow and the status of task(s) within the workflow. This enables queries or DSUB
notifications about status based on the values in eventCodeList:
•
A single entry of eventCodeList metadata shall convey the status (OPEN) of the
workflow: code = “urn:ihe:iti:xdw:2011:eventCode:open” codingScheme=”
1.3.6.1.4.1.19376.1.2.3”
•
A single entry of the eventCodeList metadata shall convey the status of the Perform
Remote Read task: code=”urn:ihe:rad:xrrwd:2015:eventCodeTaskStatus:PerformReadReady”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
1275
1280
OR
A single entry of the eventCodeList metadata shall convey the actual status of the
Dispatch Remote Read task if the assignment cannot be completed:
code=”urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:DispatchReadExited”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
52
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1285
The SubmissionSet metadata of the Remote Read Workflow Document shall meet the
following constraints:
•
1290
The intendedRecipient metadata contain the identifier of the organization, group of
people or organizations, or the person intended to execute the Read. This metadata shall
convey the same users/organizations identified within the Workflow Document in the
<notificationRecipients> element of the Perform Remote Read task
3.YY.4.1.3 Expected Actions
The Document Repository shall process the Provide and Register Document Set-b Request
message as described in ITI TF-2b:3.41.4.1.3.
3.YY.4.2 Provide and Register Document set-b Response
1295
This specification does not add additional requirements for the Provide and Register Document
Set-b Response message defined in ITI TF-2b:3.41.4.2.
3.YY.4.2.1 Trigger Events
See ITI TF-2b:3.41.4.2.1.
3.YY.4.2.2 Message Semantics
1300
See ITI TF-2b:3.41.4.2.2.
3.YY.4.2.3 Expected Actions
See ITI TF-2b:3.41.4.2.3.
1305
In addition to the Expected Actions defined for the Provide and Register Document Set-b
Response message, when the Document Repository sends a Response of Success (See ITI TF-3:
4.2.4.2) the Remote Read Dispatcher shall use the workflowInstanceId associated with the
workflow for subsequent subscriptions or queries.
If an error is generated by the Document Repository, that error should be managed by the
Remote Read Dispatcher in accordance with local defined behaviors, and in accordance with
XDW actor behaviors (race condition) defined in ITI TF-3: 5.4.5.1
1310
3.YY.5 Security Considerations
See ITI TF-2b:3.41.5.
3.YY.5.1 Security Audit Considerations
See ITI TF-2b:3.41.5.1.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
53
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3.VV Accept/Reject or Release Assignment [RAD-VV]
1315
3.VV.1 Scope
This transaction allows a Remote Read Performer to accept or reject the assignment of a Remote
Read. This transaction also allows a Remote Read Performer that claimed a Remote Read to
release it.
3.VV.2 Actor Roles
1320
Actor:
Remote Read Performer
Role:
Accepts or rejects the assignment of a Remote Read. It can also release a claimed
Remote Read.
Actor:
Document Repository
Role:
Receives and stores the Workflow Document
3.VV.3 Referenced Standards
XDS.b (Cross-Enterprise Document Sharing): For a list of the standards for the underlying
Provide and Register Document Set-b [ITI-41] transaction, see ITI TF-2b: 3.41.3.
1325
XDW (Cross-Enterprise Document Workflow): For requirements and standards related to the
Remote Read Workflow Document, see ITI TF-1:20 and ITI TF-3:4.5.
3.VV.4 Interaction Diagram
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
54
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1330
3.VV.4.1 Submit Assignment
This message accept/rejects the assignment or releases the claimed Read.
3.VV.4.1.1 Trigger Events
1335
The Remote Read Performer sends this message when it learns that a Perform Remote Read task
has been assigned to itself. The mechanism to learn this is not defined by this transaction (e.g.,
via notification or by pulling the Remote Read Workflow Document).
The Remote Read Performer shall send this message if:
1. the Remote Read Dispatcher has assigned a Perform Remote Read task to it.
2. the Remote Read Performer wants to release a Read process previously claimed.
The pre-conditions are encoded as:
1340
•
the Perform Remote Read task is assigned to the Remote Read Performer if the workflow
document is open: WorkflowDocument/workflowStatus=”OPEN” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”READY” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Perform Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/pote
ntialOwners=Remote Read Performer.
•
Or the Perform Remote Read task has been claimed (but not completed) by the Remote
Read Performer if the workflow document is open
(WorkflowDocument/workflowStatus=”OPEN”) and
1345
1350
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
55
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”IN_PROGRESS” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Perform Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/actu
alOwner=Remote Read Performer
1355
Note: this transaction does not define a method for identifying Remote Read Performers.
3.VV.4.1.2 Message Semantics
1360
This message is a Provide and Register Document Set-b Request message. This message shall
comply with the message semantics defined for the Provide and Register Document Set-b
Request message in ITI TF-2b:3.41.4.1.2. The Remote Read Performer is the Document Source.
This section also defines:
1365
•
Remote Read Workflow Document Content.
•
Document Sharing Metadata requirements.
3.VV.4.1.2.1 Remote Read Workflow Document Content Requirements
The Remote Read Workflow Document is updated by the Remote Read Performer.
3.VV.4.1.2.1.1 Workflow Document Elements
The Remote Read Perform shall update the Remote Read Workflow Document according to the
definition of an XDW Workflow Document in ITI TF-3: 5.4
1370
This transaction does not require the creation of new tasks within the Workflow Document;
however, it requires the Remote Read Performer to add a new taskEvent in the Perform
Remote Read task. See Section 3.VV.4.1.2.1.1.1.
3.VV.4.1.2.1.1.1 XDWTask “Perform Remote Read”
1375
If the Remote Read Performer is accepting the assignment of the Read, a new <taskEvent>
(characterized by: status=IN_PROGRESS, eventType=”start”) shall be added to the
<taskEventHistory> element.
If the Remote Read Performer is rejecting the assignment of the Read, a new <taskEvent>
(characterized by: status=EXITED, eventType=”skip”) shall be added to the
<taskEventHistory> element.
1380
If the Remote Read Performer is releasing a Read that has already been claimed, a new
<taskEvent> (characterized by: status=EXITED, eventType=”skip”) shall be added to the
<taskEventHistory> element.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
56
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3.VV.4.1.2.2 Document Sharing Metadata requirements
1385
Document metadata for this transaction shall comply with the requirements in ITI TF-3:4
“Metadata used in Document Sharing Profiles”.
This section specifies additional Document Sharing Metadata requirements for the Read Request
Workflow Document.
The DocumentEntry metadata of the Read Request Workflow Document shall meet the
following constraints:
1390
•
The eventCodeList metadata attribute is used to document the current status of the
workflow and the status of task(s) within the workflow. This enables queries or DSUB
notifications about status based on the values in eventCodeList:
•
A single entry of eventCodeList metadata shall convey the current status (OPEN) of the
workflow: code = “urn:ihe:iti:xdw:2011:eventCode:open” codingScheme=”
1.3.6.1.4.1.19376.1.2.3”
•
A single entry of the eventCodeList metadata shall convey the current status of the
Perform Remote Read task. The value shall be one of:
1395
1400
•
code=”urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:PerformReadExited”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
•
code=”urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:PerformReadInprogress”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
3.VV.4.1.3 Expected Actions
The Document Repository shall process the Provide and Register Document Set-b Request
message as described in ITI TF-2b:3.41.4.1.3.
1405
3.VV.4.2 Provide and Register Document set-b Response
This specification does not add additional requirements for the Provide and Register Document
Set-b Response message defined in ITI TF-2b:3.41.4.2.
3.VV.4.2.1 Trigger Events
See ITI TF-2b:3.41.4.2.1.
1410
3.VV.4.2.2 Message Semantics
See ITI TF-2b:3.41.4.2.2
3.VV.4.2.3 Expected Actions
See ITI TF-2b:3.41.4.2.3.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
57
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1415
1420
In addition to the Expected Actions defined for the Provide and Register Document Set-b
Response message, when the Document Repository sends a Response of Success (See ITI TF-3:
4.2.4.2) the Remote Read Performer shall use the workflowInstanceId associated with the
workflow for subsequent subscriptions or queries.
If an error is generated by the Document Repository, that error should be managed by the
Remote Read Performer in accordance with local defined behaviors, and in accordance with
XDW actor behaviors (race condition) defined in ITI TF-3: 5.4.5.1
3.VV.5 Security Considerations
See ITI TF-2b:3.41.5.
3.VV.5.1 Security Audit Considerations
See ITI TF-2b:3.41.5.1.
1425
3.KK Complete Remote Read [RAD-KK]
3.KK.1 Scope
This transaction marks the Perform Remote Read task as completed with the reference to the
Final Report produced, and document inputs used.
3.KK.2 Actor Roles
1430
Actor:
Remote Read Performer
Role:
Sets the Perform Remote Read task status to completed
Actor:
Document Repository
Role:
Receives and stores documents provided
3.KK.3 Referenced Standards
XDS.b (Cross-Enterprise Document Sharing): For a list of the standards for the underlying
Provide and Register Document Set-b [ITI-41] transaction, see ITI TF-2b: 3.41.3.
1435
XDW (Cross-Enterprise Document Workflow): For requirements and standards related to the
Remote Read Workflow Document, see ITI TF-1:20 and ITI TF-3:4.5.
3.KK.4 Interaction Diagram
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
58
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1440
3.KK.4.1 Submit Read Completion
This message allows the Remote Read Performer that has claimed the Perform Remote Read task
to mark that task as completed.
3.KK.4.1.1 Trigger Events
1445
The Remote Read Performer send this message when the Remote Read Performer completes the
Perform Remote Read task.
The Remote Read Performer can send this message if:
1. The Remote Read Performer completed a claimed Read process and the Final Report is
available.
The pre-condition is encoded as:
1450
1455
1. A Perform Remote Read task is already claimed by the Remote Read Performer
WorkflowDocument/workflowStatus=”OPEN” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”IN_PROGRESS” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Perform Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/actu
alOwner=Remote Read Performer.
Note: this transaction does not define a system of identification of Remote Read Performers.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
59
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3.KK.4.1.2 Message Semantics
1460
This message is a Provide and Register Document Set-b Request message. This message shall
comply with the message semantics defined for the Provide and Register Document Set-b
Request message ITI TF-2b:3.41.4.1.2. The Remote Read Performer is the Document Source.
This section also defines:
1465
•
Remote Read Workflow Document Content.
•
Final Report Content
•
Document Sharing Metadata requirements
3.KK.4.1.2.1 Remote Read Workflow Document Content Requirements
The Remote Read Workflow Document is updated by the Remote Read Performer.
1470
This transaction does not require the creation of new tasks within the Workflow Document;
however, it requires the Remote Read Performer to add of a new taskEvent in the Perform
Remote Read task (see Section 3.KK.4.1.2.1.1.1).
3.KK.4.1.2.1.1 Workflow Document Elements
The Remote Read Perform shall update the Remote Read Workflow Document according to the
definition of an XDW Workflow Document in ITI TF-3: 5.4
1475
3.KK.4.1.2.1.1.1 XDWTask “Perform Remote Read”
The Remote Read Performer shall add a new <taskEvent> (characterized by:
status=COMPLETED, eventType=”complete”) to the <taskEventHistory> element.
The Remote Read Performer shall update the element <XDWTask> to have a child element
taskData/output/part where:
1480
•
part/@name =”FinalReport” (1..1) required output that identifies the Final Report
produced
3.KK.4.1.2.2 Final Report Content Requirements
The Final Report document may be in any format.
It may be structured in accordance with the XDS-I.b Profile (RAD TF-3:4.68.4.1.2.2).
1485
3.KK.4.1.2.3 Document Sharing Metadata requirements
Document metadata for this transaction shall comply with the requirements in ITI TF-3:4
“Metadata used in Document Sharing Profiles”.
This section specifies additional Document Sharing Metadata requirements for the Read Request
Workflow Document.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
60
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1490
1495
1500
1505
The DocumentEntry metadata of the Remote Read Workflow Document shall meet the
following constraints:
•
The eventCodeList metadata attribute is used to document the current status of the
workflow and the status of task(s) within the workflow. This enables queries or DSUB
notifications about status based on the values in eventCodeList:
•
A single entry of eventCodeList metadata shall convey the status of the workflow. The
value shall be: code = “urn:ihe:iti:xdw:2011:eventCode:open”
codingScheme=”1.3.6.1.4.1.19376.1.2.3”
•
A single entry of the eventCodeList metadata shall convey the status of the task that was
changed. The value shall be: code=”urn:ihe:rad:xrrwd:2015:eventCodeTaskStatus:PerformReadCompleted”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
This transaction does not define document sharing metadata requirements for the Final Report
document. The Final Report document may be included in the same Submission Set as the
Remote Read Request Workflow Document in this transaction ([RAD-KK] Complete remote
Read) or in a different Submission Set using a [ITI-41] Provide and Register Document Set-b
transaction.
3.KK.4.1.3 Expected Actions
The Document Repository shall process the Provide and Register Document Set-b Request
message as described in ITI TF-2b:3.41.4.1.3.
1510
3.KK.4.2 Provide and Register Document set-b Response
This specification does not add additional requirements for the Provide and Register Document
Set-b Response message defined in ITI TF-2b:3.41.4.2.
3.KK.4.2.1 Trigger Events
See ITI TF-2b:3.41.4.2.1.
1515
3.KK.4.2.2 Message Semantics
See ITI TF-2b:3.41.4.2.2.
3.KK.4.2.3 Expected Actions
See ITI TF-2b:3.41.4.2.3.
1520
If an error is generated by the Document Repository, that error should be managed by the
Remote Read Performer in accordance with local defined behaviors, and with accordance to
XDW actor behaviors (race condition) defined in ITI TF-3: 5.4.5.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
61
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3.KK.5 Security Considerations
See ITI TF-2b:3.41.5.
3.KK.5.1 Security Audit Considerations
1525
See ITI TF-2b:3.41.5.1.
3.ZZ Acknowledge Read Completion [RAD-ZZ]
3.ZZ.1 Scope
This transaction acknowledges the production of a Final Report or requests the revision of a
Final Report.
1530
3.ZZ.2 Actor Roles
Actor:
Remote Read Requester
Role:
Acknowledges production or revision of a Final Report.
Actor:
Document Repository
Role:
Receives and stores the Workflow Document
3.ZZ.3 Referenced Standards
1535
XDS.b (Cross-Enterprise Document Sharing): For a list of the standards for the underlying
Provide and Register Document Set-b [ITI-41] transaction, see ITI TF-2b: 3.41.3.
XDW (Cross-Enterprise Document Workflow): For requirements and standards related to the
Remote Read Workflow Document, see ITI TF-1:20 and ITI TF-3:4.5.
3.ZZ.4 Interaction Diagram
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
62
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1540
3.ZZ.4.1 Submit Ack
This message allows the Remote Read Requester that starts the Remote Read process to
acknowledge the production of a Final Report or to ask for a revision to a Report.
3.ZZ.4.1.1 Trigger Events
1545
The Remote Read Requester sends this message after it learns that a Final Report is completed or
has been revised. The mechanism to learn this is not defined by this transaction (e.g., via
notification or by pulling the Remote Read Workflow Document).
The pre-conditions are encoded either as:
1.
1550
1555
(Final Report is initially created)
WorkflowDocument/workflowStatus=”OPEN” and
(WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Request Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/actu
alOwner=Remote Read Requester) and
(WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Perform Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”COMPLETED”)
OR
1560
2. (Final Report has been revised)
WorkflowDocument/workflowStatus=”OPEN”
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Request Remote Read” and
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
63
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/actu
alOwner=Remote Read Requester and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Complete Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”IN_PROGRESS”
1565
1570
Note: This transaction does not define how Remote Read Requesters or Remote Read Performers
are identified.
3.ZZ.4.1.2 Message Semantics
1575
This message is a Provide and Register Document Set-b Request message. This message shall
comply with the message semantics defined for the Provide and Register Document Set-b
Request message ITI TF-2b:3.41.4.1.2. The Remote Read Requester is the Document Source.
The Remote Read Requester will communicate one of three decisions: accept, reject, additional
action. The business logic used by the Remote Read Requester to make this decision is out of
scope for this transaction and should be agreed upon as Domain Policies.
This section also defines:
1580
•
Remote Read Workflow Document Content.
•
Document Sharing Metadata requirements
3.ZZ.4.1.2.1 Remote Read Workflow Document Content Requirements
The Remote Read Workflow Document is updated by the Remote Read Requester.
The Remote Read Requester shall update the <TaskList> to either:
1585
•
add a Complete Remote Read task to the Workflow Document, if that task is not present;
•
or create a new taskEvent within the Complete Remote Read task, if the Complete
Remote Read task is already present
3.ZZ.4.1.2.1.1 Workflow Document Elements
1590
The Remote Read Requester shall update the Remote Read Workflow Document according to
the definition of an XDW Workflow Document in ITI TF-3: 5.4 with the following constraints:
Accept Case:
The <workflowStatus> shall be set to “CLOSED”.
Reject Case:
The <workflowStatus> shall be set to “CLOSED”.
1595
Additional Action Case:
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
64
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
The <workflowStatus> shall remain “OPEN”.
For <TaskList> constraints see Section 3.YY.4.1.2.1.1.1
3.ZZ.4.1.2.1.1.1 XDWTask “Complete Remote Read”
Accept Case:
1600
The Remote Read Requester accepts the Final Report as complying with Domain Policies:
•
If the Complete Remote Read task is already present in the Workflow Document, the
Remote Read Requester shall add a new <taskEvent> element with status
“COMPLETED”.
•
If there is no Complete Remote Read task, the Remote Read Requester, shall add one to
the <TaskList> element. The <XDWTask> element shall have a
taskData/taskDetails/taskType child element with value “Complete Remote
Read” and a taskData/taskDetails/status child element with value
“COMPLETED”.
1605
Reject Case:
1610
The Remote Read Requester decides that it is unable to obtain a Final Report compliant with
Domain Policies from the Remote Read Performer:
•
If the Complete Remote Read task is already present in the Workflow Document, the
Remote Read Requester shall add a new <taskEvent> element with status “FAILED”.
•
If there is no Complete Remote Read task, the Remote Read Requester, shall add one to
the <TaskList> element. The <XDWTask> element shall have a
taskData/taskDetails/taskType child element with value “Complete Remote
Read” and a taskData/taskDetails/status child element with value
“FAILED”.
1615
1620
The Remote Read Requester shall populate taskData/comments child element of the
updated task with reasons for rejection.
Additional Action Case:
The Remote Read Requester decides that it needs additional action from the Remote Read
Performer to obtain a Final Report compliant with Domain Policies (e.g., revise the Final Report
produced, add a digital signature, etc.).
1625
•
If the Complete Remote Read task is already present in the Workflow Document, the
Remote Read Requester shall add a new <taskEvent> element with status
“IN_PROGRESS”.
•
If there is no Complete Remote Read task, the Remote Read Requester, shall add one to
the <TaskList> element. The <XDWTask> element shall have a
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
65
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1630
taskData/taskDetails/taskType child element with value “Complete Remote
Read” and a taskData/taskDetails/status child element with value
“IN_PROGRESS”.
The Remote Read Requester shall populate taskData/comments child element of the
updated task with the specific actions requested.
1635
3.ZZ.4.1.2.2 Document Sharing Metadata requirements
Document metadata for this transaction shall comply with the requirements in ITI TF-3:4
“Metadata used in Document Sharing Profiles”.
This section specifies additional Document Sharing Metadata requirements for the Read Request
Workflow Document.
1640
The DocumentEntry metadata of the Remote Read Workflow Document shall meet the
following constraints:
•
1645
The eventCodeList metadata attribute is used to document the current status of the
workflow and the status of task(s) within the workflow. This enables queries or DSUB
notifications about status based on the values in eventCodeList:
•
A single entry of eventCodeList metadata shall convey the status of the workflow in
accordance with the value of the <workflowStatus> element.
•
A single entry of the eventCodeList metadata shall convey the status of the Complete
Remote Read task. The value shall be one of:
•
code=”urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:CompleteReadCompleted”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
•
code=”urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:CompleteReadFailed”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
•
code=”urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:CompleteReadInprogress”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
1650
1655
3.ZZ.4.1.3 Expected Actions
The Document Repository shall process the Provide and Register Document Set-b Request
message as described in ITI TF-2b:3.41.4.1.3.
3.ZZ.4.2 Provide and Register Document set-b Response
1660
This specification does not add additional requirements for the Provide and Register Document
Set-b Response message defined in ITI TF-2b:3.41.4.2.
3.ZZ.4.2.1 Trigger Events
See ITI TF-2b:3.41.4.2.1
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
66
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3.ZZ.4.2.2 Message Semantics
See ITI TF-2b:3.41.4.2.2
1665
3.ZZ.4.2.3 Expected Actions
See ITI TF-2b:3.41.4.2.3.
If an error is generated by the Document Repository, that error should be managed by the
Remote Read Requester in accordance with local defined behaviors, and with accordance to
XDW actor behaviors (race condition) defined in ITI TF-3: 5.4.5.
1670
3.ZZ.5 Security Considerations
See ITI TF-2b:3.41.5.
3.ZZ.5.1 Security Audit Considerations
See ITI TF-2b:3.41.5.1.
3.XX Fail Read [RAD-XX]
1675
3.XX.1 Scope
This transaction cancels an ongoing Remote Read process.
3.XX.2 Actor Roles
Actors:
Remote Read Requester
Remote Read Performer
1680
Role:
Ends the Remote Read workflow with a Failure condition
Actor:
Document Repository
Role:
Receives and stores the Workflow Document
3.XX.3 Referenced Standards
XDS.b (Cross-Enterprise Document Sharing): For a list of the standards for the underlying
Provide and Register Document Set-b [ITI-41] transaction, see ITI TF-2b: 3.41.3.
XDW (Cross-Enterprise Document Workflow): For requirements and standards related to the
Remote Read Workflow Document, see ITI TF-1:20 and ITI TF-3:4.5.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
67
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1685
3.XX.4 Interaction Diagram
3.XX.4.1 Submit Fail
This message cancels a Remote Read workflow.
3.XX.4.1.1 Trigger Events
1690
The Remote Read Requester or Remote Read Performer wants to cancel a Remote Read
workflow.
The pre-conditions for the Remote Read Requester are encoded as:
1695
1700
WorkflowDocument/workflowStatus=”OPEN”
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/taskType=”
Request Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/actualOwn
er=Remote Read Requester and one of the following:
1. The remote read workflow has not been dispatched or claimed yet
count(WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/
taskType=”Perform Remote Read”)=0;
OR
1705
2. the Perform Remote Read task has been assigned but not claimed yet
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Perform Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”READY”
OR
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
68
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1710
1715
3. the Perform Remote Read task has been claimed but not completed yet
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Perform Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”IN_PROGRESS”
OR
4. the dispatching cannot be completed
(WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/tas
kType=”Dispatch Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”EXITED”)
OR
1720
5. all the Remote Read Performers have rejected the assigned read.
(WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/tas
kType=”Perform Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”EXITED”)
1725
The pre-conditions for the Remote Read Performer are encoded as:
1730
WorkflowDocument/workflowStatus=”OPEN”
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/taskType=”
Perform Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/actualOwn
er=Remote Read Performer and one of the following:
1735
1. the Perform Remote Read task has been claimed by the performer but not completed yet
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Perform Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”IN_PROGRESS”
OR
1740
2. the Perform Remote Read task has been completed but the Remote Read Requester is
asking for a revision of the Final Report
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Complete Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”IN_PROGRESS”.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
69
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3.XX.4.1.2 Message Semantics
1745
This message is a Provide and Register Document Set-b Request message. This message shall
comply with the message semantics defined for the Provide and Register Document Set-b
Request message ITI TF-2b:3.41.4.1.2. The Sender is the Document Source.
This section also defines:
1750
•
Content of Remote Read Workflow Document.
•
Document Sharing Metadata requirements.
3.XX.4.1.2.1 Remote Read Workflow Document Content Requirements
The Workflow Document is updated by the Remote Read Requester or the Remote Read
Performer Actor.
3.XX.4.1.2.1.1 Workflow Document Elements
<WorkflowStatus> shall be set to “CLOSED”.
1755
For <TaskList> constraints see Section 3.XX.4.1.2.1.1.1
3.XX.4.1.2.1.1.1 Workflow Document TaskList Element
This element shall be structured according to ITI TF-3:5.4.2.3 “XDW Workflow Document
Elements from the OASIS Human Task,” with the additional constraints specified below.
1760
The Remote Read Requester shall add a <taskEvent> element with status “FAILED” as child
element to the Request Remote Read <XDWTask> and add a child element
taskData/comments to record reasons for the failure.
The Remote Read Performer shall add a <taskEvent> element with status “FAILED” as child
element to the Perform Remote Read <XDWTask> and add a child element
taskData/comments to record reasons for the failure.
1765
3.XX.4.1.2.2 Document Sharing Metadata requirements
Document metadata for this transaction shall comply with the requirements in ITI TF-3:4
“Metadata used in Document Sharing Profiles”.
This section specifies additional Document Sharing Metadata requirements for the both the Read
Request Workflow Document and for the Read Request document.
1770
The DocumentEntry metadata of the Remote Read Workflow Document shall meet the
following constraints:
•
The eventCodeList metadata attribute is used to document the current status of the
workflow and the status of task(s) within the workflow. This enables queries or DSUB
notifications about status based on the values in eventCodeList:
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
70
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1775
1780
•
A single entry of eventCodeList metadata shall convey the status (CLOSED) of the
workflow: code = “urn:ihe:iti:xdw:2011:eventCode:closed” codingScheme=”
1.3.6.1.4.1.19376.1.2.3”
•
A single entry of the eventCodeList metadata shall convey the status of the updated
task. The value shall be one of:
•
code=”urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:RequestReadFailed”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
•
code=”urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:PerformReadFailed”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
3.XX.4.1.3 Expected Actions
1785
The Document Repository shall process the Provide and Register Document Set-b Request
message as described in ITI TF-2b:3.41.4.1.3.
3.XX.4.2 Provide and Register Document set-b Response
This specification does not add additional requirements for the Provide and Register Document
Set-b Response message defined in ITI TF-2b:3.41.4.2.
1790
3.XX.4.2.1 Trigger Events
See ITI TF-2b:3.41.4.2.1
3.XX.4.2.2 Message Semantics
See ITI TF-2b:3.41.4.2.2
3.XX.4.2.3 Expected Actions
1795
See ITI TF-2b:3.41.4.2.3.
If an error is generated by the Document Repository, that error should be managed by the Sender
in accordance with local defined behaviors, and with accordance to XDW actor behaviors (race
condition) defined in ITI TF-3: 5.4.5.
3.XX.5 Security Considerations
1800
3.XX.5.1 Security Audit Considerations
See ITI TF-2b:3.41.5.1.
3.JJ Revoke Assigned Read [RAD-JJ]
3.JJ.1 Scope
This transaction revokes the assignment of a Perform Remote Read task.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
71
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1805
3.JJ.2 Actor Roles
Actor:
Remote Read Dispatcher
Role:
Revokes the assignment of a Perform Remote Read task already assigned.
Actor:
Document Repository
Role:
Receives and stores the Workflow Document
3.JJ.3 Referenced Standards
1810
XDS.b (Cross-Enterprise Document Sharing): For a list of the standards for the underlying
Provide and Register Document Set-b [ITI-41] transaction, see ITI TF-2b: 3.41.3.
XDW (Cross-Enterprise Document Workflow): For requirements and standards related to the
Remote Read Workflow Document, see ITI TF-1:20 and ITI TF-3:4.5.
3.JJ.4 Interaction Diagram
1815
3.JJ.4.1 Submit Revoke
This message revokes the assignment of a Perform Remote Read task.
3.JJ.4.1.1 Trigger Events
The Remote Read Dispatcher sends this message when it decides to revoke an assigned Perform
Remote Read task. The business logic used by the Remote Read Dispatcher to make this decision
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
72
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1820
is out of scope for this transaction and should be agreed upon as Domain Policies (e.g., inactivity
time of the Performer, network issues related to the Performer, etc.).
A pre-condition is encoded as:
At least one “Perform Remote Read” task has already been assigned to a Remote Read
Performer but it has not been completed yet, which is encoded as:
1825
•
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Perform Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Status=”READY”.
OR
1830
•
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Perform Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Status=”IN_PROGRESS”.
3.JJ.4.1.2 Message Semantics
1835
This message is a Provide and Register Document Set-b Request. This message shall comply
with the message semantics defined for the Provide and Register Document Set-b Request
message ITI TF-2b:3.41.4.1.2. The Remote Read Dispatcher is the Document Source.
This section also defines:
1840
•
Remote Read Workflow Document Content.
•
Document Sharing Metadata requirements.
3.JJ.4.1.2.1 Remote Read Workflow Document Content Requirements
The Remote Read Workflow Document is updated by the Remote Read Dispatcher.
3.JJ.4.1.2.1.1 Workflow Document Elements
1845
The Remote Read Requester shall update the Remote Read Workflow Document according to
the definition of an XDW Workflow Document in ITI TF-3: 5.4 with the following constraints:
•
for <TaskList> constraints see Section 3.JJ.4.1.2.1.1.1
3.JJ.4.1.2.1.1.1 Workflow Document TaskList Element
The Remote Read Dispatcher shall:
•
1850
add a <taskEvent> element with status “EXITED” as child element to the “Perform
Remote Read” task.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
73
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
•
Add a <taskEvent> element with status “IN_PROGRESS” as child element to the
“Dispatch Remote Read” task.
3.JJ.4.1.2.2 Document Sharing Metadata requirements
1855
Document metadata for this transaction shall comply with the requirements in ITI TF-3:4
“Metadata used in Document Sharing Profiles”.
This section specifies additional Document Sharing Metadata requirements for the Read Request
Workflow Document.
The DocumentEntry metadata of the Remote Read Workflow Document shall meet the
following constraints:
1860
•
The eventCodeList metadata attribute is used to document the current status of the
workflow and the status of task(s) within the workflow. This enables queries or DSUB
notifications about status based on the values in eventCodeList:
•
A single entry of eventCodeList metadata shall convey the actual status (OPEN) of
the workflow: code = “urn:ihe:iti:xdw:2011:eventCode:open” codingScheme=”
1.3.6.1.4.1.19376.1.2.3”
•
A single entry of the eventCodeList metadata shall convey the actual status of the
Dispatch Remote Read task: code=”urn:ihe:rad:xrrwd:2015:eventCodeTaskStatus:DispatchReadInprogress”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
•
The status (“EXITED”) of the Perform Remote Read task shall not be conveyed
within an entry of the eventCodeList metadata.
1865
1870
3.JJ.4.1.3 Expected Actions
The Document Repository shall process the Provide and Register Document Set-b Request
message as described in ITI TF-2b:3.41.4.1.3.
1875
The mechanism to advise the previously assigned Remote Read Performer (e.g., via notification
or by pulling the Workflow Document) is not defined in this transaction.
3.JJ.4.2 Provide and Register Document set-b Response
This specification does not add additional requirements for the Provide and Register Document
Set-b Response message defined in ITI TF-2b:3.41.4.2.
1880
3.JJ.4.2.1 Trigger Events
See ITI TF-2b:3.41.4.2.1.
3.JJ.4.2.2 Message Semantics
See ITI TF-2b:3.41.4.2.2.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
74
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3.JJ.4.2.3 Expected Actions
1885
See ITI TF-2b:3.41.4.2.3.
If an error is generated by the Document Repository, that error should be managed by the
Remote Read Dispatcher in accordance with local defined behaviors, and in accordance with
XDW actor behaviors (race condition) defined in ITI TF-3: 5.4.5.1
3.JJ.5 Security Considerations
1890
See ITI TF-2b:3.41.5.
3.JJ.5.1 Security Audit Considerations
See ITI TF-2b:3.41.5.1.
3.HH Claim a Read [RAD-HH]
3.HH.1 Scope
1895
This transaction allows a Remote Read Performer to claim a Read without a previous
assignment.
3.HH.2 Actor Roles
1900
Actor:
Remote Read Performer
Role:
Claims a Remote Read request not pre-assigned.
Actor:
Document Repository
Role:
Receives and stores the Workflow Document
3.HH.3 Referenced Standards
XDS.b (Cross-Enterprise Document Sharing): For a list of the standards for the underlying
Provide and Register Document Set-b [ITI-41] transaction, see ITI TF-2b: 3.41.3.
XDW (Cross-Enterprise Document Workflow): For requirements and standards related to the
Remote Read Workflow Document, see ITI TF-1:20 and ITI TF-3:4.5.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
75
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1905
3.HH.4 Interaction Diagram
3.HH.4.1 Submit Open-Assignment Claim
This message allows a Remote Read Performer to create a Perform Remote Read task and claim
it.
1910
3.HH.4.1.1 Trigger Events
The Remote Read Performer sends this message when it decides to claim the remote read that is
not assigned.
1915
A remote read might not be assigned because the Remote Read Requester did not involve
Remote Read Dispatcher, or because the Remote Read Dispatcher is not able to complete the
Dispatch Remote Read task.
The mechanism to learn that a remote read is ready to be claimed is not defined here (e.g., via
notification or by pulling the Remote Read Workflow Document)
1920
A pre-condition is encoded as:
The Perform Remote Read task has not been assigned yet or the Dispatch Remote Read task is
exited.
•
1925
WorkflowDocument/workflowStatus=”OPEN” and
count(WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/
taskType=”Dispatch Remote Read”)=0 and
count(WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/
taskType=”Perform Remote Read”)=0;
OR
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
76
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
•
1930
1935
WorkflowDocument/workflowStatus=”OPEN” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Dispatch Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”EXITED” and
count(WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/
taskType=”Permote Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/stat
us=”IN_PROGRESS” or “COMPLETED”)=0
3.HH.4.1.2 Message Semantics
This message is a Provide and Register Document Set-b Request message. This message shall
comply with the message semantics defined for the Provide and Register Document Set-b
Request message ITI TF-2b:3.41.4.1.2. The Remote Read Performer is the Document Source.
1940
This section also defines:
•
Remote Read Workflow Document Content
•
Document Sharing Metadata requirements
3.HH.4.1.2.1 Remote Read Workflow Document Content Requirements
The Remote Read Workflow Document is updated by the Remote Read Performer.
1945
3.HH.4.1.2.1.1 Workflow Document Elements
The Remote Read Requester shall update the Remote Read Workflow Document according to
the definition of an XDW Workflow Document in ITI TF-3: 5.4 with the following constraints:
•
for <TaskList> constraints see Section 3.HH.4.1.2.1.1.1.
3.HH.4.1.2.1.1.1 Workflow Document TaskList Element
1950
The Remote Read Performer shall add a “Perform Remote Read” task (<XDWTask> element
with
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/taskType=”
Perform Remote Read”) in status “IN_PROGRESS”.
3.HH.4.1.2.2 Document Sharing Metadata requirements
1955
Document metadata for this transaction shall comply with the requirements in ITI TF-3:4
“Metadata used in Document Sharing Profiles”.
This section specifies additional Document Sharing Metadata requirements for the Read Request
Workflow Document.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
77
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1960
The DocumentEntry metadata of the Remote Read Workflow Document shall meet the
following constraints:
•
The eventCodeList metadata attribute is used to document the current status of the
workflow and the status of task(s) within the workflow. This enables queries or DSUB
notifications about status based on the values in eventCodeList:
•
A single entry of eventCodeList metadata shall convey the status (OPEN) of the
workflow: code = “urn:ihe:iti:xdw:2011:eventCode:open” codingScheme=”
1.3.6.1.4.1.19376.1.2.3”
•
A single entry of the eventCodeList metadata shall convey the status of the Perform
Remote Read task: code=”urn:ihe:rad:xrrwd:2015:eventCodeTaskStatus:PerformReadInprogress”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
1965
1970
3.HH.4.1.3 Expected Actions
The Document Repository shall process the Provide and Register Document Set-b Request
message as described in ITI TF-2b:3.41.4.1.3.
3.HH.4.2 Provide and Register Document set-b Response
1975
This specification does not add additional requirements for the Provide and Register Document
Set-b Response message defined in ITI TF-2b:3.41.4.2.
3.HH.4.2.1 Trigger Events
See ITI TF-2b:3.41.4.2.1
3.HH.4.2.2 Message Semantics
1980
See ITI TF-2b:3.41.4.2.2
3.HH.4.2.3 Expected Actions
See ITI TF-2b:3.41.4.2.3.
1985
If an error is generated by the Document Repository, that error should be managed by the
Remote Read Performer in accordance with local defined behaviors, and in accordance with
XDW actor behaviors (race condition) defined in ITI TF-3: 5.4.5.1
3.HH.5 Security Considerations
See ITI TF-2b:3.41.5.
3.HH.5.1 Security Audit Considerations
See ITI TF-2b:3.41.5.1.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
78
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
1990
3.WW Update Content [RAD-WW]
3.WW.1 Scope
This transaction makes update(s) to the Perform Remote Read task without changing the status
of the task (e.g., attach a Preliminary Report, attach an Addendum to the Final Report, etc. ).
1995
The Preliminary Report and the Addendum to the Final Report can be submitted by using this
transaction or by using an [ITI-41] Provide and Register Document Set-b transaction.
3.WW.2 Actor Roles
Actor:
Remote Read Performer
Role:
Updates the content of the Perform Remote Read task.
Actor:
Document Repository
Role:
Receives and stores the Workflow Document
3.WW.3 Referenced Standards
2000
XDS.b (Cross-Enterprise Document Sharing): For a list of the standards for the underlying
Provide and Register Document Set-b [ITI-41] transaction, see ITI TF-2b: 3.41.3.
XDW (Cross-Enterprise Document Workflow): For requirements and standards related to the
Remote Read Workflow Document, see ITI TF-1:20 and ITI TF-3:4.5.
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
79
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3.WW.4 Interaction Diagram
2005
3.WW.4.1 Update Task
This message tracks changes made to the Perform Remote Read task without changing the status
of the task (e.g., attach a Preliminary Report, attach an Addendum to the Final Report, etc. ).
3.WW.4.1.1 Trigger Events
2010
2015
The Remote Read Performer sends this message when it needs to:
•
Update the content of the Perform Remote Read task without changing the status of the
task or the status of the workflow
•
Attach new documents as input or output
•
Modify already attached documents
If the Remote Read Requester asks for additional actions, the Remote Read Performer may use
this transaction to make requested revisions.
The pre-conditions are encoded as:
The Perform Remote Read task is IN_PROGRESS or COMPLETED and the Remote Read
Performer is the actual owner, which is encoded as:
2020
•
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/actu
alOwner=Remote Read Performer and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Perform Remote Read” and
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
80
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Status=”IN_PROGRESS”
2025
OR
•
2030
2035
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/actu
alOwner=Remote Read Performer and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Type=”Perform Remote Read” and
WorkflowDocument/TaskList/XDWTask/taskData/taskDetails/task
Status=”COMPLETED”
Note the Remote Read Workflow Document may be “closed” if the Remote Read Performer is
providing an addendum to a Final Report that has already been acknowledged.
3.WW.4.1.2 Message Semantics
This message is a Provide and Register Document Set-b Request message. This message shall
comply with the message semantics defined for the Provide and Register Document Set-b
Request message ITI TF-2b:3.41.4.1.2. The Remote Read Performer is the Document Source.
2040
2045
This section also defines:
•
Documents Produced (Preliminary Report, Addendum to the Final Report, Remote Read
Workflow Document)
•
Content of the Documents submitted to the Document Repository
•
Remote Read Workflow Document Content
•
Document Sharing Metadata requirements
3.WW.4.1.2.1 Remote Read Workflow Document Content Requirements
The Remote Read Workflow Document is updated by the Remote Read Performer.
3.WW.4.1.2.1.1 Workflow Document Elements
2050
The Remote Read Requester shall update the Remote Read Workflow Document according to
the definition of an XDW Workflow Document in ITI TF-3: 5.4 with the following constraints:
•
The Remote Read Performer shall not change the value of <workflowStatus> status in
the Remote Read Workflow Document
•
for <TaskList> constraints see Section 3.WW.4.1.2.1.1.1
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
81
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
3.WW.4.1.2.1.1.1 Workflow Document TaskList Element
2055
If the Remote Read Performer needs to attach documents to the Perform Remote Read task, it
shall add to the element <XDWTask> one child element taskData/output/part for each
additional document.
If the attachment is a Preliminary Report: part/@name=”PreliminaryReport”.
2060
If the attachment is an Addendum to the Final Report:
part/@name=”AddendumToFinalReport”.
The Remote Read Performer may also update the Perform Remote Read task.
The Remote Read Performer shall not change the status of the Perform Remote Read task.
3.WW.4.1.2.2 Preliminary Report Content Requirements
The Preliminary Report document may be in any format.
2065
It may be structured in accordance with the XDS-I..b Profile (RAD TF-3: 4.68.4.1.2.2).
3.WW.4.1.2.3 Addendum Content Requirements
The Addendum to the Final Report document may be in any format.
It may be structured in accordance with the XDS-I.b Profile (RAD TF-3: 4.68.4.1.2.2).
3.WW.4.1.2.4 Document Sharing Metadata requirements
2070
Document metadata for this transaction shall comply with the requirements in ITI TF-3:4
“Metadata used in Document Sharing Profiles”.
This section specifies additional Document Sharing Metadata requirements for the Read Request
Workflow Document.
2075
The DocumentEntry metadata of the Remote Read Workflow Document shall meet the
following constraints:
•
The eventCodeList metadata attribute is used to document the current status of the
workflow and the status of task(s) within the workflow. This enables queries or DSUB
notifications about status based on the values in eventCodeList:
•
2080
2085
A single entry of eventCodeList metadata shall convey the current status of the
workflow in accordance with the value of the <workflowStatus> element
(OPEN or CLOSED). The value shall be one of:
•
code = “urn:ihe:iti:xdw:2011:eventCode:open” codingScheme=”
1.3.6.1.4.1.19376.1.2.3”
•
code = “urn:ihe:iti:xdw:2011:eventCode:closed” codingScheme=”
1.3.6.1.4.1.19376.1.2.3”
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
82
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
•
2090
A single entry of the eventCodeList metadata shall convey the status of the Perform
Remote Read task. The value shall be one of:
•
code=”urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:PerformReadInprogress”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
•
code=”urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:PerformReadCompleted”
codingScheme=”1.3.6.1.4.1.19376.1.2.1”
The Preliminary Report document and the Addendum to the Final Report, may be included in the
same Submission Set in this transaction ([RAD-WW] Update Content) or in a different
Submission Set using a [ITI-41] Provide and Register Document Set-b transaction.
2095
3.WW.4.1.3 Expected Actions
The Document Repository shall process the Provide and Register Document Set-b Request
message as described in ITI TF-2b:3.41.4.1.3.
3.WW.4.2 Provide and Register Document set-b Response
2100
This specification does not add additional requirements for the Provide and Register Document
Set-b Response message defined in ITI TF-2b:3.41.4.2.
3.WW.4.2.1 Trigger Events
See ITI TF-2b:3.41.4.2.1
3.WW.4.2.2 Message Semantics
See ITI TF-2b:3.41.4.2.2
2105
3.WW.4.2.3 Expected Actions
See ITI TF-2b:3.41.4.2.3.
If an error is generated by the Document Repository, that error should be managed by the
Remote Read Performer in accordance with local defined behaviors, and in accordance with
XDW actor behaviors (race condition) defined in ITI TF-3: 5.4.5.1
2110
3.WW.5 Security Considerations
See ITI TF-2b:3.41.5.
3.WW.5.1 Security Audit Considerations
See ITI TF-2b:3.41.5.1.
Volume 2 Namespace Additions
2115
Add the following terms to the IHE Namespace:
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
83
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Urn namespace
urn:ihe:rad:xrr-wd:2015:normalRead
urn:ihe:rad:xrr-wd:2015:readOverRead
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:RequestReadCompleted
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:RequestReadFailed
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:DispatchReadReady
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:DispatchReadInprogress
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:DispatchReadCompleted
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:DispatchReadFailed
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:PerformReadReady
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:PerformReadInprogress
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:PerformReadExited
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:PerformReadFailed
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:PerformReadCompleted
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:CompleteReadFailed
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:CompleteReadCompleted
urn:ihe:rad:xrr-wd:2015:eventCodeTaskStatus:CompleteReadInprogress
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
84
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Volume 3 – Content Modules
2120
Not applicable
2125
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
85
Copyright © 2016: IHE International, Inc.
IHE Radiology Technical Framework Supplement - Cross-Enterprise Remote Read Workflow
Definition (XRR-WD)
______________________________________________________________________________
Volume 4 – National Extensions
Not applicable
2130
__________________________________________________________________________
Rev. 1.0 – 2016-04-22
Template Rev. 10.3
86
Copyright © 2016: IHE International, Inc.