IHE ITI TF Supplement XDS-2

ACC, HIMSS and RSNA
Integrating the Healthcare Enterprise
IHE IT Infrastructure Technical Framework

Supplement 2007-2008
10
Cross-Enterprise Document Sharing-b (XDS.b)
15
Draft for Trial Implementation

August 15, 2007
20
Copyright © 1997-2007: ACC/HIMSS/RSNA

IHE IT Infrastructure Technical Framework – Cross-Enterprise Document Sharing-b (XDS.b)
Supplement
______________________________________________________________________________
Foreword
Integrating the Healthcare Enterprise (IHE) is an initiative designed to stimulate the integration
of the information systems that support modern healthcare institutions. Its fundamental objective
is to ensure that in the care of patients all required information for medical decisions is both
25 correct and available to healthcare professionals. The IHE initiative is both a process and a
forum for encouraging integration efforts. It defines a technical framework for the
implementation of established messaging standards to achieve specific clinical goals. It includes
a rigorous testing process for the implementation of this framework. And it organizes
educational sessions and exhibits at major meetings of medical professionals to demonstrate the
30 benefits of this framework and encourage its adoption by industry and users.
The approach employed in the IHE initiative is not to define new integration standards, but rather
to support the use of existing standards—HL7, DICOM, IETF, and others—as appropriate in
their respective domains in an integrated manner, defining configuration choices when necessary.
IHE maintain formal relationships with several standards bodies including HL7, DICOM and
35 refers recommendations to them when clarifications or extensions to existing standards are
necessary.
This initiative has numerous sponsors and supporting organizations in different medical specialty
domains and geographical regions. In North America the primary sponsors are the American
College of Cardiology (ACC), the Healthcare Information and Management Systems Society
40 (HIMSS) and the Radiological Society of North America (RSNA). IHE Canada has also been
formed. IHE Europe (IHE-EUR) is supported by a large coalition of organizations including the
European Association of Radiology (EAR) and European Congress of Radiologists (ECR), the
Coordination Committee of the Radiological and Electromedical Industries (COCIR), Deutsche
Röntgengesellschaft (DRG), the EuroPACS Association, Groupement pour la Modernisation du
45 Système d'Information Hospitalier (GMSIH), Société Francaise de Radiologie (SFR), Società
Italiana di Radiologia Medica (SIRM), the European Institute for health Records (EuroRec), and
the European Society of Cardiology (ESC). In Japan IHE-J is sponsored by the Ministry of
Economy, Trade, and Industry (METI); the Ministry of Health, Labor, and Welfare; and MEDIS-
DC; cooperating organizations include the Japan Industries Association of Radiological Systems
50 (JIRA), the Japan Association of Healthcare Information Systems Industry (JAHIS), Japan
Radiological Society (JRS), Japan Society of Radiological Technology (JSRT), and the Japan
Association of Medical Informatics (JAMI). Other organizations representing healthcare
professionals are invited to join in the expansion of the IHE process across disciplinary and
geographic boundaries.
55 The IHE Technical Frameworks for the various domains (IT Infrastructure, Cardiology,
Laboratory, Radiology, etc.) defines specific implementations of established standards to achieve
integration goals that promote appropriate sharing of medical information to support optimal
patient care. It is expanded annually, after a period of public review, and maintained regularly
through the identification and correction of errata. The current version for these Technical
60 Frameworks may be found at www.ihe.net/Technical_Framework.
Trial Implementation Version 1

August 15, 2007 Copyright © 1997-2007: ACC/HIMSS/RSNA
Supplement
______________________________________________________________________________
The IHE Technical Framework identifies a subset of the functional components of the healthcare
enterprise, called IHE Actors, and specifies their interactions in terms of a set of coordinated,
standards-based transactions. It describes this body of transactions in progressively greater
depth. The volume I provides a high-level view of IHE functionality, showing the transactions
65 organized into functional units called Integration Profiles that highlight their capacity to address
specific clinical needs. The subsequent volumes provide detailed technical descriptions of each
IHE transaction.
This IHE IT Infrastructure Technical Framework Supplement is issued for Trial Implementation
through March 2008.
70
Comments and change proposals arising from Trial Implementation may be
submitted to http://forums.rsna.org under the forum:
“Integrating the Healthcare Enterprise”
Select the sub-forum:
75 “IHE IT Infrastructure 2007 Supplement for Trial Implementation”
The IHE IT Infrastructure Technical Committee will address these comments resulting from
implementation, connect-a-thon testing, and demonstrations such as HIMSS 2008. Final text is
expected to be published in June 2008.

Supplement
______________________________________________________________________________
80 Contents
Foreword ......................................................................................................................................... 1
1 Introduction.............................................................................................................................. 4
1.1 Background....................................................................................................................... 4
1.2 Scope of Supplement ........................................................................................................ 5
85 1.3 Open Issues and Questions ............................................................................................... 5
1.4 Closed Issues .................................................................................................................... 7
1.5 Profile Abstract............................................................................................................... 11
Volume I – Integration Profiles ................................................................................................. 13
10 Cross-Enterprise Document Sharing ..................................................................................... 13
90 10.1 Actors/ Transactions......................................................................................................... 13
10.2 Integration Profile Options............................................................................................... 16
10.6 Patient Identifier Communication Requirements............................................................. 17
10.7 Migration and Coexistence Scenarios.............................................................................. 17
Appendix B: Transaction Description .......................................................................................... 19
95 Appendix E: Cross Profile Consideration..................................................................................... 19
Volume 2 - Transactions............................................................................................................. 21
3 IHE Transactions ................................................................................................................... 21
3.14 Register Document Set..................................................................................................... 21
3.18 Registry Stored Query...................................................................................................... 22
100 3.41 Provide and Register Document Set-b ............................................................................. 25
3.42 Register Document Set-b ................................................................................................. 33
3.43 Retrieve Document Set .................................................................................................... 39
4 Cross-Transaction Specifications............................................................................................... 48
4.1 XDS Metadata.................................................................................................................... 48
105 Appendix W XDS.b Examples ..................................................................................................... 51

Supplement
______________________________________________________________________________
1 Introduction
This supplement provides a new implementation choice for the Cross-Enterprise Document
Sharing (XDS) Integration Profile based on a use of the Web Services and ebXML Reg/Rep
110 standards that is consistent with the current developments and best practices in the industry.
The current XDS interoperability profile employs different versions of the same standard
(ebXML Registry 2.0 and 3.0) and specifications that have been superseded by other ones (like
MTOM replacing SOAP with Attachments or SwA). The existing XDS Integration Profile has
been renamed to XDS.a but remains technically unaffected by this Integration Profile. The new
115 IHE XDS.b Integration Profile accomplishes the following:
• Updates the XDS Web Services implementation to allow for use of SOAP 1.2 as well as
optionally the legacy SOAP 1.1
• Updates the XDS transactions to use ebXML Registry 3.0 metadata
• Updates the Provide and Register Document Set “on-line” mode transaction to use
120 MTOM instead of the legacy SOAP with Attachments (SwA) mechanism
• Defines a new transaction which provides a SOAP binding for the XDS Retrieve
Document transaction that uses MTOM (new transaction now named “Retrieve
Document Set”)
• Updates the IHE XDS Registry Stored Query transaction to be consistent with the other
125 XDS.b transactions. The Registry Stored Query transaction is the same in XDS.a and
XDS.b
• Provides informative Web Services Description Language (WSDL) contracts for all the
required IHE XDS.b Transactions and WSDL fragments for the options
• References the new Patient Identity Feed HL7v3 [ITI-44] transaction in addition to the
130 existing Patient Identity Feed [ITI-8] transaction based on HL7v2.
The IHE XDS.b Integration Profile is the basis for IHE work in the area of security (see XUA
Supplement) and Cross Community communication (see XCA Supplement).
1.1 Background
The Web Services technologies standards have evolved over the past few years to a more mature
135 solution for intra- and cross-enterprise integration and are being supported by an increasing
number of platform and vendors, both in commercial and open-source implementations. With
this change some of the standards used in the IHE XDS Integration Profile have evolved and
matured as well.
Although some more advanced specifications are still evolving and subject to change and
140 therefore not suitable for inclusion in an IHE Integration Profile, most of the foundation
specifications are solid and adopted by standard bodies:
• W3C Simple Object Access Protocol (SOAP) 1.2 [SOAP12]

Supplement
______________________________________________________________________________
• W3C Web Services Description Language (WSDL) 1.1 [WSDL11]

• W3C XML-binary Optimized Packaging (XOP) 1.0 [XOP10]
145 • W3C Message Transmission Optimization Mechanism (MTOM) [MTOM]
[SOAP12], [WSDL11] form today the basis for all the Web Services specification and are widely
implemented in the industry. [MTOM] and [XOP10] add an efficient way to transport
attachments reducing the requirements in terms of bandwidth and resources required to
encode/decode the attachment.
150 1.2 Scope of Supplement

The new Web Services transactions affect primarily the technical implementation of the
integration profile. The new transactions are “semantically equivalent” to the existing ones to
facilitate bridging and integration scenarios with current IHE XDS implementations. For this
reason this supplement proposes to maintain a single XDS chapter in the ITI TF Volume 1 that
155 documents two closely related integration profiles: XDS.a, the existing version of XDS, and
XDS.b, the new version more closely aligned with current standards. In addition the coexistence
and migration strategies related to those two implementation “flavors” will be specified thus
allowing easier interoperability (under specific conditions) between XDS.a and XDS.b.
The changes between XDS.a and XDS.b can be summarized as:
160 • Change in the metadata format from ebXML Reg/Rep RIM 2.1 to version 3.0
• Added a new repositoryUniqueId attribute to the document metadata
• Defined a new transaction “Retrieve Document Set” for XDS.b to replace the XDS.a
Retrieve Document [ITI-17] transaction
• Define updated bindings for Registry Stored Query to reflect changes in the web services
165 specifications
The transactions specified in the XDS.b profile are therefore modified as follows:
• Register Document Set-b [ITI-42]: updated SOAP binding and document metadata
format
• Registry Stored Query [ITI-18]: updated SOAP binding to reflect changes in the IHE
170 namespace convention
• Provide and Register Document Set-b [ITI-41]: new SOAP/MTOM binding and updated
document metadata format
• New XDS.b transaction Retrieve Document Set (ITI TF-2:3.43) with SOAP/MTOM
binding
175 1.3 Open Issues and Questions

1. A019: Review XDR on-line for MTOM upgrade

Supplement
______________________________________________________________________________
Proposal to update XDR to ebRIM 3.0 document metadata format and hold moving to final text
for another year. XDR is still bound to XDS.a Provide and Register Document Set.
Proposed Resolution: Leave XDR as is, bound to XDS.a and ebRIM 2.1and maintain the Trial
180 Implementation version for next year, advising people that it may evolve toward ebRIM 3.0 and
MTOM for on-line mode.
2. A026: Review Registry Stored Query to include the correct WSDL and namespaces
according to action A028
• Section 3.18.3 Add SOAP 1.2
185 • Section 3.18.4.1.2.7
• IHEWSP201 should be informative as it is not reflected on the wire and does not
affect interoperability
• The table under IHEWSDP201 also should be in the informative appendix
• IHEWSP202 should not be here as the WSDL is defined per actor/profile, please
190 refer to the Document Registry sample WSDL in Appendix W - XDS.b
Supplement
• See 3.43.5 in the XDS.b supplement for an example of how the normative section
of the WSDL should be specified
• Change section 3.18.4.1.2.7.1 to refer to Appendix W of the XDS.b supplement
195 • Section 3.18.4.1.4
• IHEWSP201 should be informative as it is not reflected on the wire and does not
affect interoperability
• IHEWSP202 should not be here as the WSDL is defined per actor/profile, please
refer to the Document Registry sample WSDL in Appendix W - XDS.b
200 Supplement
• Change section 3.18.4.1.4.1 to refer to Appendix W of the XDS.b supplement
• Please note that the assertions IHEWSPxxxx should be unique across TF volumes. In
Stored Query they are repeated.
3. A029: Apply CPs
205 • No CP changes have been applied to the supplement:
• Apply CP 28 “Proposed Error Codes” to all the transactions in defined in the
Volume 2 supplement. ftp://ftp.ihe.net/IT_Infrastructure/TF_Maintenance-2006-
2007/CPs/Assigned/xds_028_06.doc. CP21 needs to be updated to the new
Chapter 4 structure. It is worth considering adding the error codes in a new
210 section in Chapter 4.

Supplement
______________________________________________________________________________
• Apply CP 246 “Move XDS Metadata sections to separate chapter and reference
from multiple transactions” to section 4.1 that will move out of this document to
the final ITI TF Volume 2 text.
ftp://ftp.ihe.net/IT_Infrastructure/TF_Maintenance-2006-2007/CPs/Assigned/CP-
215 ITI-246-02.doc
4. A030: Impact on XDM
• Proposed Resolution: Update XDM to ebRIM 3.0 document metadata format and
hold moving to final text for another year
5. A031: HL7 V3 Schemas from the May 2007 ballot for Patient Identity Feed HL7v3 are
220 not valid.
• The following schemas are missing and are not in the May 2007 254MB zip file:
COCT_MT900000UV.xsd, MCAI_MT900001UV01.xsd,
COCT_MT180000UV04.xsd, COCT_MT510000UV.xsd
• Also, for the schemas that are there, there are a number of types defined with spaces
225 in their names, which is a violation of XML Schema Definition.
6. A032: replace sample OID used in 4.1.7 Document Definition Metadata, Table 4.1-5
Document Metadata Attribute Definition of this supplement with an OID from the IHE
root.
7. A033: should the Document Registry validate the content of the repositoryUniqueId in
230 the document metadata for the Register Document Set-b transaction?
1.4 Closed Issues

1. A001: Need to harmonize the namespace selection and eventually issue a cross
committee recommendation on IHE namespace usage.
• The IHE namespace is temporarily defined in this profile as
235 “http://www.ihe.net/2007/XDS” pending a final decision from IHE IT Tech. The
reason for defining an IHE namespace is because this contract is defined by the IHE
organization. This is contrast with the current IHE Stored Query WSDL that is
defined in the ebXML Reg/Rep namespace.
• Proposed naming schema:
240 http://www.ihe.net/<domain>/<year>/<profile name>/<other>
for XDS this becomes: http://www.ihe.net/iti/2007/xds
• Resolution: See resolution for A028 for updated convention
2. A002: Define a WSDL for PIX/PDQ v3
• The current proposed PIX/PDQ v3 profile does not define a WSDL or a web services
245 binding. The WSDL will have to be defined either as part of the PIX/PDQ profile or
as part of this one.

Supplement
______________________________________________________________________________
• Resolution: new version of PIX/PDQ v3 will harmonize with XDS.b and provide
WSDL and new versions of HL7 schemas. WSDL are defined per actor per profile.
XDS.b will include Patient Identity Feed HL7v3 transactions in the XDS.b Document
250 Registry WSDL in Appendix W.
3. A003: Update PIX/PDQ v3 to reflect latest HL7 Version 3 Normative Edition
• The current proposed PIX/PDQ v3 profile uses an outdated version of HL7 v3 Patient
Administration domain as well as an old version of the XML ITS. The profile will
have to be updated to the last HL7 Version 3 Normative Edition.
255 • Resolution: second trial implementation version of PIX/PDQ v3 will harmonize with
XDS.b and provide WSDL and new versions of HL7 schemas. See resolution of
A002
4. A004: Walk through IHEXDS.XSD and WSDL contracts
• Agree on nomenclature and cardinality of elements and types
260 • Resolution: schema and WSDL files reviewed in March 2007 f2f meeting.
5. A005: reference W3C MTOM Serialization Policy Assertion (WS-MTOMPolicy)
[MTOMPOL] submission as an example of how to configure MTOM serialization.
• Note for implementers on how MTOM is configured to always deal with binary data
instead of base64.
265 • Resolution: will be added to the XDS.b implementation notes on the IHE Wiki
6. A006: who is responsible for resolving the repositoryUniqueId to a Document
Repository? The Registry or the Document Consumer?
• Resolution: Resolution of the repositoryUniqueId is responsibility of the document
consumer. Document Consumers shall maintain a "configurable" association between
270 the repositoryUniqueId and the service URI in order to allow for positive resolution
of repositoryUniqueId to the web service endpoint. If the repository supports Retrieve
Document Set forwarding, the document consumer can use that option. The
mechanism for maintaining the association is out of scope [possibly addressed in a
future profile?]. Suggested wording that allows for changes in the future -- if the
275 document repository cannot use the repository unique id [cannot
resolve/forward/figure it out] it shall return an error to the document consumer.
7. A007: how to obtain patient id for auditing from repository for retrieve
• Resolution: closed as there is no good way of doing this (final wording for resolution
from Bill Majurski)
280 8. A008: striking expires/contentType/contentLanguage/lastModified could affect the
operation of XDS bridges
• Resolution: XDS bridge will do a best-effort conversion and provide those values
where appropriate

Supplement
______________________________________________________________________________
9. A009: consolidate response codes across web services (start with reg/rep)
285 • Resolution: responseCode is a constrained value set and will be defined across IHE
Web Services specs. Semantically the code will include the ones define for HTTP
Retrieve. Response codes are defined in CP28
10. A010: Investigate support for both SOAP 1.1 and 1.2 or exclusive SOAP 1.2
• WS-Security supports both SOAP 1.1 and SOAP 1.2. We need to decide if we want
290 to bind to a single protocol or allow for both.
• Resolution: require SOAP 1.2 and optionally support SOAP 1.1
11. A011: add samples for service location (repositoryUniqueId Æ repository service
location) to the Wiki (UDDI?)
• Resolution: see resolution of A006
295 12. A012: Decide option for XSD.b (new profile, existing profile with different options…)
• Resolution: create a new profile.
13. A013: Should patient id be V3 only (see your questions in original emails).
• Get format requirements/design from Innovazione Italia
• Resolution: keep an eye on the project and provide some feedback from the IHE
300 perspective. Eventually engage the Italian folks to provide feedback directly to IHE.
14. A014: Are there any changes to the offline transactions, how does this affect the offline
P&R transaction
• Resolution: No offline mode for XDS.b, address as a coexistence/migration scenario.
If implementer wants to implement “off-line” it has to implement XDS.a according to
305 IHE rules
15. A015: Agree to names for the new transactions
• Resolution: XDS.a is the existing XDS, XDS.b is the new web services version.
These are two profiles in the existing Volume 1 XDS chapter.
• Highlight bridging scenarios where repositories and registries support both XDS.a
310 and XDS.b
• New transactions will have a “-b” suffix added to them with the exception of the
current HTTP Document Retrieve which becomes “Retrieve Document Set”
16. A016: Are there any changes needed to support use of the Retrieve Document Set
transaction by the Cross Community Access (XCA) profile. Specifically it may be
315 useful to specify a "home" attribute as an optional part of the retrieve document request
• Discussion postponed until XCA decision, seems like an option
affinityDomainUniqueId attribute would solve the problem.

Supplement
______________________________________________________________________________
• Resolution: added optional homeCommunityId element in the Retrieve Document

Set request and response. The homeCommunityId corresponds to the home attribute
320 of the Identifiable class in regrep RIM (regrep-rim-3.0-os.pdf, page 20).
17. A017: Attribute size
• Resolution: Limit for repositoryUniqueId is 256 (limit for a value within a slot)
according to ebRIM standard
18. A018: Include full ebRS/ebRIM 2.1 and 3.0 metadata sample
325 • Resolution: included sample in Appendix W and referenced from 3.42 and 3.41
19. A020: Allow for either v2 or v3 format for Patient Identity Feed
• Resolution: Allow XDS.b to support either Patient Identity Feed (HL7v2) or Patient
Identity Feed HL7v3 or both. Support for XDS.a is unchanged and requires Patient
Identity Feed HL7v2 and optionally Patient Identity Feed HL7v3.
330 20. A021: should we keep multiple document submission as an option?
• Resolution: We will leave this option there for compatibility reasons with XDS.a
21. A022: there is a reference to CDA R1. It seems like it is only used in the root/extension
definition. Can we update this to CDA R2?
• Probably safe to drop, Rob Horn will have a look
335 • Resolution: dropped references to CDA R1 (or R2) in the XDS.b transactions as not
needed.
22. A023: should we add affinityDomainUniqueId for XCA? Not needed if
repositoryUniqueId is unique across multiple XDS Affinity Domains.
• Postponed until XCA discussion. See A016.
340 • Resolution: see resolution of A016
23. A024: add repositoryUniqueId to the Document Retrieve transaction to allow for
additional scenarios: repository resolving other’s repositories addresses and getting the
documents on behalf of the document consumer
• Resolution: add the element to Retrieve Document Set transaction
345 24. A025: metadata tables in current retrieve transactions should go into an appendix
• Resolution: Metadata tables will go into new Chapter 4, section 4.1. XDS.b will refer
that section, but still add a repositoryUniqueId attribute
25. A027: Review for XDS.b for XCA compatibility
• Work with Karen Witting
350 • Resolution: changes included in the Public Comment version of the XDS.b
supplement

Supplement
______________________________________________________________________________
26. A028: Align Appendix V: namespace issues when composing multiple transactions
with different namespaces
• Resolution: Define one WSDL per actor per profile, namespace of the WSDL
355 follows the IHE rule urn:ihe:<cmtee>:<profile>:<year>. The transaction
soapActions follow the rule urn:ihe:<cmtee>:<year>:<transaction name> so that
they do not depend on the profile (like it is in IHE).
• For HL7v3 based actors, follow the HL7 rules.
1.5 Profile Abstract

360 This supplement provides a new implementation choice for the Cross-Enterprise Document
Sharing (XDS) Integration Profile based on a use of the Web Services and ebXML Reg/Rep
standards that is consistent with the current developments and best practices in the industry. This
new implementation choice is the form of the new Integration Profile XDS.b.

Supplement
______________________________________________________________________________

Supplement
______________________________________________________________________________
365 Volume I – Integration Profiles

<This section describes the changes required in Volume I of the Technical Framework that
result from including this Integration Profile.>
10 Cross-Enterprise Document Sharing

Add after the introductory text.
370 As of year 2007-2008, IHE introduces a new Integration Profile for XDS in parallel with the
previous one that is renamed to XDS.a.
The new integration profile XDS.b is based on a use of the Web Services and ebXML Reg/Reg
standards that is consistent with the current developments and best practices in the industry.
The changes in XDS.b can be summarized as:
375 • Change in the XDS metadata format from ebXML Reg/Rep RIM 2.1 to version 3.0
• A new repositoryUniqueId attribute added to the XDS metadata
• Definition of a new transaction “Retrieve Document Set” as a new binding for the XDS.a
Retrieve Document [ITI-17] transaction
• Definition of updated bindings for existing transactions to reflect changes in the web
380 services specifications
In the rest of the ITI Technical Framework the term XDS refers generically to both XDS.a and
XDS.b.
10.1 Actors/ Transactions

Rename current “Figure 10.1-1 Cross-Enterprise Document Sharing Diagram” to “Figure 10.1-
385 1a Cross-Enterprise Document Sharing (XDS.a) Diagram”
Rename current “Table 10.1-1 XDS - Actors and Transactions” to “Table 10.1-1a XDS.a - Actors and
Transactions”
At the end of section 10.1 add the following:

Supplement
______________________________________________________________________________
Patient Identity Source
Patient Identity Feed [ITI-8]

Patient Identity Feed HL7v3 [ITI-44] ↓
Registry Stored Query
[ITI-18] ←
Document Registry Document Consumer
↑ Register Document Set – b [ITI-42]
Provide&Register Retrieve Document Set [ITI-43]

Document Set – b [ITI-41]
←
→ Document Repository
Document Source
Integrated Document Source/Repository
390
Figure 10.1-1b Cross-Enterprise Document Sharing – b (XDS.b) Diagram
Table 10.1-1b XDS.b - Actors and Transactions

Actors Transactions Optionality Section in
Vol. 2
Document Consumer Registry Stored Query R ITI TF-2:3.18
Retrieve Document Set R ITI TF-2:3.43
Document Source Provide and Register Document Set-b R ITI TF-2:3.41
Document Repository Provide and Register Document Set-b R ITI TF-2:3.41
Register Document Set-b R ITI TF-2:3.42
Document Registry Register Document Set-b R ITI TF-2:3.42
Registry Stored Query R ITI TF-2:3.18
Patient Identity Feed O (Note 2) ITI TF-2:3.8
Patient Identity Feed HL7v3 O (Note 2) ITI TF-2:3.44
Integrated Document Register Document Set-b R ITI TF-2:3.42
Source/Repository
Patient Identity Source Patient Identity Feed O (Note 1,2) ITI TF-2:3.8
Patient Identity Feed HL7v3 O (Note 1,2) ITI TF-2:3.44
Note 1: If Assigning Authority of Patient ID presents in the Patient Identity Feed or Patient Identity Feed HL7v3
395 transaction, the Patient Identity Source is required to use an OID to identify the Assigning Authority. For
technical details of the assigning authority information, see Transaction [ITI-8] in Technical Framework, Volume
2.

Supplement
______________________________________________________________________________
Note 2: Document Registry and Patient Identify Source shall implement at least one of Patient Identity Feed or Patient
Identity Feed HL7v3.
400 10.1.2.3 Query Registry

Add as the first sentence of the section:
The Query Registry Transaction is not supported in XDS.b.
10.1.2.4 Retrieve Document

Add as the first sentence of the section:
405 The Retrieve Document Transaction is not supported in XDS.b.
10.1.2.5 Patient Identity Feed

Replace text with the following updated text:
The Patient Identity Feed Transaction conveys the patient identifier and corroborating
demographic data, captured when a patient’s identity is established, modified or merged or in
410 cases where the key corroborating demographic data has been modified. Its purpose in the XDS
Integration Profile is to populate the registry with patient identifiers that have been registered for
the XDS Affinity Domains.
The Patient Identify Feed Transaction defined in ITI TF-2:3.8 for HL7v2 and in ITI TF-2:3.44
for HL7v3 uses standard HL7 encoding of Patient Identifiers. This is standard encoding for HL7
415 applications; receiving applications are expected to extract the required data for their use.
When combined with the other XDS transactions, Document Registry actors and other actors that
receive HL7 data with Patient Identifiers are required to map the data received in the HL7
message to the format specified in those other XDS transactions. In those transactions, the
Patient ID is treated using ebXML encoding rules and not HL7 encoding rules. Specifically, the
420 Patient ID will be treated as a string, and extra components entered in that string shall cause
those transactions to fail. XDS actors are required to use the specified encoding for Patient ID
values in other transactions and not merely copy the value received in an HL7 transaction.
XDS.a implementations shall support Patient Identity Feed (ITI TF-2:3.8).
XDS.b implementations shall support either Patient Identity Feed (ITI TF-2:3.8) or Patient
425 Identity Feed HL7v3 (ITI TF-2:3.44) or both. It is important to note that the version of HL7
implemented by XDS.b and Patient Identity Feed in a single domain or community need to
match in order to allow interoperability. In the case of mixed scenarios, translation between
Patient Identity Feed (ITI TF-2:3.8) and Patient Identity Feed HL7v3 (ITI TF-2:3.44) will be
required via a bridge or interface engine.
430 10.1.2.7 Retrieve Document Set

Add the following:

Supplement
______________________________________________________________________________
The Retrieve Document Set transaction (ITI TF-2:3.43) is not supported in XDS.a.
A Document Consumer Actor initiates the Retrieve Document Set transaction. The Document
Repository shall return the document set that was specified by the Document Consumer.
435 10.2 Integration Profile Options

Rename current table 10.2-1 to “Table 10.2-1a XDS.a - Actors and Options”
Add the following table for XDS.b options:
Table 10.2-1b XDS.b - Actors and Options

Actor Options Vol & Section
Document Source Multiple Document Submission ITI TF-1:10.2.1
Document Life Cycle Management ITI TF-1:10.2.2
Folder Management ITI TF-1:10.2.3
Document Repository No options defined
Document Registry Patient Identity Feed (Note 1) ITI TF-2:3.8
Patient Identity Feed HL7v3 (Note 1) ITI TF-2:3.44
Integrated Document Source / Repository Multiple Document Submission ITI TF-1:10.2.1
Document Life Cycle Management ITI TF-1:10.2.2
Folder Management ITI TF-1:10.2.3
Document Consumer No options defined
Patient Identity Source Patient Identity Feed (Note 1) ITI TF-2:3.8
Patient Identity Feed HL7v3 (Note 1) ITI TF-2:3.44
440
Note 1: Document Registry and Patient Identify Source shall implement at least one of Patient Identity Feed or Patient
Identity Feed HL7v3.
10.4.12 Transport Modes

Replace text in this section with the following:
445 The XDS Integration Profile defines an on-line mode of transport for both XDS.a and XDS.b
transactions. In addition to that, XDS also defines an off-line mode option for the XDS.a Provide
and Register Document Set transaction for both for the Document Source and the Document
Repository. In the “on-line mode” the transaction between two actors (computer applications)
requires their simultaneous presence (e.g. an HTTP GET). In the “off-line mode” the transaction
450 between the two actors (computer applications) does not require their simultaneous presence
(e.g. a store and forward e-mail exchange).
1. A Web Services- or HTTP-based protocol shall be used for on-line operation.

Supplement
______________________________________________________________________________
2. The SMTP protocol shall be used for off-line operation.
10.6 Patient Identifier Communication Requirements

455 Add the following text after the text in section 10.6:
XDS.a implementations shall support Patient Identity Feed (ITI TF-2:3.8).
XDS.b implementations shall support either Patient Identity Feed (ITI TF-2:3.8) or Patient
Identity Feed HL7v3 (ITI TF-2:3.44) or both. It is important to note that the version of HL7
implemented by XDS.b and Patient Identity Feed in a single domain or community need to
460 match in order to allow interoperability. In the case of mixed scenarios, translation between
Patient Identity Feed (ITI TF-2:3.8) and Patient Identity Feed HL7v3 (ITI TF-2:3.44) will be
required via a bridge or interface engine.
Add the following new section:
10.7 Migration and Coexistence Scenarios

465 The XDS.a and XDS.b Integration Profiles are equivalent in terms of functionality. In addition,
the definition of the XDS.b transactions are as semantically aligned with those in XDS.a as is
technically feasible. This can facilitate migration from XDS.a to XDS.b, if desired, as well as
coexistence of implementations supporting the two Integration Profiles in the same environment.
The objective of this section is to provide an example of a possible migration and coexistence
470 scenarios and highlight the implications for decision makers and implementers.
There are additional migration and coexistence scenarios and strategies besides those stated
below. These will be discussed in more detail in the XDS.b implementation notes available on
the IHE Wiki at http://wiki.ihe.net/index.php?title=XDS.b.
10.7.1 Example of Migration from XDS.a to XDS.b Interfaces

475 An XDS.a environment (Document Sources and Consumers, Document Registries and
Repositories all support XDS.a transactions) wants to support new Document Sources and
Consumers that only support XDS.b transactions. In this case a possible coexistence strategy
would encompass the following steps:
• Upgrade the Document Repositories to support the XDS.b transactions and maintain
480 support for the XDS.a transactions. The Document Repository will have an assigned
repositoryUniqueId. Since the Document Repository still supports XDS.a transactions, it
shall populate the document URI attribute in accordance with the rules for XDS.a in the
Register Document Set transaction. This allows existing XDS.a Document Consumers to
continue retrieve documents using the Retrieve Document transaction.
485 • Upgrade the Document Registry to support the XDS.b transactions and maintain
support for the XDS.a transactions. The upgrade process will have to go though the
existing registered documents and add the repositoryUniqueId metadata attribute based
on the document URI value and a configuration table that would allow it to positively
Supplement
______________________________________________________________________________
resolve the Document Repository associated with that URI. This environment now
490 supports XDS.b Document Consumers in addition to XDS.b Document Sources.
The resulting environment has a Document Registry and Document Repositories that support
both XDS.a and XDS.b transactions. This allows for coexistence of both XDS.a and XDS.b
Document Sources and Consumers. Eventually the remaining XDS.a actors could be phased out
and support for XDS.a transactions dropped from the Document Registry and Repositories.
495 XDS.b does not support XDS.a “off-line” mode; therefore if that kind of support is needed for
XDS.a Document Sources, the Document Repository shall continue to support that part of XDS.a
as well.
10.7.2 Example of Coexistence among XDS.a and XDS.b Interfaces

Instead of having the Document Repository and Document Registry support both the XDS.a and
500 XDS.b interfaces, one could build a message translation technology component that bridges
between Document Source and Document Consumer actors in one mode (XDS.a or XDS.b) with
the Document Repository and Document Registry in the other mode, where discrepant modes
exist.
An XDS.a/XDS.b message translation technology component may be designed to support:
505 • Translating a Provide and Register Document Set transaction (XDS.a) into a Provide and
Register Document Set-b transaction (XDS.b).
• Translating a Provide and Register Document Set-b transaction (XDS.b) into a Provide
and Register Document Set transaction (XDS.a).
• Translating a Retrieve Document transaction (XDS.a) into a Retrieve Document Set
510 (XDS.b). This case requires mapping from a document URI to a repository ID and
document ID.
• Translating a Retrieve Document Set transaction (XDS.b) into a Retrieve Document
transaction (XDS.a). This case requires mapping from repository ID and document ID to
a document URI.
515 The Registry Stored Query Transaction does not need translation as it is identical for both XDS.a
and XDS.b.
10.7.3 Requirements When Choosing to Support Both XDS.a and XDS.b

An implementation of XDS may choose to support both XDS.a and XDS.b transactions. If this
choice is made, the following requirements shall be met:
520 • The Actor shall implement and support all its required transactions according to the
XDS.a and XDS.b specifications.
• Document Registry and Document Repository actors shall support these transactions
simultaneously and shall not require reconfiguration nor disrupt their availability in any
way in order to switch between XDS.a and XDS.b operation modes.

Supplement
______________________________________________________________________________
525 Appendix B: Transaction Description

Add new transactions for XDS.b:
Register Document Set-b: A Document Repository actor initiates the Register Document Set-b
transaction. This transaction allows a Document Repository Actor to register one or more
documents in a Document Registry, by supplying metadata about each document to be
530 registered. This document metadata will be used to create XDS Submission Set, XDS Document,
and potentially XDS Folder Entries in the registry. The Document Registry actor ensures that
document metadata is valid before allowing documents to be registered. If one or more
documents fail the metadata validation, the Register Document Set-b transaction fails as a whole.
Provide and Register Document Set-b: A Document Source actor initiates the Provide and
535 Register Document Set-b transaction. For each document in the submitted set, the Document
Source actor provides both the documents as an opaque octet stream and the corresponding
metadata to the Document Repository. The Document Repository is responsible to persistently
store these documents, and to register them in the Document Registry using the Register
Document Set-b transaction by forwarding the document metadata received from the Document
540 Source actor.
Retrieve Document Set: A Document Consumer actor initiates the Retrieve Document Set
transaction. The Document Repository will return the set of documents that was specified by the
Document Consumer.
Appendix E: Cross Profile Consideration

545 Replace E.2 with the following:
The RID Retrieve Document for Display transaction [ITI-12] is compatible with the XDS.a
Retrieve Document transaction [ITI-17]. Thus, an RID Information Source implementing the
Retrieve Document for Display transaction can be used to implement the XDS.a Retrieve
Document transaction. In this instance, the RID Information Source must be a Secure Node [see
550 ATNA].
RID is not compatible with XDS.b Retrieve Document Set transaction.

Supplement
______________________________________________________________________________

Supplement
______________________________________________________________________________
Volume 2 - Transactions
3 IHE Transactions
555 3.14 Register Document Set

3.14.4.1.2.16 Registry/Repository Error Reporting
Replace third column header of Table 3.14.4.1-11 – Error Codes with the following text:
Transaction
P = Provide and Register, Provide and Register-b
560 R = Register, Register-b
Q= Query
SQ=Stored Query
RS=Retrieve Document Set
565 Replace the corresponding rows in Table 3.14.4.1-11 – Error Codes with the following rows:
XDSRegistryError Internal Registry/Repository Error. P,R,Q,SQ

XDSRepositoryError P,RS
XDSRegistryBusy Too much activity P,R,Q,SQ
XDSRepositoryBusy P,RS
XDSRegistryOutOfResources Resources are low. P,R,Q,SQ
XDSRepositoryOutOfResources P,RS
XDSUnknownRepositoryId The repositoryUniqueId value could not be RS
resolved to a valid document repository or
the value does not match the
repositoryUniqueId of the Document
Repository
Replace the heading of Table 3.14.4.1-12 – Provide & Register Document Set Responses with the
following:
570 Table 3.14.4.1-12 – Provide & Register Document Set and Provide and Register Document
Set-b Responses
Replace the heading of Table 3.14.4.1-13 – Register Document Set and Responses with the
following:
Supplement
______________________________________________________________________________
575 Table 3.14.4.1-13 – Register Document Set and Register Document Set-b Responses
Add the following table and text:

Table 3.14.4.1-16 – Retrieve Document Set Responses
Registry RegistryErrorList element Result
Response status
Success Not Present Requested document is returned
Success Present, contains one or more RegistryError Requested document is returned

elements with warning severity, none with
error severity
Failure Present, contains one or more RegistryError Document Repository was not able to retrieve
elements. At least one has error severity, document
others may have warning severity.
Complete details on how these elements shall be populated in available at 3.43.5 Protocol
580 Requirements
3.18 Registry Stored Query

At the beginning of section 3.18.3 add the following to the list of referenced standards:
SOAP12 SOAP 1.2 Recommendation http://www.w3.org/TR/soap/
3.18.4.1.2.7 Web Services Transport

585 Replace 3.18.4.1.2.7 with the following:
The query request and response will be transmitted using Web Services, according to the
requirements specified in Appendix V. The specific values for the WSDL describing the Stored
Query Service are described in this section.
IHE-WSP201) The attribute /wsdl:definitions/@name shall be “DocumentRegistry”.
590 The following WSDL naming conventions shall apply:
wsdl:definitions/@name="DocumentRegistry":
query message -> "RegistryStoredQuery_Message"
query response -> "RegistryStoredQueryResponse_Message"
portType -> "DocumentRegistry_PortType"
595 operation -> "DocumentRegistry_RegistryStoredQuery"
SOAP 1.2 binding -> "DocumentRegistry_Binding_Soap12"
SOAP 1.2 port -> "DocumentRegistry_Port_Soap12"
SOAP 1.1 binding -> "DocumentRegistry_Binding_Soap11"
SOAP 1.1 port -> "DocumentRegistry_Port_Soap11"
600
IHE-WSP202) The targetNamespace of the WSDL shall be “urn:ihe:iti:xds-b:2007”

Supplement
______________________________________________________________________________
These are the requirements for the Registry Stored Query transaction presented in the order in
which they would appear in the WSDL definition:
• The following types shall be imported (xsd:import) in the /definitions/types section:
605 • namespace=" urn:oasis:names:tc:ebxml-regrep:xsd:query:3.0", schema="query.xsd"
• The /definitions/message/part/@element attribute of the Registry Stored Query Request
message shall be defined as “query:AdhocQueryRequest”
• The /definitions/message/part/@element attribute of the Registry Stored Query Response
message shall be defined as “query:AdhocQueryResponse”
610 • The /definitions/portType/operation/input/@wsaw:Action attribute for the Registry
Stored Query Request message shall be defined as
“urn:ihe:iti:2007:RegistryStoredQuery”
• The /definitions/portType/operation/output/@wsaw:Action attribute for the Registry
Stored Query Response message shall be defined as
615 “urn:ihe:iti:2007:RegistryStoredQueryResponse”
• The /definitions/binding/operation/soap12:operation/@soapAction attribute shall be
defined as “urn:ihe:iti:2007:RegistryStoredQuery”
A full WSDL sample for the Document Registry actor is found in Appendix W.2.
3.18.4.1.2.7.1 Sample SOAP Messages

620 Replace section “3.18.4.1.2.7.1 Example WSDL” with this section:
The samples in the following two sections show a typical SOAP request and its relative SOAP
response. The sample messages also show the WS-Addressing headers <Action/>,
<MessageID/>, <ReplyTo/>…; these WS-Addressing headers are populated according to the
W3C WS-Addressing standard. The body of the SOAP message is omitted for brevity; in a real
625 scenario the empty element will be populated with the appropriate metadata.
All of the samples presented in this section are also available online on the IHE FTP site at
ftp://ftp.ihe.net/IT_Infrastructure/iheitiyr5-2007-2008/Technical_Cmte/SupportMaterial/.
3.18.4.1.2.7.1.1 Sample Registry Stored Query SOAP Request

Note to the editor: please keep the following format for the sample text – courier new, 8pt, no spacing
630 before and after the paragraph, tab stops every 1/8 of an inch for the first inch.
<s:Envelope
xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:a="http://www.w3.org/2005/08/addressing">
635 <s:Header>
<a:Action s:mustUnderstand="1">urn:ihe:iti:2007:RegistryStoredQuery</a:Action>
<a:MessageID>urn:uuid:a02ca8cd-86fa-4afc-a27c-616c183b2055</a:MessageID>
<a:ReplyTo>
<a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address>
640 </a:ReplyTo>
<a:To
s:mustUnderstand="1">http://localhost:2647/XdsService/IHEXDSRegistry.svc</a:To>

Supplement
______________________________________________________________________________
</s:Header>
<s:Body>
645 <query:AdhocQueryRequest
xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:3.0"
xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0"
xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0">
<query:ResponseOption returnComposedObjects="true" returnType="LeafClass"/>
650 <rim:AdhocQuery id=" urn:uuid:14d4debf-8f97-4251-9a74-a90016b0af0d ">
<rim:Slot name="$XDSDocumentEntryPatientId">
<rim:ValueList>
<rim:Value>st3498702^^^&1.3.6.1.4.1.21367.2005.3.7&ISO</rim:Value>
655 </rim:ValueList>
</rim:Slot>
<rim:Slot name="$XDSDocumentEntryStatus">
<rim:ValueList>
<rim:Value>('urn:oasis:names:tc:ebxml-
660 regrep:ResponseStatusType:Approved')</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Slot name="$XDSDocumentEntryCreationTimeFrom">
<rim:ValueList>
665 <rim:Value>200412252300</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Slot name="$XDSDocumentEntryCreationTimeTo">
<rim:ValueList>
670 <rim:Value>200501010800</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Slot name="$XDSDocumentEntryHealthcareFacilityTypeCode">
<rim:ValueList>
675 <rim:Value>(‘Emergency Department’)</rim:Value>
</rim:ValueList>
</rim:Slot>
</rim:AdhocQuery>
</query:AdhocQueryRequest>
680 </s:Body>
</s:Envelope>
3.18.4.1.2.7.1.1 Sample Registry Stored Query SOAP Response

before and after the paragraph, tab stops every 1/8 of an inch for the first inch.
685
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"
<s:Header>
<a:Action
690 s:mustUnderstand="1">urn:ihe:iti:2007:RegistryStoredQueryResponse</a:Action>
<a:RelatesTo>urn:uuid:a02ca8cd-86fa-4afc-a27c-616c183b2055</a:RelatesTo>
</s:Header>
<s:Body>
<query:AdhocQueryResponse status="Success"
695 xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:3.0"
xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0">
<!—Rest of AdhocQueryResponse message goes here -->
700 </query:AdhocQueryResponse>
</s:Body>
</s:Envelope>

Supplement
______________________________________________________________________________
Remove sections “3.18.4.1.2.7.2 Example Request Message” and “3.18.4.1.2.7.3 Example Response
705 Message”
Remove the entire section “3.18.4.1.4 Web Services Transport” and its children (3.18.4.1.4.1-3)
3.41 Provide and Register Document Set-b

This section corresponds to Transaction [ITI-41] of the IHE Technical Framework. Provide and
710 Register Document Set-b is used by the Document Source to provide a set of documents to the
Document Repository, and to request that the Document Repository store these documents and
then register them with the Document Registry.
Integration Profiles using this Transaction

715 The Provide and Register Document Set-b transaction describes only the interaction between the
Document Source and Document Repository actors. The interaction between the Document
Repository and the Document Registry is described separately in the Register Document Set-b
Transaction [ITI-42].
This transaction aligns with the Registry Services standard (ebRS) for the format of the
720 document metadata as defined in Chapter 4.1. The ebRS standard covers the interaction with a
service that includes a registry with integrated repository. From the point of view of the
Document Source, the separate nature of the Document Registry and Document Repository
actors is not relevant.
By specifying separate Document Registry and Document Repository actors, XDS offers
725 additional flexibility of having a single Document Registry index content for multiple Document
Repositories. The ebRIM portion of the registry standard supports this possibility though the
ExternalLink object type.
The documents and metadata go to the Document Repository actor and then the metadata is
forwarded on to the Document Registry actor. They move in this direction for several reasons:
730 • Allows best reuse of ebXML Registry specified metadata and web services protocols
• Document Source only needs to know the identity of the Document Repository.
Document Repository knows the identity of the Document Registry. If Provide and
Register Document Set-b transaction were sent to the Document Registry then routing
decisions for documents would be more complex.
735 • Resulting protocols are simpler
• Simplifies the common case where the Document Source and the Document Repository
are grouped.

Supplement
______________________________________________________________________________
3.41.1 Scope
The Provide and Register Document Set-b transaction passes a Repository Submission Request
740 (see ITI TF-2: 4.1.3.1) from a Document Source to a Document Registry.
A Provide and Register Document Set-b transaction shall carry:
• Metadata describing zero or more documents
• Within metadata, one XDSDocumentEntry object per document
• XDS Submission Set definition along with the linkage to new documents and references
745 to existing documents
• Zero or more XDS Folder definitions along with linkage to new or existing documents
• Zero or more documents
Document Document
Source Repository
Provide and
Register
Document Set – b
Figure 3.41.2 Use Case Roles

750
Actor: Document Source
Role: A system that submits documents and associated metadata to a Document Repository.
Detailed requirements for this actor are discussed in section 3.41.6.1.
Actor: Document Repository
755 Role: A document storage system that receives documents and associated metadata and:
• Stores the documents
• Enhances submitted metadata with repository information to enable later retrieval of
documents
• Forwards the enhanced metadata to the Document Registry.
760 Detailed requirements for this actor are discussed in section 3.41.6.2.
3.41.3 Referenced Standards

ebRIM OASIS/ebXML Registry Information Model v3.0
ebRS OASIS/ebXML Registry Services Specifications v3.0
SOAP11 SOAP 1.1 Note http://www.w3.org/TR/2000/NOTE-SOAP-20000508/

Supplement
______________________________________________________________________________
WSDL11 WSDL 1.1 Note http://www.w3.org/TR/wsdl

MTOM SOAP Message Transmission Optimization Mechanism http://www.w3.org/TR/soap12-mtom/
3.41.4 Interaction Diagram
Document Document
Source Repository
Provide and Register Document Set – b

Request
Provide and Register Document Set – b

Response
3.41.4.1 Provide and Register Document Set-b Request

765 A Document Source sends documents and associated metadata to a Document Repository that
has an associated Document Registry.
3.41.4.1.1 Trigger Events

The Document Source, based on a human decision or the application of a certain rule of
automatic operation, wants to submit
770 • A set of zero or more documents to the Document Repository and
• The associated metadata to the Document Registry.
3.41.4.1.2 Message Semantics

The sections in Chapter 4.1 specify the mapping of XDS concepts to ebRS and ebRIM semantics
and document metadata. A full example of document metadata submission can be found in
775 Appendix W.
3.41.4.1.3 Expected Actions

The Provide and Register Document Set-b message shall include the metadata attributes (as
defined in section 4.1.7 Document Definition Metadata) that will be forwarded by the Document
Repository to the Document Registry using the Register Document Set-b transaction [ITI-42].
780 The Document Repository receives this message. Each document within the message shall be
stored into the Document Repository as an octet stream with an associated MIME type. A
detected failure shall result in an error message being returned to the Document Source thus
terminating this transaction.

Supplement
______________________________________________________________________________
The Document Source shall supply all necessary document metadata attributes with the
785 exception of the ones below. The Document Repository shall modify the received document
metadata before initiating the Register Document Set-b transaction to the Document Registry by
adding/replacing:
• The repositoryUniqueId for this Document Repository to allow for the Document
Consumer to correctly identify the proper Document Repository for each document
790 (XDSDocumentEntry.repositoryUniqueId).
• A hash value (XDSDocumentEntry.hash)
• A size (XDSDocumentEntry.size).
• Optionally a URI identifier (XDSDocumentEntry.URI) that can be used by a Document
Consumer to reference the document. This is only required if the repository is an XDS.a
795 Document Repository therefore supporting the Retrieve Document [ITI-17] transaction.
A Register Document Set-b transaction with this modified metadata shall be issued to the
Document Registry.
The Document Repository shall ensure that when any Retrieve Document Set transaction is
received requesting a specific document(s), it shall be provided to the Document Consumer
800 unchanged from the octet stream that was submitted (full fidelity repository) and shall match the
size and hash attributes of the XDSDocumentEntry object.
3.41.4.1.4 Security Considerations

The Provide and Register Document Set-b Request shall be audited by the Document Source as
described in 3.15.4.1.4 Security considerations with the exception of the EventTypeCode field
805 that shall be replaced with EV(“ITI-41”, “IHE Transactions”, “Provide and Register
Document Set-b”).
3.41.4.2 Provide and Register Document Set-b Response

The Document Repository sends a Provide and Register Document Set-b Response when the
processing of a Provide and Register Document Set-b Request is complete.
810 The Provide and Register Document Set-b Response message shall carry the status of the
requested operation and an error message if the requested operation failed. The conditions of
failure and possible error messages are given in the ebRS standard and detailed in 3.14.4.1.2.16
Registry/Repository Error Reporting (see Change Proposal 28 which adds this section).

815 The following events can trigger this message:
• Documents stored to repository successfully and metadata stored to registry successfully
(The registry part is carried out as part of a Register Document Set-b transaction)
• Documents stored to repository successfully but an error occurred in storing the metadata
to the registry
Supplement
______________________________________________________________________________
820 • Documents were not successfully stored to the repository

The Provide and Register Document Set-b Response message shall carry the status of the
requested operation and an error message if the requested operation failed. The conditions of
failure and possible error messages are given in the ebRS standard and detailed in 3.14.4.1.2.16
825 Registry/Repository Error Reporting (see Change Proposal 28 which adds this section).

The Document Source now knows that the transaction succeeded/failed and can continue. The
metadata added to the registry as a result of this transaction is now available for discovery via
Registry Stored Query transactions. The document(s) added to the repository are now available
830 for retrieval.

The Provide and Register Document Set-b Response shall be audited by the Document
Repository as described in 3.15.4.2.4 Security considerations with the exception of the
EventTypeCode field that shall be replaced with EV(“ITI-41”, “IHE Transactions”, “Provide
835 and Register Document Set-b”).
3.41.5 Protocol Requirements

The protocol for the Provide and Register Document Set-b transaction is based on SOAP12
(optionally SOAP11) and MTOM.
WSDL Namespace Definitions
soap12 http://schemas.xmlsoap.org/wsdl/soap12/
wsaw http://www.w3.org/2006/05/addressing/wsdl
xsd http://www.w3.org/2001/XMLSchema
ihe urn:ihe:iti:xds-b:2007
rs urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0
lcm urn:oasis:names:tc:ebxml-regrep:xsd:lcm:3.0
query urn:oasis:names:tc:ebxml-regrep:xsd:query:3.0
840 These are the requirements for the Provide and Register Document Set-b transaction presented in
the order in which they would appear in the WSDL definition:
• namespace="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0", schema="rs.xsd"
• namespace="urn:ihe:iti:xds-b:2007", schemaLocation="IHEXDS.xsd"
845 • The /definitions/message/part/@element attribute of the Provide and Register Document
Set-b Request message shall be defined as
“ihe:ProvideAndRegisterDocumentSetRequest”

Supplement
______________________________________________________________________________
• The /definitions/message/part/@element attribute of the Provide and Register Document

Set-b Response message shall be defined as “rs:RegistryResponse”
850 • The /definitions/portType/operation/input/@wsaw:Action attribute for the Provide and
Register Document Set-b Request message shall be defined as
“urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-b”
• The /definitions/portType/operation/output/@wsaw:Action attribute for the Provide and
Register Document Set-b Response message shall be defined as
855 “urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-bResponse”
defined as “urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-b”
These are the requirements that affect the wire format of the SOAP message. The other WSDL
properties are only used within the WSDL definition and do not affect interoperability. Full
860 sample request and response messages are in section 3.41.5.1 Sample SOAP Messages.
A full WSDL for the Document Repository actor is found in Appendix W.1.
The <ihe:ProvideAndRegisterDocumentSetRequest/> element is defined as:
• One <lcm:SubmitObjectsRequest/> element that contains the submission set metadata
• Zero or more <ihe:Document/> elements that contain the base64encoded data for the
865 documents being submitted to the Document Repository. The <ihe:Document/> element
also includes the document id attribute (ihe:Document/@id) of type xsd:anyURI to match
the document ExtrinsicObject id in the metadata and providing the necessary linkage
By including the documents within the SOAP envelope, we allow the MTOM infrastructure to
do the proper packaging of the attachments.
870 A full XML Schema Document for the XDS.b types is included in Appendix W.3
3.41.5.1 Sample SOAP Messages

875 W3C WS-Addressing standard. The body of the SOAP message is omitted for brevity; in a real
scenario the empty element will be populated with the appropriate metadata.
3.41.5.1.1 Sample Provide and Register Document Set-b SOAP Request

880 Note to the editor: please keep the following format for the sample text – courier new, 8pt, no spacing

Supplement
______________________________________________________________________________
885 <s:Header>
<a:Action s:mustUnderstand="1">urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-
b</a:Action>
<a:MessageID>urn:uuid:6d296e90-e5dc-43d0-b455-7c1f3eb35d83</a:MessageID>
<a:ReplyTo>
890 <a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address>
</a:ReplyTo>
<a:To
s:mustUnderstand="1">http://localhost:2647/XdsService/IHEXDSRepository.svc</a:To>
</s:Header>
895 <s:Body>
<ProvideAndRegisterDocumentSetRequest
xmlns="urn:ihe:iti:xds-b:2007"
xmlns:lcm="urn:oasis:names:tc:ebxml-regrep:xsd:lcm:3.0"
900 xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0">
<lcm:SubmitObjectsRequest>
<!—Rest of SubmitObjectsRequest message goes here -->

905 </lcm:SubmitObjectsRequest>
<Document
id="Document01">UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi</Document>
</ProvideAndRegisterDocumentSetRequest>
</s:Body>
910 </s:Envelope>
3.41.5.1.2 Sample Provide and Register Document Set-b SOAP Response

915 <s:Envelope
<s:Header>
<a:Action s:mustUnderstand="1">
920 urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-bResponse
</a:Action>
<a:RelatesTo>urn:uuid:6d296e90-e5dc-43d0-b455-7c1f3eb35d83</a:RelatesTo>
</s:Header>
<s:Body>
925 <rs:RegistryResponse
status="urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success"
xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0" />
</s:Body>
</s:Envelope>
930 3.41.6 Actor Requirements

This section summarizes the responsibilities of the actors relevant to this transaction.
3.41.6.1 Document Source

An implementation of the Document Source actor shall be capable of the following operations:
• Submit a single document
935 • Submit a document as a replacement for another document already in the
registry/repository

Supplement
______________________________________________________________________________
An implementation of the Document Source actor may support one or more of the following
XDS.b options:
• Multiple Documents Submission Option. In this option the Document Source offers
940 the ability to include multiple documents in a single Submission Request.
• Document Life Cycle Management In this option the Document Source offers the
ability to perform the following operation:
• Submit a document as an addendum to another document already in the
registry/repository
945 • Submit a document as a transformation of another document already in the
registry/repository
Note: In order to support document replacement/addendum/transformation grouping with the Document Consumer may be
necessary in order to Query the registry (e.g. for UUIDs of existing document entries)
• Folder Management Option. In this option the Document Source offers the ability to
950 perform the following operation:
• Create a folder
• Add one or more documents to a folder
Note: In order to support document addition to an existing folder, grouping with the Document Consumer may be necessary
in order to Query the registry (e.g. for UUIDs of existing folder).
955 These operations are discussed in section 4.1.3.4 Other Properties of Submission Requests.
3.41.6.2 Document Repository

A Document Repository shall validate the following metadata elements received as part of a
Provide and Register transaction:
• XDSDocumentEntry.uniqueId – a submission shall be rejected if not unique within the
960 repository and the hashes of the two documents do not match. If the hashes of the
documents match, the Document Repository shall accept the duplicate document.
• XDSSubmissionSet.sourceId – a Document Repository may choose to accept
submissions only from certain sources and use this field to perform the filtering.
Note: the document URI attribute is optional for XDS.b implementations. If the XDSDocumentEntry.URI attribute is
965 present, then the Document Repository shall support the Retrieve Document transaction (ITI TF-2:3.17). More
details on this scenario are described in section 10.7.2 Example of Coexistence among XDS.a and XDS.b
Interfaces.
If the attributes “hash” and “size” are received in a Provide and Register Document Set-b [ITI-41] transaction, they shall be
ignored.
970 3.41.7 Security Requirements

Relevant security requirements are discussed in the Register Document Set-b transaction (see ITI
TF-2: 3.42.7).

Supplement
______________________________________________________________________________
3.42 Register Document Set-b

This section corresponds to transaction [ITI-42] of the IHE IT Infrastructure Technical
975 Framework. Transaction [ITI-42] is used by the Document Repository Actor to register a set of
documents with the Document Registry in XDS.b.

3.42.1 Scope
The Register Document Set-b transaction passes a Submission Request from a Document
980 Repository actor to a Document Registry actor.
A Register Document Set-b transaction shall carry:
• Metadata describing zero or more documents
• XDS Submission Set definition along with the linkage to new documents and references to
existing documents
985 • An optional XDS Folder definitions along with linkage to new or existing documents
Document Repository
Or Document
Integrated Document Registry
Source/Repository
Register
Document Set – b
Figure 3.42.2: Use Case Roles
Actor: Document Repository or Integrated Document Source/Repository

990 Role: A document storage system that submits document metadata to a Document Registry.
Actor: Document Registry
Role: A document indexing system that receives and stores document metadata.
Note: Within this transaction, the Document Repository and Integrated Document Source/Repository actors can be used
interchangeably
995 3.42.3 Referenced Standards


Supplement
______________________________________________________________________________
HL7V2 HL7 Version 2.5

Document Document
Repository Registry
Register Document Set – b Request
Register Document Set – b Response
Figure 3.42.4: Interaction Diagram
1000 3.42.4.1 Register Document Set-b Request

The Document Repository sends metadata for a set of documents to the Document Registry.

The Register Document Set-b Request message is triggered when:
• A Document Repository wants to register metadata for a set of documents it holds. These
1005 documents may have been stored in the Document Repository by a Document Consumer
(using the Provide and Register Document Set-b transaction [ITI-41]) or generated
internally by an Integrated Document Source/Repository.

The sections in Chapter 4.1 specify the mapping of XDS concepts to ebRS and ebRIM semantics
1010 and document metadata. A full example of document metadata submission can be found in
Appendix W.

Upon receipt of a Register Document Set-b Request message, the Document Registry with the
aid of the Registry Adaptor shall do the following:
1015 • Accept all valid SubmitObjectsRequests.
• Perform metadata validations
Supplement
______________________________________________________________________________
• Update the registry with the contained metadata

• Return a RegistryResponse message given the status of the operation.
If the registry rejects the metadata, then, the following shall occur:
1020 • An error is returned
• The error status includes an error message
• The request is rolled back

The Register Document Set-b Request shall be audited by the Document Repository as described
1025 in 3.14.4.1.4 Security considerations with the exception of the EventTypeCode field that shall
be replaced with EV(“ITI-42”, “IHE Transactions”, “Register Document Set-b”).
3.42.4.2 Register Document Set-b Response

The Document Registry finishes processing a Register Document Set-b Request Message and
1030 shall respond with:
• Register Document Set-b Response

The Register Document Set-b Response message shall carry the status of the requested operation
and an error message if the requested operation failed. The conditions of failure and possible
1035 error messages are given in the ebRS standard and detailed in 3.14.4.1.2.16 Registry/Repository
Error Reporting (see Change Proposal 28 which adds this section).

The Document Repository now knows that the transaction succeeded/failed and can continue.
The metadata added to the registry as a result of this transaction is now available for discovery.
1040 3.42.4.2.4 Security Considerations

The Register Document Set-b Response shall be audited by the Document Registry as described
in 3.14.4.1.4 Security considerations with the exception of the EventTypeCode field that shall
be replaced with EV(“ITI-42”, “IHE Transactions”, “Register Document Set-b”).

1045 The protocol for the Register Document Set-b transaction is based on SOAP12 (optionally
SOAP11).

Supplement
______________________________________________________________________________
wsaw http://www.w3.org/2006/05/addressing/wsdl/
These are the requirements for the Register Document Set-b transaction presented in the order in
1050 • The following types shall be imported (xsd:import) in the /definitions/types section:
• namespace="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0", schema=" rs.xsd"
• namespace="urn:oasis:names:tc:ebxml-regrep:xsd:lcm:3.0", schema=" lcm.xsd"
• The /definitions/message/part/@element attribute of the Register Document Set-b
Request message shall be defined as “lcm:SubmitObjectsRequest”
1055 • The /definitions/message/part/@element attribute of the Register Document Set-b
Response message shall be defined as “rs:RegistryResponse”
• The /definitions/portType/operation/input/@wsaw:Action attribute for the Register
Document Set-b Request message shall be defined as
“urn:ihe:iti:2007:RegisterDocumentSet-b”
1060 • The /definitions/portType/operation/output/@wsaw:Action attribute for the Register
Document Set-b Response message shall be defined as
“urn:ihe:iti:2007:RegisterDocumentSet-bResponse”
defined as “urn:ihe:iti:2007:RegisterDocumentSet-b”
1065 These are the requirements that affect the wire format of the SOAP message. The other WSDL
sample request and response messages are in section 3.42.5.1 Sample SOAP Messages.
A full WSDL for the Document Registry actor is found in Appendix W.2.

1070 The samples in the following two sections show a typical SOAP request and its relative SOAP
1075 All of the samples presented in this section are also available online on the IHE FTP site at

Supplement
______________________________________________________________________________
3.42.5.1.1 Sample Register Document Set-b SOAP Request

1080
<s:Header>
<a:Action s:mustUnderstand="1">urn:ihe:iti:2007:RegisterDocumentSet-b</a:Action>
1085 <a:MessageID>urn:uuid:1ec52e14-4aad-4ba1-b7d3-fc9812a21340</a:MessageID>
<a:ReplyTo>
</a:ReplyTo>
<a:To
1090 s:mustUnderstand="1">http://localhost:2647/XdsService/IHEXDSRegistry.svc</a:To>
</s:Header>
<s:Body>
<lcm:SubmitObjectsRequest
1095 xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0"
<!—Rest of SubmitObjectsRequest message goes here -->
1100 </lcm:SubmitObjectsRequest>
</s:Body>
</s:Envelope>
3.42.5.1.2 Sample Register Document Set-b SOAP Response

<s:Envelope
1110 xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">urn:ihe:iti:2007:RegisterDocumentSet-
bResponse</a:Action>
<a:RelatesTo>urn:uuid:1ec52e14-4aad-4ba1-b7d3-fc9812a21340</a:RelatesTo>
1115 </s:Header>
<s:Body>
<rs:RegistryResponse
status="urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success"
xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"/>
1120 </s:Body>
</s:Envelope>
3.42.6 Actor Requirements

The Document Repository actor shall:
• Make (all) the new document(s) included in the XDS Submission Set available for
1125 retrieval via the Retrieve Document Set transaction before it initiates the Register
Document Set-b Request message with the Registry actor.
This is necessary because:

Supplement
______________________________________________________________________________
• The Document Registry actor may choose to validate the successful storage of the
document(s) before acknowledging the Register Document Set-b Request transaction.
1130 • The Document Consumer actor may retrieve the document(s) before the Register
Document Set-b Response is received by the Document Repository actor.
3.42.7 Security Requirements

This transaction is generally used in profiles that require actors to be grouped with a Secure
1135 Node Actor as defined in the IHE Audit Trail and Node Authentication Integration profile. This
use of the ATNA profile in an XDS Affinity Domain does not require a centralized XDS Affinity
Domain Audit Repository Actor.
The use of ATNA along with XDS does require that each member of the XDS Affinity Domain
have audit and security mechanisms in place. See ITI TF-1: Appendix G and ITI-TF-2: Appendix
1140 K.
The individual actors involved are often members of different secure domains, as illustrated in
Figure 3.42.4.1-2. The data transfers between different secure domains need different protection
than transfers within a secure domain and shall be encrypted with TLS authentication of both
hosts.
1145 Transfers within a single secure domain may choose to omit encryption if it is unnecessary, so it
is recommended that the online transfer security mechanisms be configurable. Certificate
management and exchange is defined as part of the XDS Affinity Domain business relationships
and no IHE Integration Profile is specified at this time, see ITI TF-1: Appendix L.
Each transaction will result in audit records describing the transaction. Each secure domain has
1150 its own audit server to capture the records for the actors that are within that domain. Access to
audit records by other enterprises within the XDS Affinity Domain is managed and controlled by
the business relationship terms of the XDS Affinity Domain. There is no automatic IHE
transaction for such access.
The audit records that shall be generated (references IHE ATNA Integration Profile) by normal
1155 XDS activities are defined in the appropriate Security Consideration section of each transaction’s
Request and Response Messages sections:
Note to the editor: Please leave the following cross-references as Microsoft Word links and they will translate in PDF
hyperlinks, facilitating reading the document.
• Provide and Register Document Set-b [ITI-41]
1160 • Request: 3.41.4.1.4 Security Considerations
• Response: 3.41.4.2.4 Security Considerations
• Register Document Set-b [ITI-42]
• Request: 3.42.4.1.5 Security Considerations

Supplement
______________________________________________________________________________
1165 • Retrieve Document Set [ITI-43]

• Request: 3.43.4.1.4 Security Considerations
Security Domain B
Repository
Registry
Encrypted,
TLS,
Authenticated
Encrypted,
Security Domain C
TLS,
Security Domain A
Authenticated
Source Consumer
Repository
All Actors are part of the same Clinical Affinity Domain

1170 Figure 3.42.7-1 - Example Security Domain Relationships
3.43 Retrieve Document Set

This section corresponds to Transaction ITI-43 of the IHE Technical Framework. The Document
Consumer, Document Repository and Initiating Gateway actors use transaction ITI-43.
1175
Cross Community Access (XCA)
3.43.1 Scope
This transaction is used by the Document Consumer to retrieve a set of documents from the
Document Repository or Initiating Gateway. The Document Consumer has already obtained the

Supplement
______________________________________________________________________________
XDSDocumentEntry uniqueId and the Document Repository repositoryUniqueId from the

1180 Document Registry/Initiating Gateway by means of the Registry Stored Query transaction.
Document Repository
Document Or Initiating Gateway
Consumer Integrated Document
Source/Repository
Retrieve
Document Set
Figure 3.43.2: Use Case Roles

XDS Actors:
1185 Actor: Document Consumer
Role: Obtains document.
Actor: Document Repository or Integrated Document Source/Repository
Role: Provides documents.
XCA Actors:
1190 Actor: Initiating Gateway
Role: An Initiating Gateway which implements the XDS Affinity Domain option
retrieves a set of documents by using the Cross Gateway Retrieve transaction and/or a
Retrieve Document Set transaction.
1195 Note: Within this transaction, the Document Repository and Integrated Document Source/Repository actors can be used
interchangeably.
3.43.3 Referenced Standard

MTOM SOAP Message Transmission Optimization Mechanism http://www.w3.org/TR/soap12-mtom/

Supplement
______________________________________________________________________________
Document
Document Repository/
Consumer Initiating
Gateway
Retrieve Document Set Request
Retrieve Document Set Response
Figure 3.43.4: Interaction Diagram

1200
3.43.4.1 Retrieve Document Set Request
3.43.4.1.1Trigger Events
The Document Consumer obtains document(s) uniqueId via the Registry Stored Query
transaction. If the Registry Stored Query was sent to the Initiating Gateway the Document
1205 Consumer shall address the Retrieve Document Set to the Initiating Gateway. In this case no
resolution of repositoryUniqueId is needed by the Document Consumer. The Document
Consumer shall specify the homeCommunityId element in the Retrieve Document Set
transaction if it was found in the entry containing the uniqueId of the document being retrieved.
For more information regarding the homeCommunityId see XCA supplement section 3.38.4.1.2.
1210 Once the document(s) uniqueId have been obtained, the Document Consumer will start the
Retrieve Document Set Request with the Document Repository.

The Retrieve Document Set Request shall carry the following information:
• A required repositoryUniqueId that identifies the repository from which the document is
1215 to be retrieved. This value corresponds to XDSDocumentEntry.repositoryUniqueId.
• A required documentUniqueId that identifies the document within the repository. This
value corresponds to the XDSDocumentEntry.uniqueId.
• If available, the homeCommunityId element that identifies the community holding the
document. The homeCommunityId element shall be specified if the XDSDocumentEntry
1220 containing the uniqueId of the document contains the homeCommunityId attribute. See
XDS supplement section 3.38.4.1.2 for details.
The repositoryUniqueId associated to each document requested can be different therefore
allowing a single request to identify multiple repositories.

Supplement
______________________________________________________________________________

1225 When receiving a Retrieve Document Set Request, a Document Repository or an Initiating
Gateway shall generate a Retrieve Document Set Response containing the requested documents
or error codes if the documents could not be retrieved.
An XCA Initiating Gateway receiving the Retrieve Document Set Request shall map between the
values of the homeCommunityId attribute and Responding Gateways and/or Document
1230 Repositories. The Initiating Gateway shall use its mapping to translate from the
homeCommunityId attributes to the Responding Gateways and/or Document Repositories to be
contacted, send Cross Gateway Retrieves/Retrieve Document Set transactions to each
appropriate Responding Gateway/Document Repository, consolidate the results, and return them
to the Document Consumer.
1235 3.43.4.1.4 Security Considerations

The Retrieve Document Set Request shall be audited by the Document Consumer as described in
3.17.4.1.4 Security considerations with the exception of the EventTypeCode field that shall be
replaced with EV(“ITI-43”, “IHE Transactions”, “Retrieve Document Set”).
3.43.4.2 Retrieve Document Set Response
1240 3.43.4.2.1 Trigger Events

This message will be triggered by a Retrieve Document Set Request Message

The Retrieve Document Set Response Message shall carry the following information:
• For each of the returned documents:
1245 • A homeCommunityId. This value shall be the same as the homeCommunityId value
in the Retrieve Document Set Request Message. If the homeCommunityId value is
not present in the Retrieve Document Set Request Message, this shall not be present.
• A required repositoryUniqueId that identifies the repository from which the document
is to be retrieved. This value shall be the same as the value of the repositoryUniqueId
1250 in the original Retrieve Document Set Request Message. This value corresponds to
XDSDocumentEntry.repositoryUniqueId.
• A required documentUniqueId that identifies the document within the repository. This
value shall be the same as the documentUniqueId in the original Retrieve Document
Set Request Message. This value corresponds to the XDSDocumentEntry.uniqueId.
1255 • The retrieved document in base64binary encoded format
• The MIME type of the retrieved document
• Errors or warnings in case the document(s) could not be retrieved successfully

Supplement
______________________________________________________________________________

A Document Repository shall retrieve the document(s) indicated in the request.
1260 The Document Repository shall return the document or an error code in case the document could
not be retrieved. The conditions of failure and possible error messages are given in the ebRS
standard and detailed in 3.14.4.1.2.16 Registry/Repository Error Reporting (see Change
Proposal 28 which adds this section).

1265 The Retrieve Document Set Response shall be audited by the Document Repository as described
in 3.17.4.2.4 Security considerations with the exception of the EventTypeCode field that shall
be replaced with EV(“ITI-43”, “IHE Transactions”, “Retrieve Document Set”).

The protocol for the Retrieve Document Set is based on SOAP12 (optionally SOAP11) and
1270 MTOM.
wsaw http://www.w3.org/2006/05/addressing/wsdl/
These are the requirements for the Retrieve Document Set transaction presented in the order in
1275 • namespace="urn:ihe:iti:xds-b:2007", schema="IHEXDS.xsd"
• The /definitions/message/part/@element attribute of the Retrieve Document Set Request
message shall be defined as “ihe:RetrieveDocumentSetRequest”
• The /definitions/message/part/@element attribute of the Retrieve Document Set Response
message shall be defined as “ihe:RetrieveDocumentSetResponse”
1280 • The /definitions/portType/operation/input/@wsaw:Action attribute for the Retrieve
Document Set Request message shall be defined as
“urn:ihe:iti:2007:RetrieveDocumentSet”
• The /definitions/portType/operation/output/@wsaw:Action attribute for the Retrieve
Document Set Response message shall be defined as
1285 “urn:ihe:iti:2007:RetrieveDocumentSetResponse”

Supplement
______________________________________________________________________________

defined as “urn:ihe:iti:2007:RetrieveDocumentSet”
These are the requirements that affect the wire format of the SOAP message. The other WSDL
1290 sample request and response messages are in section 3.43.5.1 Sample SOAP Messages.
A full WSDL for the Document Repository actor is found in Appendix W.1.
The <ihe:RetrieveDocumentSetRequest/> element is defined as:
• One or more <ihe:DocumentRequest/> elements, each one representing an individual
document that the Document Consumer wants to retrieve from the Document Repository.
1295 Each <ihe:DocumentRequest/> element contains:
• A required <ihe:RepositoryUniqueId/> element that identifies the repository from
which the document is to be retrieved. This value corresponds to
• A required <ihe:DocumentUniqueId/> that identifies the document within the
1300 repository. This value corresponds to the XDSDocumentEntry.uniqueId.
• An optional <ihe:HomeCommunityId/> element that corresponds to the home
attribute of the Identifiable class in ebRIM.
This allows the Document Consumer to specify one or more documents to retrieve from the
Document Repository. The main difference with the existing XDS.a Retrieve Document
1305 transaction is that a series of IDs for the document are specified instead of a document URI.
The <ihe:RetrieveDocumentResponse/> element is defined as:
• A required /ihe:RetrieveDocumentSetResponse/rs:RegistryResponse element
• An optional sequence of <ihe:DocumentResponse/> elements containing
• A <ihe:HomeCommunityId/> element. The value of this element shall be the same as
1310 the value of the
/RetrieveDocumentSetRequest/DocumentRequest/HomeCommunityId element in the
Retrieve Document Set Request Message. If the <ihe:HomeCommunityId/> element
is not present in the Retrieve Document Set Request Message, this value shall not be
present.
1315 • A required <ihe:RepositoryUniqueId/> that identifies the repository from which the
document is to be retrieved. The value of this element shall be the same as the value
of the /RetrieveDocumentSetRequest/DocumentRequest/RepositoryUniqueId element
in the original Retrieve Document Set Request Message. This value corresponds to
1320 • A required <ihe:DocumentUniqueId/> that identifies the document within the
repository. The value of this element shall be the same as the value of the
/RetrieveDocumentSetRequest/DocumentRequest/DocumentUniqueId element in the

Supplement
______________________________________________________________________________
original Retrieve Document Set Request Message. This value corresponds to

XDSDocumentEntry.uniqueId.
1325 • A required <ihe:Document/> element that contains the retrieved document in
base64binary encoded format
• A required <ihe:mimeType/> element that indicates the MIME type of the retrieved
document
The /RetrieveDocumentSetResponse/rs:RegistryResponse/@status attributes provides the overall
1330 status of the request:
• urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success:
• all documents were retrieved successfully
• if present, /RetrieveDocumentSetResponse/rs:RegistryResponse/rs:RegistryErrorList/
rs:RegistryError elements shall only contain warnings
1335 • there shall be an equal number of
/RetrieveDocumentSetResponse/DocumentResponse elements as
/RetrieveDocumentSetRequest/DocumentRequest elements
• urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Failure
• some documents were returned successfully, others had errors
1340 • both /RetrieveDocumentSetResponse/rs:RegistryResponse/rs:RegistryErrorList/
rs:RegistryError elements and /RetrieveDocumentSetResponse/DocumentResponse
elements shall be present. The number of returned
/RetrieveDocumentSetResponse/rs:RegistryResponse/rs:RegistryErrorList/
rs:RegistryError elements where @errorCode is an error plus the number of
1345 /RetrieveDocumentSetResponse/DocumentResponse elements shall be the same as
the number of /RetrieveDocumentSetRequest/DocumentRequest elements
For each document requested in a /RetrieveDocumentSetRequest/DocumentRequest element:
• If a warning is reported when retrieving the document, then a
1350 rs:RegistryError element shall be returned with:
• @severity is urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning
• @errorCode is specified
• @codeContext contains the warning message
• @location contains the DocumentUniqueId of the document requested
1355 • The document shall be returned in an instance of
/RetrieveDocumentSetResponse/DocumentResponse/Document as base64binary encoded
data. The returned document and warning are correlated via the DocumentUniqueId.

Supplement
______________________________________________________________________________
• If an error is reported when retrieving a document, then a

1360 rs:RegistryError element shall be returned with:
• @severity is urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Error
• @errorCode is specified
• @codeContext contains the error message
• @location contains the DocumentUniqueId of the document requested
1365 • No corresponding RetrieveDocumentSetResponse/DocumentResponse element shall be
returned
• If the document is successfully retrieved (without warning) then no
rs:RegistryError element shall be present and a
1370 /RetrieveDocumentSetResponse/DocumentResponse/Document element shall be returned
containing the document as base64binary encoded data.
The /RetrieveDocumentSetResponse/rs:RegistryResponse/rs:ResponseSlotList element is not
used in this transaction.
The /RetrieveDocumentSetResponse/rs:RegistryResponse/@requestId attribute is not used in this
1375 transaction.
A full XML Schema Document for the XDS.b types is included in Appendix W.

1380 <MessageID/>, <ReplyTo/>…; these WS-Addressing headers are populated according to the
1385 3.43.5.1.1 Sample Retrieve Document Set SOAP Request

<s:Envelope
1390 xmlns:s="http://www.w3.org/2003/05/soap-envelope"
<s:Header>
<a:Action s:mustUnderstand="1">urn:ihe:iti:2007:RetrieveDocumentSet</a:Action>
<a:MessageID>urn:uuid:0fbfdced-6c01-4d09-a110-2201afedaa02</a:MessageID>
1395 <a:ReplyTo>
</a:ReplyTo>

Supplement
______________________________________________________________________________
<a:To
s:mustUnderstand="1">http://localhost:2647/XdsService/IHEXDSRepository.svc</a:To>
1400 </s:Header>
<s:Body>
<RetrieveDocumentSetRequest xmlns="urn:ihe:iti:xds-b:2007">
<DocumentRequest>
<RepositoryUniqueId>1.3.6.1.4...1000</RepositoryUniqueId>
1405 <DocumentUniqueId>1.3.6.1.4...2300</DocumentUniqueId>
</DocumentRequest>
<DocumentRequest>
<DocumentUniqueId>1.3.6.1.4...2301</DocumentUniqueId>
1410 </DocumentRequest>
</RetrieveDocumentSetRequest>
</s:Body>
</s:Envelope>
3.43.5.1.2 Sample Retrieve Document Set SOAP Response

1420 <s:Header>
<a:Action
s:mustUnderstand="1">urn:ihe:iti:2007:RetrieveDocumentSetResponse</a:Action>
<a:RelatesTo>urn:uuid:0fbfdced-6c01-4d09-a110-2201afedaa02</a:RelatesTo>
</s:Header>
1425 <s:Body>
<RetrieveDocumentSetResponse
xmlns="urn:ihe:iti:xds-b:2007"
1430 xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0"
<rs:RegistryResponse status="urn:oasis:names:tc:ebxml-
regrep:ResponseStatusType:Success"/>
<DocumentResponse>
1435 <RepositoryUniqueId>1.3.6.1.4...1000</RepositoryUniqueId>
<mimeType>text/xml</mimeType>
<Document>UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi</Document>
1440 </DocumentResponse>
<DocumentResponse>
<mimeType>text/xml</mimeType>
1445
<Document>UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi</Document>
</DocumentResponse>
</RetrieveDocumentSetResponse>
</s:Body>
1450 </s:Envelope>
3.43.6 Security Requirements

Relevant security requirements are discussed in the XDS.b “Register Document Set-b”
transaction, section 3.42.7 Security Requirements.

Supplement
______________________________________________________________________________
4 Cross-Transaction Specifications
1455 4.1 XDS Metadata

Add the following two new lines to the table:
Transaction that Reference this Chapter

Register Document Set – b ITI-42
Provide and Register Document Set – b ITI-41
4.1.3 XDS Submission Request Specification

Section 4.1.3, 3rd paragraph should read:
1460 Appropriate protocol bindings are used to transfer this content between systems when the actors
are not implemented together on the same system. The bindings are described in “Protocol
Selection” section of the appropriate transaction.
4.1.3.1 XDS Registry Submission Request

Section 4.1.3.1, last paragraph should read:
1465 This request is part of the Register Document Set (ITI-14) and Register Document Set-b (ITI-42)
transactions.
4.1.3.2 XDS Repository Submission Request

Section 4.1.3.2, paragraph after the bulleted list should read:
This request is part of the Provide and Register Document Set (ITI-15) and Provide and Register
1470 Document Set-b (ITI-41) transactions.
4.1.6.1 Document Relationships from HL7

Section 4.1.6.1, paragraph after table 4.1-2 should read:
A Document Relationship refers to any of the relationships listed in Table 4.1-2 Document
Relationships above.
1475 4.1.7 Document Definition Metadata

Add to the end of the definition of the URI attribute of XDSDocumentEntry in Table 4.1-5 the
following text:
Note: the document URI attribute is optional for XDS.b implementations. If the XDSDocumentEntry.URI attribute is
present, then the Document Repository shall support the Retrieve Document transaction (ITI TF-2:3.17). More

Supplement
______________________________________________________________________________
1480 details on this scenario are described in section 10.7.2 Example of Coexistence among XDS.a and XDS.b
Interfaces.
Add the following row after the practiceSettingCode attribute row definition in table 4.1-5:
1485 Table 4.1-5 Document Metadata Attribute Definition

XDSDocumentE Definition Source/ Data
ntry Attribute Query Type
repositoryUniqueId The globally unique identifier of the repository where the document is
stored, assigned by the Document Repository. This unique identifier for the R/R See
Document Repository may be used to identify and connect to the specific section
Document Repository where the document is stored once its metadata has 4.1.7.3
been retrieved from a Document Registry.
This repositoryUniqueId is intended to respond to the following types of
usage:
• The means to reference the Document Repository where this XDS
document is stored. The repositoryUniqueId represents an
immutable id for the Document Repository.
• The means to ensure that a XDS Document is retrieved from the
appropriate Document Repository.
Shall have a single value.
<rim:Slot name="repositoryUniqueId">
<rim:ValueList>
<rim:Value>1.3.6.1.4…</rim:Value>
</rim:ValueList>
</rim:Slot>
In the row for attribute “hash” replace the text “If this attribute is received in a Provide and Register
Document Set transaction…” with the following:
If this attribute is received in a Provide and Register Document Set [ITI-15] or Provide and
1490 Register Document Set-b [ITI-41] transactions it shall be ignored.
In the row for attribute “size” replace the text “If this attribute is received in a Provide and Register
Document Set transaction…” with the following:
If this attribute is received in a Provide and Register Document Set [ITI-15] or Provide and
1495 Register Document Set-b [ITI-41] transactions it shall be ignored.
4.1.7.3 XDSDocumentEntry.repositoryUniqueId
This is a new section

Supplement
______________________________________________________________________________
To better match the Web Services messaging architecture and provide a SOAP/MTOM binding
for the Retrieve Document Set and the Provide and Register Document Set-b transactions, it is
1500 necessary to further specify the location of the document to identify the actual Document
Repository that contains it before the Document Repository can be queried to retrieve the actual
document.
The Document Repository shall populate the following attribute in the XDSDocumentEntry
class:
1505 • repositoryUniqueId: this single-valued attribute of type OID represents the unique id of
the Document Repository that stores the document. The attribute is populated by the
Document Repository as part of the Provide and Register Document Set-b transaction.
The Document Repository id is considered immutable throughout the lifetime of the
Document Repository to which it is associated. In other words, once an id has been
1510 associated to a Document Repository it can never change. The repositoryUniqueId
attributes are defined in a community and assigned to Document Repository actors.
The Document Repository shall populate this attribute before registering documents in the
Document Registry. This allows for positive identification of the web service endopoint of the
Document Repository for the purposes of retrieving a document or set of documents.The
1515 mechanism by which the service endpoints are discovered and associated to the appropriate
actors and how that configuration is maintained is out of scope for this transaction.

Supplement
______________________________________________________________________________
Appendix W XDS.b Examples

All of the artifacts (WSDL, schemas and samples) presented in this section are also available
online on the IHE FTP site at ftp://ftp.ihe.net/IT_Infrastructure/iheitiyr5-2007-
1520 2008/Technical_Cmte/SupportMaterial/.
W.1 Document Repository WSDL

The example below shows a full informative WSDL for the Document Repository actor for the
XDS.b Integration Profile.
Of note:
1525 • The WSDL includes the normative statements defined in 3.42.5 Protocol Requirements
for the Provide and Register Document Set-b transaction [ITI-41]
• The WSDL includes the normative statements defined in 3.43.5 Protocol Requirements
for the Retrieve Document Set transaction [ITI-43]
• The WSDL includes the OPTIONAL SOAP 1.1 binding. This section can be removed if
1530 the XDS.b implementation does not support SOAP 1.1.
• The WSDL includes a sample binding to a fictitious service in
/definitions/service/port/soap:address/@location. This needs to be replaced with the
actual service location.
<?xml version="1.0" encoding="utf-8"?>
<definitions
1540 xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns="http://schemas.xmlsoap.org/wsdl/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:ihe="urn:ihe:iti:xds-b:2007"
xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"
1545 targetNamespace="urn:ihe:iti:xds-b:2007"
xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
name="XDS-b_DocumentRepository">
<documentation>IHE XDS.b Document Repository</documentation>
1550 <types>
<xsd:schema elementFormDefault="qualified">
<xsd:import namespace="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"
schemaLocation="..\schema\ebRS\rs.xsd"/>
<xsd:import namespace="urn:ihe:iti:xds-b:2007"
1555 schemaLocation="..\schema\IHE\XDS.b_DocumentRepository.xsd"/>
</xsd:schema>
</types>
<message name="RetrieveDocumentSet_Message">
<documentation>Retrieve Document Set</documentation>
1560 <part name="body" element="ihe:RetrieveDocumentSetRequest"/>
</message>
<message name="RetrieveDocumentSetResponse_Message">
<documentation>Retrieve Document Set Response</documentation>

Supplement
______________________________________________________________________________
<part name="body" element="ihe:RetrieveDocumentSetResponse"/>

1565 </message>
<message name="ProvideAndRegisterDocumentSet-b_Message">
<documentation>Provide and Register Document Set</documentation>
<part name="body" element="ihe:ProvideAndRegisterDocumentSetRequest"/>
</message>
1570 <message name="ProvideAndRegisterDocumentSet-bResponse_Message">
<documentation>Provide And Register Document Set Response</documentation>
<part name="body" element="rs:RegistryResponse"/>
</message>
<portType name="DocumentRepository_PortType">
1575 <operation name="DocumentRepository_ProvideAndRegisterDocumentSet-b">
<input message="ihe:ProvideAndRegisterDocumentSet-b_Message"
wsaw:Action="urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-b"/>
<output message="ihe:ProvideAndRegisterDocumentSet-bResponse_Message"
wsaw:Action="urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-bResponse"/>
1580 </operation>
<operation name="DocumentRepository_RetrieveDocumentSet">
<input message="ihe:RetrieveDocumentSet_Message"
wsaw:Action="urn:ihe:iti:2007:RetrieveDocumentSet"/>
<output message="ihe:RetrieveDocumentSetResponse_Message"
1585 wsaw:Action="urn:ihe:iti:2007:RetrieveDocumentSetResponse"/>
</operation>
</portType>
<binding name="DocumentRepository_Binding_Soap11" type="ihe:DocumentRepository_PortType">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
1590 <operation name="DocumentRepository_ProvideAndRegisterDocumentSet-b">
<soap:operation soapAction="urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-
b"/>
<input>
<soap:body use="literal"/>
1595 </input>
<output>
</output>
</operation>
1600 <operation name="DocumentRepository_RetrieveDocumentSet">
<soap:operation soapAction="urn:ihe:iti:2007:RetrieveDocumentSet"/>
<input>
</input>
1605 <output>
</output>
</operation>
</binding>
1610 <binding name="DocumentRepository_Binding_Soap12" type="ihe:DocumentRepository_PortType">
<soap12:binding style="document"
transport="http://schemas.xmlsoap.org/soap/http"/>
<operation name="DocumentRepository_ProvideAndRegisterDocumentSet-b">
<soap12:operation
1615 soapAction="urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-b"/>
<input>
<soap12:body use="literal"/>
</input>
<output>
1620 <soap12:body use="literal"/>
</output>
</operation>
<operation name="DocumentRepository_RetrieveDocumentSet">
<soap12:operation soapAction="urn:ihe:iti:2007:RetrieveDocumentSet"/>
1625 <input>
</input>
<output>

Supplement
______________________________________________________________________________
1630 </output>
</operation>
</binding>
<service name="DocumentRepository_Service">
<port name="DocumentRepository_Port_Soap11"
1635 binding="ihe:DocumentRepository_Binding_Soap11">
<soap:address
location="http://servicelocation/DocumentRepository_Service"/>
</port>
<port name="DocumentRepository_Port_Soap12"
1640 binding="ihe:DocumentRepository_Binding_Soap12">
<soap12:address
location="http://servicelocation/DocumentRepository_Service"/>
</port>
</service>
1645 </definitions>
W.2 Document Registry WSDL

The example below shows a full informative WSDL for the Document Registry actor for the
XDS.b Integration Profile.
1650 Of note:
• The WSDL includes the normative statements defined in 3.42.5 Protocol Requirements
for the Register Document Set-b transaction [ITI-42]
• The WSDL includes the normative statements defined in 3.18.4.1.2.7 Web Services
Transport for the Registry Stored Query transaction [ITI-18]
1655 • The WSDL includes the normative statements defined in 3.44 for the Patient Identity
Feed HL7v3 transaction [ITI-44]. This translates in three separate WSDL operations.
This part is OPTIONAL if Patient Identity Feed HL7v2 [ITI-8] is supported. Patient
Identity Feed HL7v2 [ITI-8] support does not show up in the WSDL as the transaction is
implemented using HL7 v2 messages over the MLLP protocol.
1660 • The WSDL includes the OPTIONAL SOAP 1.1 binding. This section can be removed if
the XDS.b implementation does not support SOAP 1.1.
• The WSDL includes a sample binding to a fictitious service in
/definitions/service/port/soap:address/@location. This needs to be replaced with the
actual service location.
1665
<?xml version="1.0" encoding="utf-8"?>
1670 <definitions
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns="http://schemas.xmlsoap.org/wsdl/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:ihe="urn:ihe:iti:xds-b:2007"
1675 xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:3.0"

Supplement
______________________________________________________________________________
xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"
targetNamespace="urn:ihe:iti:xds-b:2007"
xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
1680 xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
name="XDS-b_DocumentRegistry">
<documentation>IHE XDS.b Document Registry</documentation>
<types>
<xsd:schema elementFormDefault="qualified" targetNamespace="urn:ihe:iti:xds-
1685 b:2007">
<xsd:import namespace="urn:oasis:names:tc:ebxml-regrep:xsd:query:3.0"
schemaLocation="..\schema\ebRS\query.xsd"/>
<xsd:import namespace="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"
schemaLocation="..\schema\ebRS\rs.xsd"/>
1690 <xsd:import namespace="urn:oasis:names:tc:ebxml-regrep:xsd:lcm:3.0"
schemaLocation="..\schema\ebRS\lcm.xsd"/>
<xsd:import namespace="urn:hl7-org:v3"
schemaLocation="..\schema\HL7V3\multicacheschemas\PRPA_IN201301UV.xsd"/>
1695 schemaLocation="..\schema\HL7V3\multicacheschemas\PRPA_IN201302UV.xsd"/>
schemaLocation="..\schema\HL7V3\multicacheschemas\PRPA_IN201304UV.xsd"/>
schemaLocation="..\schema\HL7V3\multicacheschemas\MCCI_IN000002UV.xsd"/>
1700 </xsd:schema>
</types>
<message name="RegistryStoredQuery_Message">
<documentation>Registry Stored Query</documentation>
<part name="body" element="query:AdhocQueryRequest"/>
1705 </message>
<message name="RegistryStoredQueryResponse_Message">
<documentation>Registry Stored Query Response</documentation>
<part name="body" element="query:AdhocQueryResponse"/>
</message>
1710 <message name="RegisterDocumentSet-b_Message">
<documentation>Register Document Set - b</documentation>
<part name="body" element="lcm:SubmitObjectsRequest"/>
</message>
<message name="RegisterDocumentSet-bResponse_Message">
1715 <documentation>Register Document Set - b Response</documentation>
<part name="body" element="rs:RegistryResponse"/>
</message>
<message name="PRPA_IN201301UV_Message">
<part name="body" element="hl7:PRPA_IN201301UV"/>
1720 </message>
<part name="body" element="hl7:PRPA_IN201302UV"/>
</message>
1725 <part name="body" element="hl7:PRPA_IN201305UV"/>
</message>
<message name="MCCI_IN000002UV_Message">
<part name="body" element="hl7:MCCI_IN000002UV"/>
</message>
1730 <portType name="DocumentRegistry_PortType">
<operation name="DocumentRegistry_RegisterDocumentSet-b">
<input message="ihe:RegisterDocumentSet-b_Message"
wsaw:Action="urn:ihe:iti:2007:RegisterDocumentSet-b"/>
<output message="ihe:RegisterDocumentSet-bResponse_Message"
1735 wsaw:Action="urn:ihe:iti:2007:RegisterDocumentSet-bResponse"/>
</operation>
<operation name="DocumentRegistry_RegistryStoredQuery">
<input message="ihe:RegistryStoredQuery_Message"
wsaw:Action="urn:ihe:iti:2007:RegistryStoredQuery"/>
1740 <output message="ihe:RegistryStoredQueryResponse_Message"
wsaw:Action="urn:ihe:iti:2007:RegistryStoredQueryResponse"/>

Supplement
______________________________________________________________________________
</operation>
<operation name="DocumentRegistry_PRPA_IN201301UV">
<input message="ihe:PRPA_IN201301UV_Message"
1745 wsaw:Action="urn:hl7-org:v3:PRPA_IN201301UV"/>
<output message="ihe:MCCI_IN000002UV_Message"
wsaw:Action="urn:hl7-org:v3:MCCI_IN000002UV"/>
</operation>
1750 <input message="ihe:PRPA_IN201302UV_Message"
wsaw:Action="urn:hl7-org:v3:PRPA_IN201302UV"/>
</operation>
1755 <operation name="DocumentRegistry_PRPA_IN201304UV">
<input message="ihe:PRPA_IN201304UV_Message"
wsaw:Action="urn:hl7-org:v3:PRPA_IN201304UV"/>
1760 </operation>
</portType>
<binding name="DocumentRegistry_Binding_Soap11" type="ihe:DocumentRegistry_PortType">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
1765 <soap:operation soapAction="urn:ihe:iti:2007:RegisterDocumentSet-b"/>
<input>
</input>
<output>
1770 <soap:body use="literal"/>
</output>
</operation>
<soap:operation soapAction="urn:ihe:iti:2007:RegistryStoredQuery"/>
1775 <input>
</input>
<output>
1780 </output>
</operation>
<soap:operation soapAction="urn:hl7-org:v3:PRPA_IN201301UV"/>
<input>
1785 <soap:body use="literal"/>
</input>
<output>
</output>
1790 </operation>
<input>
1795 </input>
<output>
</output>
</operation>
<input>
</input>
1805 <output>

Supplement
______________________________________________________________________________
</output>
</operation>
</binding>
1810 <binding name="DocumentRegistry_Binding_Soap12" type="ihe:DocumentRegistry_PortType">
<soap12:binding style="document"
transport="http://schemas.xmlsoap.org/soap/http"/>
<soap12:operation soapAction="urn:ihe:iti:2007:RegisterDocumentSet-b"/>
1815 <input>
</input>
<output>
1820 </output>
</operation>
<soap12:operation soapAction="urn:ihe:iti:2007:RegistryStoredQuery"/>
<input>
</input>
<output>
</output>
1830 </operation>
<soap12:operation soapAction="urn:hl7-org:v3:PRPA_IN201301UV"/>
<input>
1835 </input>
<output>
</output>
</operation>
<soap12:operation soapAction="urn:hl7-org:v3:PRPA_IN201302UV"/>
<input>
</input>
1845 <output>
</output>
</operation>
1850 <soap12:operation soapAction="urn:hl7-org:v3:PRPA_IN201304UV"/>
<input>
</input>
<output>
</output>
</operation>
</binding>
<service name="DocumentRegistry_Service">
1860 <port name="DocumentRegistry_Port_Soap11"
binding="ihe:DocumentRegistry_Binding_Soap11">
<soap:address location="http://servicelocation/DocumentRegistry_Service"/>
</port>
<port name="DocumentRegistry_Port_Soap12"
1865 binding="ihe:DocumentRegistry_Binding_Soap12">
<soap12:address
location="http://servicelocation/DocumentRegistry_Service"/>
</port>
</service>
1870 </definitions>

Supplement
______________________________________________________________________________
W.3 XML Schemas Definition for XDS.b Types

Below is presented the full XML Schema Definition for the types used in XDS.b Document
Repository WSDL.
before and after the paragraph, tab stops every 1/8 of an inch for the first 2 inches.
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema
1880 xmlns="urn:ihe:iti:xds-b:2007"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
1885 xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"
targetNamespace="urn:ihe:iti:xds-b:2007"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xs:import namespace="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0"
1890 schemaLocation="..\ebRS\rs.xsd"/>
<xs:import namespace="urn:oasis:names:tc:ebxml-regrep:xsd:rim:3.0"
schemaLocation="..\ebRS\rim.xsd"/>
<xs:import namespace="urn:oasis:names:tc:ebxml-regrep:xsd:lcm:3.0"
schemaLocation="..\ebRS\lcm.xsd"/>
1895 <xs:import namespace="urn:oasis:names:tc:ebxml-regrep:xsd:query:3.0"
schemaLocation="..\ebRS\query.xsd"/>
<xs:complexType name="RetrieveDocumentSetRequestType">
<xs:sequence>
<xs:element name="DocumentRequest" maxOccurs="unbounded">
1900 <xs:complexType>
<xs:sequence>
<xs:element name="HomeCommunityId"
type="rim:LongName" minOccurs="0">
<xs:annotation>
1905 <xs:documentation>
This corresponds to the home
attribute of the Identifiable class in
regrep RIM (regrep-rim-3.0-
os.pdf, page 20)
1910 </xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RepositoryUniqueId"
type="rim:LongName">
1915 <xs:annotation>
<xs:documentation>
This is the
XDSDocumentEntry.repositoryUniqueId attribute in the XDS metadata
</xs:documentation>
1920 </xs:annotation>
</xs:element>
<xs:element name="DocumentUniqueId"
<xs:annotation>
This is the
XDSDocumentEntry.uniqueId attribute in the XDS metadata
</xs:documentation>
</xs:annotation>
1930 </xs:element>
</xs:sequence>
</xs:complexType>

Supplement
______________________________________________________________________________
</xs:element>
</xs:sequence>
1935 </xs:complexType>
<xs:complexType name="RetrieveDocumentSetResponseType">
<xs:sequence>
<xs:element ref="rs:RegistryResponse"/>
<xs:sequence minOccurs="0">
1940 <xs:element name="DocumentResponse" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="HomeCommunityId"
type="rim:LongName" minOccurs="0">
<xs:documentation>
This corresponds to
the home attribute of the Identifiable class
in regrep RIM (regrep-
1950 rim-3.0-os.pdf, page 20)
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RepositoryUniqueId"
1955 type="rim:LongName">
<xs:annotation>
<xs:documentation>
This is the
XDSDocumentEntry.repositoryUniqueId attribute in the XDS metadata
</xs:annotation>
</xs:element>
<xs:element name="DocumentUniqueId"
<xs:documentation>
This is the
XDSDocumentEntry.uniqueId attribute in the XDS metadata
</xs:documentation>
1970 </xs:annotation>
</xs:element>
<xs:element name="mimeType"
type="rim:LongName"/>
<xs:element name="Document"
1975 type="xs:base64Binary"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
1980 </xs:sequence>
</xs:complexType>
<xs:element name="RetrieveDocumentSetRequest" type="RetrieveDocumentSetRequestType"/>
<xs:element name="RetrieveDocumentSetResponse" type="RetrieveDocumentSetResponseType"/>
<xs:complexType name="ProvideAndRegisterDocumentSetRequestType">
1985 <xs:sequence>
<xs:element ref="lcm:SubmitObjectsRequest"/>
<xs:sequence minOccurs="0">
<xs:element name="Document" maxOccurs="unbounded">
<xs:complexType>
1990 <xs:simpleContent>
<xs:extension base="xs:base64Binary">
<xs:attribute name="id"
type="xs:anyURI" use="required">
<xs:annotation>
This
corresponds to the ExtrinsicObject id in the eb RIM metadata and

Supplement
______________________________________________________________________________
provides a
linkage between the actual document data and its metadata
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
2005 </xs:complexType>
</xs:element>
</xs:sequence>
</xs:sequence>
</xs:complexType>
2010 <xs:element
name="ProvideAndRegisterDocumentSetRequest"
type="ProvideAndRegisterDocumentSetRequestType"/>
</xs:schema>
2015 W.4 ebRIM/ebRS 3.0 Document Submission Metadata Sample

The example below shows the full xml instance for the submission of a single Routine Physical
document for the patient John Doe:
<lcm:SubmitObjectsRequest
2020 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:ebxml-regrep:xsd:lcm:3.0
../schema/ebRS/lcm.xsd"
2025 xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:3.0">
<rim:RegistryObjectList>
<rim:ExtrinsicObject
id="Document01" mimeType="text/xml"
objectType="urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1">
2030 <rim:Slot name="creationTime">
<rim:ValueList>
<rim:Value>20051224</rim:Value>
</rim:ValueList>
</rim:Slot>
2035 <rim:Slot name="languageCode">
<rim:ValueList>
<rim:Value>en-us</rim:Value>
</rim:ValueList>
</rim:Slot>
2040 <rim:Slot name="serviceStartTime">
<rim:ValueList>
</rim:ValueList>
</rim:Slot>
2045 <rim:Slot name="serviceStopTime">
<rim:ValueList>
</rim:ValueList>
</rim:Slot>
2050 <rim:Slot name="sourcePatientId">
<rim:ValueList>
<rim:Value>ST-
1000^^^&1.3.6.1.4.1.21367.2003.3.9&ISO</rim:Value>
</rim:ValueList>
2055 </rim:Slot>
<rim:Slot name="sourcePatientInfo">
<rim:ValueList>

Supplement
______________________________________________________________________________
<rim:Value>PID-3|ST-
1000^^^&1.3.6.1.4.1.21367.2003.3.9&ISO</rim:Value>
2060 <rim:Value>PID-5|Doe^John^^^</rim:Value>
<rim:Value>PID-7|19560527</rim:Value>
<rim:Value>PID-8|M</rim:Value>
<rim:Value>PID-11|100 Main
St^^Metropolis^Il^44130^USA</rim:Value>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="Physical"/>
</rim:Name>
2070 <rim:Description/>
<rim:Classification id="cl01"
classificationScheme="urn:uuid:93606bcf-9494-43ec-9b4e-
a7748d1a838d"
classifiedObject="Document01">
2075 <rim:Slot name="authorPerson">
<rim:ValueList>
<rim:Value>Gerald Smitty</rim:Value>
</rim:ValueList>
</rim:Slot>
2080 <rim:Slot name="authorInstitution">
<rim:ValueList>
<rim:Value>Cleveland Clinic</rim:Value>
<rim:Value>Parma Community</rim:Value>
</rim:ValueList>
2085 </rim:Slot>
<rim:Slot name="authorRole">
<rim:ValueList>
<rim:Value>Attending</rim:Value>
</rim:ValueList>
2090 </rim:Slot>
<rim:Slot name="authorSpeciality">
<rim:ValueList>
<rim:Value>Orthopedic</rim:Value>
</rim:ValueList>
2095 </rim:Slot>
</rim:Classification>
classificationScheme="urn:uuid:41a5887f-8865-4c09-adf7-
e362475b143a"
2100 classifiedObject="Document01" nodeRepresentation="History
and Physical">
<rim:Slot name="codingScheme">
<rim:ValueList>
<rim:Value>Connect-a-thon classCodes</rim:Value>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="History and Physical"/>
</rim:Name>
2110 </rim:Classification>
classificationScheme="urn:uuid:f4f85eac-e6cb-4883-b524-
f2705394840f"
classifiedObject="Document01"
2115 nodeRepresentation="1.3.6.1.4.1.21367.2006.7.101">
<rim:ValueList>
<rim:Value>Connect-a-thon
confidentialityCodes</rim:Value>
</rim:Slot>
<rim:Name>

Supplement
______________________________________________________________________________
<rim:LocalizedString value="Clinical-Staff"/>
</rim:Name>
2125 </rim:Classification>
classificationScheme="urn:uuid:a09d5840-386c-46f2-b5ad-
9c3699a4309d"
classifiedObject="Document01" nodeRepresentation="CDAR2/IHE
2130 1.0">
<rim:ValueList>
<rim:Value>Connect-a-thon formatCodes</rim:Value>
</rim:ValueList>
2135 </rim:Slot>
<rim:Name>
<rim:LocalizedString value="CDAR2/IHE 1.0"/>
</rim:Name>
2140 <rim:Classification id="cl05"
classificationScheme="urn:uuid:f33fb8ac-18af-42cc-ae0e-
ed0b0bdb91e1"
classifiedObject="Document01"
nodeRepresentation="Outpatient">
2145 <rim:Slot name="codingScheme">
<rim:ValueList>
healthcareFacilityTypeCodes</rim:Value>
</rim:ValueList>
2150 </rim:Slot>
<rim:Name>
<rim:LocalizedString value="Outpatient"/>
</rim:Name>
classificationScheme="urn:uuid:cccf5598-8b07-4b77-a05e-
ae952c785ead"
classifiedObject="Document01" nodeRepresentation="General
Medicine">
2160 <rim:Slot name="codingScheme">
<rim:ValueList>
practiceSettingCodes</rim:Value>
</rim:ValueList>
2165 </rim:Slot>
<rim:Name>
<rim:LocalizedString value="General Medicine"/>
</rim:Name>
classificationScheme="urn:uuid:f0306f51-975f-434e-a61c-
c59651d33983"
classifiedObject="Document01" nodeRepresentation="34108-1">
2175 <rim:ValueList>
<rim:Value>LOINC</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Name>
2180 <rim:LocalizedString value="Outpatient Evaluation And
Management"/>
</rim:Name>
<rim:ExternalIdentifier id="ei01" registryObject="Document01"
2185 identificationScheme="urn:uuid:58a6f841-87b3-4a3e-92fd-
a8ffeff98427"
value="SELF-5^^^&1.3.6.1.4.1.21367.2005.3.7&ISO">

Supplement
______________________________________________________________________________
<rim:Name>
<rim:LocalizedString value="XDSDocumentEntry.patientId"/>
2190 </rim:Name>
</rim:ExternalIdentifier>
<rim:ExternalIdentifier id="ei02" registryObject="Document01"
identificationScheme="urn:uuid:2e82c1f6-a085-4c72-9da3-
8640a32e42ab"
2195 value="1.3.6.1.4.1.21367.2005.3.9999.32">
<rim:Name>
<rim:LocalizedString value="XDSDocumentEntry.uniqueId"/>
</rim:Name>
2200 </rim:ExtrinsicObject>
<rim:RegistryPackage id="SubmissionSet01">
<rim:Slot name="submissionTime">
<rim:ValueList>
</rim:Slot>
<rim:Name>
<rim:LocalizedString value="Physical"/>
</rim:Name>
2210 <rim:Description>
<rim:LocalizedString value="Annual physical"/>
</rim:Description>
classificationScheme="urn:uuid:a7058bb9-b4e4-4307-ba5b-
2215 e3f0ab85e12d"
classifiedObject="SubmissionSet01">
<rim:Slot name="authorPerson">
<rim:ValueList>
<rim:Value>Sherry Dopplemeyer</rim:Value>
</rim:Slot>
<rim:Slot name="authorInstitution">
<rim:ValueList>
<rim:Value>Cleveland Clinic</rim:Value>
2225 <rim:Value>Berea Community</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Slot name="authorRole">
<rim:ValueList>
2230 <rim:Value>Primary Surgon</rim:Value>
</rim:ValueList>
</rim:Slot>
<rim:Slot name="authorSpeciality">
<rim:ValueList>
2235 <rim:Value>Orthopedic</rim:Value>
</rim:ValueList>
</rim:Slot>
2240 classificationScheme="urn:uuid:aa543740-bdda-424e-8c96-
df4873be8500"
classifiedObject="SubmissionSet01"
nodeRepresentation="History and Physical">
contentTypeCodes</rim:Value>
</rim:ValueList>
</rim:Slot>
2250 <rim:Name>
<rim:LocalizedString value="History and Physical"/>
</rim:Name>

Supplement
______________________________________________________________________________
<rim:ExternalIdentifier id="ei03" registryObject="SubmissionSet01"
2255 identificationScheme="urn:uuid:96fdda7c-d067-4183-912e-
bf5ee74998a8"
value="1.3.6.1.4.1.21367.2005.3.9999.33">
<rim:Name>
<rim:LocalizedString value="XDSSubmissionSet.uniqueId"/>
2260 </rim:Name>
identificationScheme="urn:uuid:554ac39e-e3fe-47fe-b233-
965d2a147832" value="3670984664">
2265 <rim:Name>
<rim:LocalizedString value="XDSSubmissionSet.sourceId"/>
</rim:Name>
2270 identificationScheme="urn:uuid:6b5aea1a-874d-4603-a4bc-
96a0a7b38446"
value="SELF-5^^^&1.3.6.1.4.1.21367.2005.3.7&ISO">
<rim:Name>
<rim:LocalizedString value="XDSSubmissionSet.patientId"/>
2275 </rim:Name>
</rim:RegistryPackage>
<rim:Classification id="cl10" classifiedObject="SubmissionSet01"
classificationNode="urn:uuid:a54d6aa5-d40d-43f9-88c5-
2280 b4633d873bdd"/>
<rim:Association id="as01" associationType="HasMember"
sourceObject="SubmissionSet01"
targetObject="Document01">
<rim:Slot name="SubmissionSetStatus">
<rim:Value>Original</rim:Value>
</rim:ValueList>
</rim:Slot>
</rim:Association>
2290 </rim:RegistryObjectList>
</lcm:SubmitObjectsRequest>


IHE ITI TF Supplement XDS-2

Uploaded by

Copyright:

Available Formats

IHE ITI TF Supplement XDS-2

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

IHE ITI TF Supplement XDS-2

Uploaded by

Copyright:

Available Formats

ACC, HIMSS and RSNA

Integrating the Healthcare Enterprise

IHE IT Infrastructure Technical Framework

Cross-Enterprise Document Sharing-b (XDS.b)

Draft for Trial Implementation

Copyright © 1997-2007: ACC/HIMSS/RSNA

Trial Implementation Version 1

Trial Implementation Version 2

Trial Implementation Version 3

Trial Implementation Version 4

• W3C Web Services Description Language (WSDL) 1.1 [WSDL11]

150 1.2 Scope of Supplement

175 1.3 Open Issues and Questions

Trial Implementation Version 5

Trial Implementation Version 6

1.4 Closed Issues

Trial Implementation Version 7

Trial Implementation Version 8

Trial Implementation Version 9

• Resolution: added optional homeCommunityId element in the Retrieve Document

Trial Implementation Version 10

1.5 Profile Abstract

Trial Implementation Version 11

Trial Implementation Version 12

365 Volume I – Integration Profiles

10 Cross-Enterprise Document Sharing

10.1 Actors/ Transactions

Trial Implementation Version 13

Patient Identity Source

Patient Identity Feed [ITI-8]

Document Registry Document Consumer

↑ Register Document Set – b [ITI-42]

Provide&Register Retrieve Document Set [ITI-43]

Integrated Document Source/Repository

Table 10.1-1b XDS.b - Actors and Transactions

Trial Implementation Version 14

400 10.1.2.3 Query Registry

10.1.2.4 Retrieve Document

10.1.2.5 Patient Identity Feed

430 10.1.2.7 Retrieve Document Set

Trial Implementation Version 15

435 10.2 Integration Profile Options

Table 10.2-1b XDS.b - Actors and Options

10.4.12 Transport Modes

Trial Implementation Version 16

2. The SMTP protocol shall be used for off-line operation.

10.6 Patient Identifier Communication Requirements

10.7 Migration and Coexistence Scenarios

10.7.1 Example of Migration from XDS.a to XDS.b Interfaces

10.7.2 Example of Coexistence among XDS.a and XDS.b Interfaces

10.7.3 Requirements When Choosing to Support Both XDS.a and XDS.b

Trial Implementation Version 18

525 Appendix B: Transaction Description

Appendix E: Cross Profile Consideration

Trial Implementation Version 19

Trial Implementation Version 20

555 3.14 Register Document Set

XDSRegistryError Internal Registry/Repository Error. P,R,Q,SQ

Add the following table and text: