5
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
Nationwide Health Information Network (NHIN)
Service Interface Specification
CAQH CORE X12 Document
Submission Service Interface
Specifications
V 1.0
3/6/2012
Page 1 of 26
5
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
Name
Melanie CombsDyer
Daniel Kalwa
Manoj Chaganti
Donna Jones
Sacchidanand Girde
Raja Kailar
Gary Beatty
Mary Lynn
Bushman
Rachel Foerster
Kevin Castellow
Contributors
Organization
esMD - Deputy Director & Business
Owner
esMD - Technical Lead & Business Owner
esMD - esMD Chief Architect
esMD Work Group Coordinator
esMD – Health IT Specialist
CAQH CORE Consultants
CMS – OFM/PCG
CAQH CORE Consultants
Boundary Information
Group
Business Networks
International (BNETAL)
ASC X12 Expert
CAQH CORE and ASC X12 Expert
CAQH CORE Consultants
CMS – OFM/PCG
CMS/QSSI
CMS/Signature Consulting
CMS/QSSI
Business Networks
International (BNETAL)
CMS/Consultant
Wellpoint
Area
Specification
Specification
Specification
Specification
Specification
Specification
Specification
Specification
Specification
Specification
Document Change History
Version
0.1
0.2
Date
07/15/2011
07/26/2011
0.3
08/01/2011
0.4
11/30/2011
12/13/2011
0.5
12/16/2011
12/19/2011
0.6
01/04/2011
01/07/2011
Changed By
Manoj Chaganti
Manoj Chaganti,
Mary Lynn, Kevin
Castellow, Raja
Kailar, Gary
Beaty, Donna
Jones
Raja Kailar, Gary
Beaty, Manoj
Chaganti, Donna
Jones
Manoj Chaganti
Sacchidanand
Girde
Rachel Foerster
Raja Kailar
Kevin Castellow
Raja Kailar
Manoj Chaganti
Laura Higdon
Donna Jones
Manoj Chaganti
Donna Jones
Raja Kailar
Gary Beatty
Sacchidanand
Girde
Items Changed Since Previous Version
Initial Draft
Review and updated the standards.
Provided the sample message
Updated the WSDL
Updated the Metadata
Reviewed the content and suggested change to schema,
5010, section 3.x
-Updated the specification to accommodate both the
CAQH Real time and CAQH Generic Batch mode
(equivalent to Deferred)
- Updates to make terminology and references to CAQH
CORE Connectivity Rule consistent.
Cleaned up/Removed the MTOM message in the CAQH
CORE Real-time envelope under payload sample
messages.
Removed the footer with the batch mode only details.
Added the URL for the WSDL and scheme messages.
Review and format document.
Reviewed and changed the various X12 related namings.
Updated the diagrams.
Fixed the content based on various Reviewers
comments.
Page 2 of 26
5
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
0.7
01/13/2012
Rachel Foerster
Raja Kailar
Manoj Chaganti
0.8
1/18/2012
0.9
1/24/2012
1.0
3/6/2012
Rachel Foerster
Raja Kailar
Gary Beatty
Donna Jones
Rachel Foerster
Raja Kailar
Gary Beatty
Donna Jones
ONC
Version
Date
0.9
1/24/2012
0.9
3/1/2012
Revised explanations of Payload Types in Table 1.
Removed two assumptions and replaced with a single
constraint requiring use of SOAP Envelope. Corrected
payload type values in the examples. Added clarifying
language in the Focus of Specification, to clarify scope of
CORE Connectivity Rule usage within this specification.
Reviewed the content.
Reviewed and updated:
• Line 274, Table 1, changed AN to XN
• Line 277, Figure 5, changed AN to XN
Finalized for submission to Exchange Coordinating
Committee
Finalized for Production Publication
Document Approval
Approved By
Melanie CombsDyer
NHIN
Coordinating
Committee
Role
Deputy Director
CMS / OFM / Provider Compliance Group
Approves NHIN Specifications for Production Use
Page 3 of 26
5
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
Table of Contents
1
PREFACE .............................................................................................................................................. 6
1.1
1.2
1.3
1.4
1.5
1.6
2
INTERFACE DESCRIPTION ................................................................................................................. 8
2.1
2.2
2.3
2.4
2.5
3
INTRODUCTION.................................................................................................................................. 6
INTENDED AUDIENCE......................................................................................................................... 6
FOCUS OF THIS SPECIFICATION.......................................................................................................... 6
REFERENCED DOCUMENTS AND STANDARDS ..................................................................................... 7
DEVIATIONS FROM STANDARDS ......................................................................................................... 7
RELATIONSHIP TO OTHER NHIN SPECIFICATIONS ............................................................................... 7
DEFINITION ....................................................................................................................................... 8
TRANSACTION STANDARD.................................................................................................................. 8
ASSUMPTIONS .................................................................................................................................. 8
TECHNICAL PRE-CONDITIONS ............................................................................................................ 9
TECHNICAL POST-CONDITIONS........................................................................................................... 9
INTERFACE DEFINITION ..................................................................................................................... 9
3.1
PHASE II CAQH CORE 270: CONNECTIVITY RULE WITH ASC X12 TRANSACTIONS: ............................ 9
3.2
MULTIPLE DOCUMENTS SUBMISSION ................................................................................................ 10
3.3
CAQH CORE REAL-TIME MODE (SYNCHRONOUS) AND CAQH CORE GENERIC BATCH MODE
(DEFERRED) MESSAGING ........................................................................................................................... 10
3.3.1
CAQH CORE Real-time mode (Synchronous) Messaging Workflow ................................... 11
3.3.2
CAQH CORE Generic Batch Mode Messaging Workflow .................................................... 12
3.4
CAQH CORE CONNECTIVITY METADATA ELEMENTS ....................................................................... 13
3.5
CONNECTIVITY RULE ....................................................................................................................... 14
3.6
SOAP + WSDL BASED MESSAGE ENVELOPE .................................................................................. 14
3.7
SAML ASSERTION BASED USER AUTHENTICATION AND AUTHORIZATION ........................................... 15
4
ERROR HANDLING ............................................................................................................................ 15
5
AUDITING ............................................................................................................................................ 15
6
APPENDIX A: SAMPLE MESSAGES ................................................................................................ 16
6.1
CAQH CORE CONNECTIVITY REAL-TIME MODE ............................................................................... 16
6.1.1
Sample CORE SOAP + WSDL Real-time Request .............................................................. 16
6.1.2
Sample CORE SOAP + WSDL Real-time Response ........................................................... 20
6.2
CAQH CORE CONNECTIVITY GENERIC BATCH MODE ...................................................................... 20
6.2.1
Sample CORE SOAP + WSDL Batch mode Request .......................................................... 20
6.2.2
Sample CORE SOAP + WSDL Batch mode Response........................................................ 24
7
APPENDIX B: WSDL .......................................................................................................................... 26
7.1
PHASE II CAQH CORE 270: CONNECTIVITY RULE VERSION 2.2.0 WSDL ........................................ 26
PHASE II CAQH CORE 270: CONNECTIVITY RULE VERSION 2.2.0 PROVIDES A WSDL DEFINITION. .............. 26
8
APPENDIX C: XML SCHEMA (XSD).................................................................................................. 26
8.1
PHASE II CAQH CORE 270: CONNECTIVITY RULE VERSION 2.2.0 COMPLIANT XML SCHEMA
SPECIFICATION .......................................................................................................................................... 26
List of Figures
Figure 1: Actors and Transaction (Any Transactions) involved in in this specification service .................. 10
Figure 2: End to End message flow ............................................................................................................ 10
Page 4 of 26
5
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
Figure 3: CAQH CORE Real-time mode (Synchronous) Messaging workflow .......................................... 11
Figure 4: CAQH CORE Generic Batch Mode Messaging workflow............................................................ 12
Figure 5: (Table 1-1) Payload Type and Description of Components ........................................................ 14
List of Tables
Table 1: CAQH CORE Connectivity Metadata Elements ........................................................................... 13
Table 2: Error Handling ............................................................................................................................... 15
Page 5 of 26
5
1
2
1
3
4
1.1
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
Preface
Introduction
5
6
7
8
9
10
This NHIN CAQH CORE X12 Document Submission Service Interface Specifications
constitute the core services of an operational Nationwide Health Information Network
(NHIN) with Accredited Standards Committee (ASC) ANSI X12 Transactions. They are
intended to provide a standard set of service interfaces that enable the exchange of
interoperable health information amongst a group of peer nodes referred to as
Nationwide Health Information Exchanges (NHIEs).
11
12
13
14
15
NHIN already defines services such as Document Submission service for IHE XDR Specification. This
specification will add the ASC ANSI X12 Document Submission Service in addition to XDR Document
Submission Service and these other services. It is important to note that the functional services of this
specification rest on a foundational set of defined core services that includes the following:
16
17
18
19
20
21
22
1.
2.
3.
4.
5.
NHIN Trial Implementations Message Platform Service Interface Specification,
NHIN Trial Implementations Authorization Framework Service Interface Specification,
NHIN Trial Implementations Audit Log Query Service Interface Specification,
NHIN Trial Implementations NHIE Service Registry Interface Specification,
NHIN Trial Implementations Authorized Case Follow-Up Service Interface Specification.
23
24
1.2
Intended Audience
25
26
27
28
29
30
31
32
33
34
The primary audiences for the NHIN CAQH CORE X12 Document Submission Service
Interface Specifications are the individuals responsible for implementing software
solutions that realize these interfaces for a NHIE that will exchange ASC ANSI X12
transactions. After reading this specification, one should have an understanding of the
context in which the service interface is meant to be used, the behavior of the interface,
the underlying reference standards and specifications, the Web Services Description
Language (WSDLs) used to define the service, any Extensible Markup Language (XML)
schemas used to define the content, and what “compliance” means from an
implementation testing perspective.
35
1.3
Focus of this Specification
36
37
38
39
40
41
This document defines the NHIN X12 Document Submission Service Interface
Specification. The purpose of this specification is to provide the ability to exchange
ASC X12 Administrative Transactions between one or more NHIEs via the Internet
using the Phase II CAQH CORE Connectivity Rule web services over SOAP envelope
configuration with ASC X12 submission payload. While the CAQH CORE Connectivity
Page 6 of 26
5
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
42
43
44
45
46
47
48
49
50
51
Rule supports the exchange of any ASC X12 Administrative Transaction between any
two organizations, this specification is limited to the use of the Phase II CAQH CORE
Connectivity Rule between any two NHIEs. This is a different model of exchange than
subscription (see the NHIN Trial Implementations Health Information Event Messaging
Service Specification for details on this approach) because the sender decides to whom
the data should go and the receiver receives data on an appropriate available endpoint
from the sources it authorizes (refer to the Authorization Framework Service Interface
Specification). Also, this uses a different payload and model of exchange compared to
IHE XDR Document Submission based on ASC X12 Transactions.
52
53
54
55
1.4
Referenced Documents and Standards
The following documents and standards were referenced during the development of this specification.
Specific deviations from or constraints upon these standards are identified below.
56
1) Org/SDO name: CAQH CORE
1
57
Reference # / Spec Name: Phase II CORE 270 : Connectivity Rule Version 2.2.0
58
Version #: v2.2.0 (March 28, 2011)
59
NHIN Deviations or Constraints:
60

Use of TLS 1.0 as per Messaging Platform Specification
61

Use of SAML Assertions as per NHIN Authorization Framework Specification
62

Use of SOAP 1.1+WSDL Envelope Standard (i.e., Envelope B standard)
63
Underlying Specs:
•
64
CAQH CORE Phase I and II Connectivity Operating Rules
Link: http://www.caqh.org/COREv5010.php
65
66
67
68
69
1.5
Deviations from Standards
70
71
Specific deviations or constraints from the above-mentioned standards are identified.
72
73
1.6
74
75
76
77
78
In some cases, the data exchanged between NHIEs will involve the communication of
individually identifiable health information (defined in 45 CFR Parts 160, 162, and 164).
When individually identifiable information is exchanged, then each NHIE must have a
common understanding of the claim/patient’s identity.
Relationship to Other NHIN Specifications
1
Note: Phase II CORE 270: Connectivity Rule Version 2.2.0 name is the rule number and not a reference to X12 270
eligibility transaction. The Phase II CORE 270: Connectivity Rule Version 2.2.0 is payload agnostic, and is designed
to carry any X12 administrative transaction payload as well as any other non-X12 payload.
Page 7 of 26
5
79
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
This specification is related to other NHIN specifications as described below:
80
81
82
83
84
85
•
Messaging Platform – specifies a base set of messaging standards and web
service protocols which must be implemented by each NHIN node and applies to
all transactions including this transaction. All NHIN messages sent between
NHIN systems are Simple Object Access Protocol (SOAP) messages over
Hypertext Transfer Protocol (HTTP) using web services and all messages must
be encrypted and digitally signed.
86
87
88
89
•
Authorization Framework – defines the exchange of metadata used to
characterize each NHIN request. The purpose of that exchange is to provide the
responder with the information needed to make an authorization decision for the
requested function.
90
91
92
93
94
95
•
Services Registry – enables computer systems to discover and consume
services. For NHIN, the Services Registry is a Universal Description Discovery
and Integration (UDDI) web-services registry. This registry lists NHIN services
which, in this case, will consist of a single entry for endpoints that will respond to
X12 messages as defined herein.
96
2
97
2.1
Interface Description
Definition
98
99
100
101
102
In this interface specification, a “document” refers to the format of clinical data as it is
transferred between NHIEs, and not as it is stored within an NHIE or electronic health
record (EHR) system. A NHIE and its participating organizations may store clinical data
in whatever format or repository it chooses. Specifically, a “document” transferred
between NHIEs need not meet the criteria for persistence, stewardship, etc.
103
104
“Initiating NHIE” refers to a document source NHIE that initiates X12 document
submission transaction for one or more available documents on a particular patient.
105
106
107
“Receiving NHIE” refers to document recipient NHIE that receives X12 document
submission transaction.
108
109
2.2
110
111
112
This interface identifies the Phase II CAQH CORE 270 Connectivity Rule Version 2.2.0
as the standard for NHIN X12 Document Submission Service Specification.
113
114
115
2.3
116
117
Transaction Standard
Assumptions
The following assumptions underlie this specification:
•
There is no central or federated service that performs transactions across
multiple HIOs/HIHs.
Page 8 of 26
5
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
118
119
120
•
The requesting NHIN Gateway shall be responsible for using the UDDI Services
Registry to determine which of these Services they will call for any specific X12
transaction request message.
121
122
123
124
•
Security Assertion Markup Language (SAML) Authorization assertion(s) will be
included in the request message as specified by the Messaging Platform
specification.
125
126
2.4
Technical Pre-conditions
127
The following technical pre-conditions exist for this interface specification:
128
129
130
•
The initiating HIH/HIOs must publish in the NHIN UDDI Services Registry data
containing descriptive and technical information about their NHIN CAQH CORE
X12 Document Submission Service representing their Response endpoints.
131
132
133
•
The receiving HIH/HIOs must publish in the NHIN UDDI Services Registry data
containing descriptive and technical information about their NHIN CAQH CORE
X12 Document Submission Service representing their Request endpoints.
134
135
136
•
The initiating and receiving HIH/HIO to which the query will be directed have
been selected, and applicable service end points have been identified using the
NHIN UDDI Services Registry.
137
138
139
140
•
The Initiating and receiving HIH/HIOs must include SAML assertions containing
user-level credentials sufficient to enable authentication and/or authorization by
the receiving HIH/HIO system.
141
142
2.5
Technical Post-conditions
143
144
The following technical post-conditions will result after the execution of this interface
specification:
145
146
•
Errors encountered will be handled and included in the response as specified in
Phase II CAQH CORE 270: Connectivity Rule Version 2.2.0.
147
148
149
150
151
•
The response to this request is a payload containing an X12 Transaction
message and some metadata describing the transaction such as Payload ID,
Sender ID, Receiver ID, etc. (required CAQH CORE Metadata will be described
in section 3.3.2 in detail).
152
3
153
154
3.1
Interface Definition
Phase II CAQH CORE 270: Connectivity Rule with ASC X12 Transactions:
Page 9 of 26
5
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
155
156
157
This transaction is described in Phase II CAQH CORE 270: Connectivity Rule Version
2.2.0 section 4.2.2. The figure below illustrates the actors and transaction (Any
Transactions) involved in in this specification service Request/Response transaction.
158
159
160
Figure 1: Actors and Transaction (Any Transactions) involved in this specification service
161
162
163
164
Following is the sample end to end flow between the systems behind the initiating and
receiving HIH/HIO’s.
165
166
Figure 2: End to End message flow
167
168
169
170
171
172
173
174
3.2
175
176
177
3.3
Multiple Documents Submission
This interface supports the ability to include multiple documents for a single patient in a single Submission
Transaction by adding multiple documents in the bin segments of any ASC X12 transaction.
CAQH CORE Real-time mode (Synchronous) and CAQH CORE Generic Batch Mode
(Deferred) Messaging
Page 10 of 26
5
178
179
180
181
182
183
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
Receiving NHIEs must support asynchronous deferred document submission
transactions in Batch Mode of Phase II CAQH CORE 270: Connectivity Rule Version
2.2.0; however, synchronous (immediate) document submission transactions may also
be optionally supported with in Real-time Mode of CAQH CORE 270: Connectivity Rule
Version 2.2.0, or may restrict submissions to use either Batch or Real-time messaging
mode based on agreements with its trading partners.
184
185
186
187
188
189
190
191
192
193
194
195
When not restricted by the Receiving NHIE, the Initiating NHIE may choose whether to
use Phase II CAQH CORE 270: Connectivity Rule Version 2.2.0 Batch mode or Realtime mode interactions. A Receiving NHIE that supports both Phase II CAQH CORE
270: Connectivity Rule Version 2.2.0 Batch mode and Real-time modes would set up
two services: One for Batch and one for Real-time. Additionally, the Initiating NHIE
would provide a response service entry point by which the Batch mode response is
delivered from Receiving NHIE in a separate HTTP Session to the Initiating NHIE. The
Synchronous (Real-Time mode) and Deferred (Batch mode) Messaging Workflow are
defined in the NHIN Messaging Platform Specification and Phase II CAQH CORE 270:
Connectivity Rule Version 2.2.0 implementation guide documents.
196
197
198
199
200
201
202
203
204
205
206
207
3.3.1
208
209
210
211
212
213
214
215
216
217
218
CAQH CORE Real-time mode (Synchronous) Messaging Workflow
The Initiating NHIE and Receiving NHIE handle the CAQH CORE Real-time mode Document Submission
transaction in a single in-out message exchange pattern as defined in the NHIN Messaging Platform
Specification document.
In a CAQH CORE Real-time mode - the NHIN CAQH CORE X12 Document Submission is a request and
synchronous response message as shown in the diagram below:
Figure 3: CAQH CORE Real-time mode (Synchronous) Messaging workflow
In other words, the Initiating NHIE sends a CAQH CORE Real-time mode Document submission request
to the Receiving NHIE and waits for a response to come back on the same HTTP connection. The
receiving NHIE receives the CAQH CORE Real-time mode Document submission request and processes
it in real-time and sends back the response to the Initiating NHIE on that same HTTP connection.
CAQH CORE SOAP Real-time interaction does not support Message Transmission Optimization
Mechanism (MTOM) -only Batch interactions support MTOM. For Real-time using SOAP envelope, the
payload is a string, or if binary (that contain non-printable characters) must be Base64 encoded.
Page 11 of 26
5
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
219
220
3.3.2
CAQH CORE Generic Batch Mode Messaging Workflow
221
222
223
CAQH CORE Generic Batch mode Messaging workflow is supported by this
specification to solve the issues of extreme latency involved in processing of ASC X12
Document Submission request and the attached payload(s) associated with the request.
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
In the message interaction diagram below, each request and corresponding response
(e.g., 1 and 1a) is a CAQH CORE Generic Batch. The combination of three Generic
Batch message interactions shown below is equivalent to IHE’s Deferred Document
Submission interaction.
The Initiating NHIE and Receiving NHIE handle the CAQH CORE Batch mode ASC X12 Document
Submission transaction in a separate in-out message exchange pattern as defined in the NHIN
Messaging Platform Specification document.
In a CAQH CORE Generic Batch mode, the NHIN CAQH CORE X12 Document Submission is a two-way
message as shown in the diagram below:
Figure 4: CAQH CORE Generic Batch Mode Messaging workflow
In other words, Initiating NHIE sends a CAQH CORE Generic Batch mode ASC X12 Document
submission request message to the Receiving NHIE and waits for only the HTTP status
acknowledgement.
Asynchronously, the responding NHIE receives the CAQH CORE Generic Batch mode ASC X12
Document submissions request message and processes it in Batch mode and sends the CAQH CORE
Generic Batch mode ASC X12 Document Submission transaction response message to the initiating
NHIE in a separate HTTP connection. The initiating NHIE receives the CAQH CORE Generic Batch mode
Page 12 of 26
5
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
ASC X12 Document Submission response message and sends back the corresponding HTTP status
acknowledgement message to the responding NHIE using the same HTTP Connection.
.
It should be noted that the Action names and namespaces in the CAQH CORE Generic Batch mode
(deferred/asynchronous) and the CAQH CORE Batch mode (deferred) versions of the WSDLs would
need to be different so that generation of the web service code in a gateway supporting both
(synchronous and deferred/ asynchronous) do not have conflicts.
CAQH CORE SOAP Batch mode interaction supports MTOM (i.e., For Batch mode using SOAP
envelope, the payload is an MTOM attachment).
3.4
CAQH CORE Connectivity Metadata Elements
The required CAQH CORE Connectivity Metadata is described in the table below. CAQH CORE
Connectivity metadata elements are used in several ways in NHIN. The primary uses of the metadata are:
• Message routing
• Transaction auditing
• Transaction Scheduling
• Resource Allocation
• Backward compatibility
• Error handling
• Audit logging
Table 1: CAQH CORE Connectivity Metadata Elements
Element
Payload Type
Description
The type of payload included within
a request/response. This shall be
“X12_NNN_NNNNNNXNNNXN”
for a request and
“X12_NNN_NNNNNNXNNNXN”
for a response
Field Name
PayloadType
Optionality
R
Data Type
Coded Set
ProcessingMode
R
Coded Set
PayloadID
R
String
See diagram for Payload Type
Components below for details on
the numeric and alpha characters.
Processing
Mode
Payload ID
CAQH CORE SOAP Real-time
interaction does not support MTOM
(only Batch interactions support
MTOM). For Real-time using SOAP
envelope, the payload is a string, or
if binary (that contain non-printable
characters), must be Base64
encoded.
The mode of processing. This shall
be “Batch Mode”.
A payload ID assigned by the
sender. This shall conform to
International Organization for
Standardization (ISO)
universally unique identifier
(UUID) standards with hexadecimal
notation, generated using a
combination of local timestamp as
Page 13 of 26
5
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
Element
Time Stamp
Sender
Identifier
Receiver
Identifier
CORE Rule
Version
Error Code
Error
Message
274
275
276
Description
well as the hardware (MAC)
address.
A single coordinated Universal
Time (UTC) time stamp including
time zone. This does not require a
shared time server.
A unique business entity (trading
partner) identifier.
A unique business entity (trading
partner) identifier.
The CORE Rule version that the
envelope is using.
The error code indicating the error
when processing the envelope.
Text error message.
Field Name
Optionality
Data Type
TimeStamp
R
dateTime
SenderID
R
String
ReceiverID
R
String
CORERuleVersion
R
Coded Set
ErrorCode
R
Coded Set
ErrorMessage
R
String
Figure 5: (Table 1-1) Payload Type and Description of Components
Transaction
Set-ID
X12
NNN
HIPAA TR3 Version
Release
NNNNNN
X12 TR3
Identifier
X
NNN
TR3 Errata
Identifier
(optional)
XN
277
278
279
280
281
282
283
3.5
284
3.6
Connectivity Rule
The Phase II CAQH CORE 270: Connectivity Rule Version 2.2.0 is described in detail at URL:
http://www.caqh.org/COREv5010.php
SOAP + WSDL based Message Envelope
285
286
287
288
289
290
291
292
293
294
The SOAP + WSDL based method requires SOAP version 1.2 as specified by the NHIN
Messaging Platform specification. There is no normative requirement for the SOAP
header 2 in CORE Connectivity Rule. Within this specification, the NHIN Messaging
Platform specification and Authorization Framework Service Interface Specification
SOAP Headers will be used. The SOAP body contains the remaining metadata defined
by Phase II CAQH CORE 270: Connectivity rule Version 2.2.0 compliant XML Schema
Specification (see Appendix C). The message envelope structure is defined in the
CAQH CORE Phase II Connectivity rule WSDL file. (See Appendix)
2
Phase II CAQH CORE 270: Connectivity Rule requires that WS-Security Username and Password token must be added to the
SOAP Header in the request for user authentication/authorization. This requirement is replaced with SAML Assertion based user
authentication/authorization described in section 3.6 in this specification.
Page 14 of 26
5
295
296
297
298
299
300
301
302
303
304
305
306
3.7
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
SAML Assertion based User Authentication and Authorization
3
For submitter authentication/authorization , the SAML Assertion needs to include additional <Attribute>
elements required by Health Information Technology (HIT) systems. The additional <Attribute> elements
required by this specification include 1) National Provider Identifier (NPI) Attribute and 2) NPI Provider
Name Attribute. Other elements required by this specification include1) User Organization ID Attribute, 2)
User Role Attribute, and 3) Purpose of Use Attribute which are defined in NHIN Authorization Framework
Service Interface Specification. User Authentication will be performed on an NPI Attribute and NPI
Provider Name Attribute pair against the National Plan and Provider Enumeration System (NPPES). The
receiving system will validate requests per NPI Attribute, User Role Attribute, and Purpose of Use
Attribute.
307
4
Error Handling
308
309
310
This section follows error handling specified in the Section 4.3.3 of the Phase II CAQH
CORE 270: Connectivity Rule Version 2.2.0. The error codes relevant to the esMD are
listed in the following table:
311
312
Table 2: Error Handling
313
Error Codes
<FieldName>Illegal
<FieldName>Required
<FieldName>NotUnderstood
VersionMismatch
UnAuthorized
Sender
Receiver
Description
Illegal value provided for <FieldName>.
The field <FieldName> is required but was not provided.
The field <FieldName> is not understood at the receiver. In
the case of SOAP, this error is returned as a NotUnderstood
SOAP fault.
The version of the envelope sent is not acceptable to the
receiver. If the SOAP version is not valid at the receiver, a
SOAP fault is returned with this fault code.
The username/password or Client certificate could not be
verified.
The envelope sent by the sender did not conform to the
expected format. In the case of SOAP, this error should be
sent as a SOAP fault with “Sender” fault code.
The message could not be processed for reasons
attributable to the Receiver (e.g., upstream process is not
reachable). In the case of SOAP, this error should be sent
as a SOAP fault with “Receiver” fault code.
314
315
5
Auditing
316
317
318
This transaction shall be audited as specified in the Section 4.3.4 of the Phase II CAQH
CORE 270: Connectivity Rule Version 2.2.0 and NHIN Audit specifications.
3
Phase II CAQH CORE 270: Connectivity Rule Version 2.2.0 specifies two methods for submitter authentication: 1)
Username/Password based authentication and 2) X.509 Certificate based authentication over TLS. This specification will use SAML
Assertion.
Page 15 of 26
5
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
319
320
6
Appendix A: Sample Messages
321
6.1
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
6.1.1
CAQH CORE Connectivity Real-time mode
Sample CORE SOAP + WSDL Real-time Request
POST /core/esMDBatch HTTP/1.1
Content-Type: multipart/related; boundary=MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614;
type="application/xop+xml"; start="0.urn:uuid:[email protected]";
start-info="application/soap+xml"; action="BatchSubmitTransaction"
--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614
Content-ID: <0.urn:uuid:[email protected]>
Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml"
Content-Transfer-Encoding: binary
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility1.0.xsd"
xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
xmlns:saml="urn:oasis:names:tc:SAML:1.0:assertion"
xmlns:wsse11="http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd"
xmlns:exc14n="http://www.w3.org/2001/10/xml-exc-c14n#">
<soapenv:Header>
<To xmlns="http://www.w3.org/2005/08/addressing"
>https://esmdg.cms.cmstest:443/CONNECTNhinServicesWeb/NhinService/X12BatchDeferredDocumentSubmiss
ionRequest_Service </To>
<Action xmlns="http://www.w3.org/2005/08/addressing"
>urn:ihe:iti:xdr:2007:Deferred:X12BatchDeferredDocumentSubmissionRequestMessage</Action>
<ReplyTo xmlns="http://www.w3.org/2005/08/addressing">
<Address>http://www.w3.org/2005/08/addressing/anonymous</Address>
</ReplyTo>
<MessageID xmlns="http://www.w3.org/2005/08/addressing"> uuid:7a580843-6871-4e01-8db4963c9912345678</MessageID>
<wsse:Security S:mustUnderstand="true">
<wsu:Timestamp
xmlns:ns17="http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512"
xmlns:ns16="http://schemas.xmlsoap.org/soap/envelope/" wsu:Id="_1">
<wsu:Created>2011-09-12T19:27:18Z</wsu:Created>
<wsu:Expires>2011-09-12T19:32:18Z</wsu:Expires>
</wsu:Timestamp>
<saml2:Assertion xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
xmlns:exc14n="http://www.w3.org/2001/10/xml-exc-c14n#"
xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion"
xmlns:xenc="http://www.w3.org/2001/04/xmlenc#"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
ID="149fbbe8-d116-471c-91f3-5ebc01756b31" IssueInstant="2011-09-12T19:27:19.094Z"
Version="2.0">
<saml2:Issuer Format="urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"
>CN=SAML User,OU=QSSI,O=HITS,L=Columbia,ST=MD,C=US</saml2:Issuer>
<saml2:Subject>
<saml2:NameID Format="urn:oasis:names:tc:SAML:1.1:nameidformat:X509SubjectName"
>UID=610</saml2:NameID>
<saml2:SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:holder-ofkey">
<saml2:SubjectConfirmationData>
<ds:KeyInfo>
Page 16 of 26
5
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
<ds:KeyValue>
<ds:RSAKeyValue>
<ds:Modulus>vYxVZKIzVdGMSBkW4bYnV80MV/RgQKV1bf/DoMTX8laMO45P6rlEarxQiOYrgzuYp+snzz2XM0S6o3JGQtXQu
zDwcwPkH55bHFwHgtOMzxG4SQ653a5Dzh04nsmJvxvbncNH/XNaWfHaC0JHBEfNCMwRebYocxYM92pq/G5OGyE=</ds:Modul
us>
<ds:Exponent>AQAB</ds:Exponent>
</ds:RSAKeyValue>
</ds:KeyValue>
</ds:KeyInfo>
</saml2:SubjectConfirmationData>
</saml2:SubjectConfirmation>
</saml2:Subject>
<saml2:AuthnStatement AuthnInstant="2009-04-16T13:15:39.000Z" SessionIndex="987">
<saml2:SubjectLocality Address="158.147.185.168" DNSName="cs.myQSSI.net"/>
<saml2:AuthnContext>
<saml2:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:X509</saml2:AuthnContextClassR
ef>
</saml2:AuthnContext>
</saml2:AuthnStatement>
<saml2:AttributeStatement>
<saml2:Attribute Name="urn:oasis:names:tc:xspa:1.0:subject:subject-id">
<saml2:AttributeValue xmlns:ns6="http://www.w3.org/2001/XMLSchemainstance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema"
ns6:type="ns7:string">Karl
S Skagerberg</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="urn:oasis:names:tc:xspa:1.0:subject:organization">
<saml2:AttributeValue xmlns:ns6="http://www.w3.org/2001/XMLSchemainstance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema"
ns6:type="ns7:string">QSSI
esMD OID</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="urn:oasis:names:tc:xspa:1.0:subject:organization-id">
<saml2:AttributeValue xmlns:ns6="http://www.w3.org/2001/XMLSchemainstance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema" ns6:type="ns7:string"
>123.456.657.123</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="urn:nhin:names:saml:homeCommunityId">
<saml2:AttributeValue xmlns:ns6="http://www.w3.org/2001/XMLSchemainstance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema" ns6:type="ns7:string"
>123.456.657.123</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="urn:oasis:names:tc:xacml:2.0:subject:role">
<saml2:AttributeValue>
<hl7:Role xmlns:hl7="urn:hl7-org:v3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
code="307969004" codeSystem="2.16.840.1.113883.6.96"
codeSystemName="SNOMED_CT" displayName="Public Health"
xsi:type="hl7:CE"/>
</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="urn:oasis:names:tc:xspa:1.0:subject:purposeofuse">
<saml2:AttributeValue>
<hl7:PurposeForUse xmlns:hl7="urn:hl7-org:v3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
code="esMD Code" codeSystem="2.16.840.1.113883.3.18.7.1"
codeSystemName="nhin-purpose" displayName="esMD Display name"
xsi:type="hl7:CE"/>
</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="urn:oasis:names:tc:xacml:2.0:resource:resource-id">
<saml2:AttributeValue xmlns:ns6="http://www.w3.org/2001/XMLSchemainstance"
Page 17 of 26
5
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
xmlns:ns7="http://www.w3.org/2001/XMLSchema" ns6:type="ns7:string"
>urn:oid:2.16.840.1.113883.13.34.110.1.110.9</saml2:AttributeValue>
</saml2:Attribute>
</saml2:AttributeStatement>
<saml2:AuthzDecisionStatement Decision="Permit"
Resource="https://esmdg.cms.cmstest:443/CONNECTNhinServicesWeb/NhinService/XDRRequest_Service">
<saml2:Action Namespace="urn:oasis:names:tc:SAML:1.0:action:rwedc"
>Execute</saml2:Action>
<saml2:Evidence>
<saml2:Assertion ID="40df7c0a-ff3e-4b26-baeb-f2910f6d0mc24091165"
IssueInstant="2009-04-16T13:10:39.093Z" Version="2.0">
<saml2:Issuer
Format="urn:oasis:names:tc:SAML:1.1:nameidformat:X509SubjectName"
>CN=SAML User,OU=QSSI,O=HITS,L=Columbia,ST=MD,C=US</saml2:Issuer>
<saml2:Conditions NotBefore="2009-04-16T13:10:39.093Z"
NotOnOrAfter="2009-12-31T12:00:00.000Z"/>
<saml2:AttributeStatement>
<saml2:Attribute Name="AccessConsentPolicy"
NameFormat="http://www.hhs.gov/healthit/nhin">
<saml2:AttributeValue
xmlns:ns6="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema"
ns6:type="ns7:string">Claim-Ref1234</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="InstanceAccessConsentPolicy"
NameFormat="http://www.hhs.gov/healthit/nhin">
<saml2:AttributeValue
xmlns:ns6="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema"
ns6:type="ns7:string"
>Claim-Instance-1</saml2:AttributeValue>
</saml2:Attribute>
</saml2:AttributeStatement>
</saml2:Assertion>
</saml2:Evidence>
</saml2:AuthzDecisionStatement>
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<ds:SignedInfo>
<ds:CanonicalizationMethod
Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
<ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsasha1"/>
<ds:Reference URI="#149fbbe8-d116-471c-91f3-5ebc01756b31">
<ds:Transforms>
<ds:Transform
Algorithm="http://www.w3.org/2000/09/xmldsig#envelopedsignature"/>
<ds:Transform Algorithm="http://www.w3.org/2001/10/xml-excc14n#"/>
</ds:Transforms>
<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
<ds:DigestValue>ZBdsOn1MryEtB2U6Iizt04VlUQM=</ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>WHaeJEhzDjrBpf4/EEqmtWhYjGPtjJVp7/YXhpMsVO9SQc8zUosTJoHjGl/luroA8GUvGI8T6iBV
n56/ahzxq8+qMcqV4KWx9jYJLdZ7iNkBr6QLiVekd5Btmxwbl2R3VI9U5zskI0AdbAsGEeEw/wu/
3bW7Rov78hxPMdfALYc=</ds:SignatureValue>
<ds:KeyInfo>
<ds:KeyValue>
<ds:RSAKeyValue>
<ds:Modulus>vYxVZKIzVdGMSBkW4bYnV80MV/RgQKV1bf/DoMTX8laMO45P6rlEarxQiOYrgzuYp+snzz2XM0S6
o3JGQtXQuzDwcwPkH55bHFwHgtOMzxG4SQ653a5Dzh04nsmJvxvbncNH/XNaWfHaC0JHBEfNCMwR
Page 18 of 26
5
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
ebYocxYM92pq/G5OGyE=</ds:Modulus>
<ds:Exponent>AQAB</ds:Exponent>
</ds:RSAKeyValue>
</ds:KeyValue>
</ds:KeyInfo>
</ds:Signature>
</saml2:Assertion>
<ds:Signature xmlns:ns17="http://docs.oasis-open.org/ws-sx/wssecureconversation/200512"
xmlns:ns16="http://schemas.xmlsoap.org/soap/envelope/" Id="_2">
<ds:SignedInfo>
<ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-excc14n#">
<exc14n:InclusiveNamespaces PrefixList="wsse S"/>
</ds:CanonicalizationMethod>
<ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
<ds:Reference URI="#_1">
<ds:Transforms>
<ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
<exc14n:InclusiveNamespaces PrefixList="wsu wsse S"/>
</ds:Transform>
</ds:Transforms>
<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
<ds:DigestValue>
<Include xmlns="http://www.w3.org/2004/08/xop/include"
href="cid:[email protected]"
/>
</ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>
<Include xmlns="http://www.w3.org/2004/08/xop/include"
href="cid:[email protected]"/>
</ds:SignatureValue>
<ds:KeyInfo>
<wsse:SecurityTokenReference
wsse11:TokenType="http://docs.oasis-open.org/wss/oasis-wss-saml-tokenprofile-1.1#SAMLV2.0">
<wsse:KeyIdentifier
ValueType="http://docs.oasis-open.org/wss/oasis-wss-saml-tokenprofile-1.1#SAMLID"
>149fbbe8-d116-471c-91f3-5ebc01756b31</wsse:KeyIdentifier>
</wsse:SecurityTokenReference>
</ds:KeyInfo>
</ds:Signature>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<ns1:COREEnvelopeRealTimeRequest
xmlns:ns1="http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.xsd ">
<PayloadType>X12_270_Request_005010X279A1</PayloadType>
<ProcessingMode>RealTime</ProcessingMode>
<PayloadID>f81d4fae-7dec-11d0-a765-00a0c91e6bf6</PayloadID>
<TimeStamp>2007-08-30T10:20:34Z</TimeStamp>
<SenderID>HospitalA</SenderID>
<ReceiverID>PayerB</ReceiverID>
<CORERuleVersion>2.2.0</CORERuleVersion>
<Payload>
PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxDbGluaWNhbERvY3VtZW50
IG1vb2RDb2RlPSJFVk4iIHhtbG5zPSJ1cm46aGw3LW9yZzp2MyINCiAgICB4bWxuczp4c2k9Imh0
</Payload>
</ns1:COREEnvelopeRealTimeRequest>
</soapenv:Body>
</soapenv:Envelope>
Page 19 of 26
5
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
6.1.2
635
6.2
636
637
638
639
640
641
642
643
644
645
646
647
6.2.1
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
Sample CORE SOAP + WSDL Real-time Response
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: multipart/related; boundary=MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339;
type="application/xop+xml"; start="0.urn:uuid:[email protected]"; startinfo="application/soap+xml"; action="BatchSubmitAckRetrievalTransaction"
--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339
Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml"
Content-Transfer-Encoding: binary
Content-ID: <0.urn:uuid:[email protected]>
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Header>
<To xmlns="http://www.w3.org/2005/08/addressing"
>https://esmdg.cms.cmstest:443/CONNECTNhinServicesWeb/NhinService/X12999BatchSubmissionAcknowledg
ementRetrievalResponse_Service</To>
<Action xmlns="http://www.w3.org/2005/08/addressing"
>urn:ihe:iti:xdr:2007:Deferred:Deferred:X12999BatchSubmissionAcknowledgementRetrievalResponseMess
age</Action>
<ReplyTo xmlns="http://www.w3.org/2005/08/addressing">
<Address>http://www.w3.org/2005/08/addressing/anonymous</Address>
</ReplyTo>
<MessageID xmlns="http://www.w3.org/2005/08/addressing">uuid:7a580843-6871-4e01-8db4963c99147avds</MessageID>
<RelatesTo xmlns="http://www.w3.org/2005/08/addressing">uuid:7a580843-6871-4e01-8db4963c9912345678</RelatesTo>
</soapenv:Header>
<soapenv:Body>
<ns1:COREEnvelopeRealTimeResponse
xmlns:ns1="http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.xsd">
<PayloadType>X12_271_Response_005010X279A1</PayloadType>
<ProcessingMode>RealTime</ProcessingMode>
<PayloadID>a81d44ae-7dec-11d0-a765-00a0c91e6ba0</PayloadID>
<TimeStamp>2007-08-30T10:20:34Z</TimeStamp>
<SenderID>PayerB</SenderID>
<ReceiverID>HospitalA</ReceiverID>
<CORERuleVersion>2.2.0</CORERuleVersion>
<Payload>
PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxDbGluaWNhbERvY3VtZW50
IG1vb2RDb2RlPSJFVk4iIHhtbG5zPSJ1cm46aGw3LW9yZzp2MyINCiAgICB4bWxuczp4c2k9Imh0
</Payload>
<ErrorCode>Success</ErrorCode>
<ErrorMessage></ErrorMessage>
</ns1:COREEnvelopeRealTimeResponse>
</soapenv:Body>
</soapenv:Envelope>
CAQH CORE Connectivity Generic Batch mode
Sample CORE SOAP + WSDL Batch mode Request
POST /core/esMDBatch HTTP/1.1
Content-Type: multipart/related; boundary=MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614;
type="application/xop+xml"; start="0.urn:uuid:[email protected]";
start-info="application/soap+xml"; action="BatchSubmitTransaction"
--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614
Content-ID: <0.urn:uuid:[email protected]>
Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml"
Content-Transfer-Encoding: binary
Page 20 of 26
5
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility1.0.xsd"
xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
xmlns:saml="urn:oasis:names:tc:SAML:1.0:assertion"
xmlns:wsse11="http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd"
xmlns:exc14n="http://www.w3.org/2001/10/xml-exc-c14n#">
<soapenv:Header>
<To xmlns="http://www.w3.org/2005/08/addressing"
>https://esmdg.cms.cmstest:443/CONNECTNhinServicesWeb/NhinService/X12BatchDeferredDocumentSubmiss
ionRequest_Service </To>
<Action xmlns="http://www.w3.org/2005/08/addressing"
>urn:ihe:iti:xdr:2007:Deferred:X12BatchDeferredDocumentSubmissionRequestMessage</Action>
<ReplyTo xmlns="http://www.w3.org/2005/08/addressing">
<Address>http://www.w3.org/2005/08/addressing/anonymous</Address>
</ReplyTo>
<MessageID xmlns="http://www.w3.org/2005/08/addressing"> uuid:7a580843-6871-4e01-8db4963c9912345678</MessageID>
<wsse:Security S:mustUnderstand="true">
<wsu:Timestamp
xmlns:ns17="http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512"
xmlns:ns16="http://schemas.xmlsoap.org/soap/envelope/" wsu:Id="_1">
<wsu:Created>2011-09-12T19:27:18Z</wsu:Created>
<wsu:Expires>2011-09-12T19:32:18Z</wsu:Expires>
</wsu:Timestamp>
<saml2:Assertion xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
xmlns:exc14n="http://www.w3.org/2001/10/xml-exc-c14n#"
xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion"
xmlns:xenc="http://www.w3.org/2001/04/xmlenc#"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
ID="149fbbe8-d116-471c-91f3-5ebc01756b31" IssueInstant="2011-09-12T19:27:19.094Z"
Version="2.0">
<saml2:Issuer Format="urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"
>CN=SAML User,OU=QSSI,O=HITS,L=Columbia,ST=MD,C=US</saml2:Issuer>
<saml2:Subject>
<saml2:NameID Format="urn:oasis:names:tc:SAML:1.1:nameidformat:X509SubjectName"
>UID=610</saml2:NameID>
<saml2:SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:holder-ofkey">
<saml2:SubjectConfirmationData>
<ds:KeyInfo>
<ds:KeyValue>
<ds:RSAKeyValue>
<ds:Modulus>vYxVZKIzVdGMSBkW4bYnV80MV/RgQKV1bf/DoMTX8laMO45P6rlEarxQiOYrgzuYp+snzz2XM0S6o3JGQtXQu
zDwcwPkH55bHFwHgtOMzxG4SQ653a5Dzh04nsmJvxvbncNH/XNaWfHaC0JHBEfNCMwRebYocxYM92pq/G5OGyE=</ds:Modul
us>
<ds:Exponent>AQAB</ds:Exponent>
</ds:RSAKeyValue>
</ds:KeyValue>
</ds:KeyInfo>
</saml2:SubjectConfirmationData>
</saml2:SubjectConfirmation>
</saml2:Subject>
<saml2:AuthnStatement AuthnInstant="2009-04-16T13:15:39.000Z" SessionIndex="987">
<saml2:SubjectLocality Address="158.147.185.168" DNSName="cs.myQSSI.net"/>
<saml2:AuthnContext>
<saml2:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:X509</saml2:AuthnContextClassR
ef>
</saml2:AuthnContext>
</saml2:AuthnStatement>
<saml2:AttributeStatement>
Page 21 of 26
5
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
<saml2:Attribute Name="urn:oasis:names:tc:xspa:1.0:subject:subject-id">
<saml2:AttributeValue xmlns:ns6="http://www.w3.org/2001/XMLSchemainstance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema"
ns6:type="ns7:string">Karl
S Skagerberg</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="urn:oasis:names:tc:xspa:1.0:subject:organization">
<saml2:AttributeValue xmlns:ns6="http://www.w3.org/2001/XMLSchemainstance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema"
ns6:type="ns7:string">QSSI
esMD OID</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="urn:oasis:names:tc:xspa:1.0:subject:organization-id">
<saml2:AttributeValue xmlns:ns6="http://www.w3.org/2001/XMLSchemainstance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema" ns6:type="ns7:string"
>123.456.657.123</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="urn:nhin:names:saml:homeCommunityId">
<saml2:AttributeValue xmlns:ns6="http://www.w3.org/2001/XMLSchemainstance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema" ns6:type="ns7:string"
>123.456.657.123</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="urn:oasis:names:tc:xacml:2.0:subject:role">
<saml2:AttributeValue>
<hl7:Role xmlns:hl7="urn:hl7-org:v3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
code="307969004" codeSystem="2.16.840.1.113883.6.96"
codeSystemName="SNOMED_CT" displayName="Public Health"
xsi:type="hl7:CE"/>
</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="urn:oasis:names:tc:xspa:1.0:subject:purposeofuse">
<saml2:AttributeValue>
<hl7:PurposeForUse xmlns:hl7="urn:hl7-org:v3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
code="esMD Code" codeSystem="2.16.840.1.113883.3.18.7.1"
codeSystemName="nhin-purpose" displayName="esMD Display name"
xsi:type="hl7:CE"/>
</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="urn:oasis:names:tc:xacml:2.0:resource:resource-id">
<saml2:AttributeValue xmlns:ns6="http://www.w3.org/2001/XMLSchemainstance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema" ns6:type="ns7:string"
>urn:oid:2.16.840.1.113883.13.34.110.1.110.9</saml2:AttributeValue>
</saml2:Attribute>
</saml2:AttributeStatement>
<saml2:AuthzDecisionStatement Decision="Permit"
Resource="https://esmdg.cms.cmstest:443/CONNECTNhinServicesWeb/NhinService/XDRRequest_Service">
<saml2:Action Namespace="urn:oasis:names:tc:SAML:1.0:action:rwedc"
>Execute</saml2:Action>
<saml2:Evidence>
<saml2:Assertion ID="40df7c0a-ff3e-4b26-baeb-f2910f6d0mc24091165"
IssueInstant="2009-04-16T13:10:39.093Z" Version="2.0">
<saml2:Issuer
Format="urn:oasis:names:tc:SAML:1.1:nameidformat:X509SubjectName"
>CN=SAML User,OU=QSSI,O=HITS,L=Columbia,ST=MD,C=US</saml2:Issuer>
<saml2:Conditions NotBefore="2009-04-16T13:10:39.093Z"
NotOnOrAfter="2009-12-31T12:00:00.000Z"/>
<saml2:AttributeStatement>
<saml2:Attribute Name="AccessConsentPolicy"
NameFormat="http://www.hhs.gov/healthit/nhin">
<saml2:AttributeValue
Page 22 of 26
5
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
xmlns:ns6="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema"
ns6:type="ns7:string">Claim-Ref1234</saml2:AttributeValue>
</saml2:Attribute>
<saml2:Attribute Name="InstanceAccessConsentPolicy"
NameFormat="http://www.hhs.gov/healthit/nhin">
<saml2:AttributeValue
xmlns:ns6="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ns7="http://www.w3.org/2001/XMLSchema"
ns6:type="ns7:string"
>Claim-Instance-1</saml2:AttributeValue>
</saml2:Attribute>
</saml2:AttributeStatement>
</saml2:Assertion>
</saml2:Evidence>
</saml2:AuthzDecisionStatement>
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<ds:SignedInfo>
<ds:CanonicalizationMethod
Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
<ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsasha1"/>
<ds:Reference URI="#149fbbe8-d116-471c-91f3-5ebc01756b31">
<ds:Transforms>
<ds:Transform
Algorithm="http://www.w3.org/2000/09/xmldsig#envelopedsignature"/>
<ds:Transform Algorithm="http://www.w3.org/2001/10/xml-excc14n#"/>
</ds:Transforms>
<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
<ds:DigestValue>ZBdsOn1MryEtB2U6Iizt04VlUQM=</ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>WHaeJEhzDjrBpf4/EEqmtWhYjGPtjJVp7/YXhpMsVO9SQc8zUosTJoHjGl/luroA8GUvGI8T6iBV
n56/ahzxq8+qMcqV4KWx9jYJLdZ7iNkBr6QLiVekd5Btmxwbl2R3VI9U5zskI0AdbAsGEeEw/wu/
3bW7Rov78hxPMdfALYc=</ds:SignatureValue>
<ds:KeyInfo>
<ds:KeyValue>
<ds:RSAKeyValue>
<ds:Modulus>vYxVZKIzVdGMSBkW4bYnV80MV/RgQKV1bf/DoMTX8laMO45P6rlEarxQiOYrgzuYp+snzz2XM0S6
o3JGQtXQuzDwcwPkH55bHFwHgtOMzxG4SQ653a5Dzh04nsmJvxvbncNH/XNaWfHaC0JHBEfNCMwR
ebYocxYM92pq/G5OGyE=</ds:Modulus>
<ds:Exponent>AQAB</ds:Exponent>
</ds:RSAKeyValue>
</ds:KeyValue>
</ds:KeyInfo>
</ds:Signature>
</saml2:Assertion>
<ds:Signature xmlns:ns17="http://docs.oasis-open.org/ws-sx/wssecureconversation/200512"
xmlns:ns16="http://schemas.xmlsoap.org/soap/envelope/" Id="_2">
<ds:SignedInfo>
<ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-excc14n#">
<exc14n:InclusiveNamespaces PrefixList="wsse S"/>
</ds:CanonicalizationMethod>
<ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
<ds:Reference URI="#_1">
<ds:Transforms>
<ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
<exc14n:InclusiveNamespaces PrefixList="wsu wsse S"/>
</ds:Transform>
</ds:Transforms>
Page 23 of 26
5
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
<ds:DigestValue>
<Include xmlns="http://www.w3.org/2004/08/xop/include"
href="cid:[email protected]"
/>
</ds:DigestValue>
</ds:Reference>
</ds:SignedInfo>
<ds:SignatureValue>
<Include xmlns="http://www.w3.org/2004/08/xop/include"
href="cid:[email protected]"/>
</ds:SignatureValue>
<ds:KeyInfo>
<wsse:SecurityTokenReference
wsse11:TokenType="http://docs.oasis-open.org/wss/oasis-wss-saml-tokenprofile-1.1#SAMLV2.0">
<wsse:KeyIdentifier
ValueType="http://docs.oasis-open.org/wss/oasis-wss-saml-tokenprofile-1.1#SAMLID"
>149fbbe8-d116-471c-91f3-5ebc01756b31</wsse:KeyIdentifier>
</wsse:SecurityTokenReference>
</ds:KeyInfo>
</ds:Signature>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<ns1:COREEnvelopeBatchSubmission
xmlns:ns1="http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.xsd">
<PayloadType>X12_275_Request_005010X210E1</PayloadType>
<ProcessingMode>Batch</ProcessingMode>
<PayloadID>f81d4fae-7dec-11d0-a765-00a0c91e6bf6</PayloadID>
<PayloadLength>1551254</PayloadLength>
<TimeStamp>2007-08-30T10:20:34Z</TimeStamp>
<SenderID>HospitalA</SenderID>
<ReceiverID>PayerB</ReceiverID>
<CORERuleVersion>2.2.0</CORERuleVersion>
<CheckSum>43B8485AB5</CheckSum>
<Payload>
<xop:Include href="cid:1.urn:uuid:[email protected]"
xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</Payload>
</ns1:COREEnvelopeBatchSubmission>
</soapenv:Body>
</soapenv:Envelope>
--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614
Content-ID: <1.urn:uuid:[email protected]>
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
ISA*00*
*00*
*28*SSSSSS
*100811*1213*^*00501*100000001*0*P*>~
..............
*28*PPPPP
--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614
911
912
913
914
915
916
917
918
919
6.2.2
Sample CORE SOAP + WSDL Batch mode Response
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: multipart/related; boundary=MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339;
type="application/xop+xml"; start="0.urn:uuid:[email protected]"; startinfo="application/soap+xml"; action="BatchSubmitAckRetrievalTransaction"
Page 24 of 26
5
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339
Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml"
Content-Transfer-Encoding: binary
Content-ID: <0.urn:uuid:[email protected]>
<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Header>
<To xmlns="http://www.w3.org/2005/08/addressing"
>https://esmdg.cms.cmstest:443/CONNECTNhinServicesWeb/NhinService/X12999BatchSubmissionAcknowledg
ementRetrievalResponse_Service</To>
<Action xmlns="http://www.w3.org/2005/08/addressing"
>urn:ihe:iti:xdr:2007:Deferred:Deferred:X12999BatchSubmissionAcknowledgementRetrievalResponseMess
age</Action>
<ReplyTo xmlns="http://www.w3.org/2005/08/addressing">
<Address>http://www.w3.org/2005/08/addressing/anonymous</Address>
</ReplyTo>
<MessageID xmlns="http://www.w3.org/2005/08/addressing">uuid:7a580843-6871-4e01-8db4963c99147avds</MessageID>
<RelatesTo xmlns="http://www.w3.org/2005/08/addressing">uuid:7a580843-6871-4e01-8db4963c9912345678</RelatesTo>
</soapenv:Header>
<soapenv:Body>
<ns1:COREEnvelopeBatchSubmissionAckRetrievalResponse
xmlns:ns1="http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.xsd">
<PayloadType>X12_999_Response_005010X231A1</PayloadType>
<ProcessingMode>Batch</ProcessingMode>
<PayloadID>f81d4fae-7dec-11d0-a765-00a0c91e6bf6</PayloadID>
<PayloadLength>1551254</PayloadLength>
<TimeStamp>2007-08-30T10:20:34Z</TimeStamp>
<SenderID>PayerB</SenderID>
<ReceiverID>HospitalA</ReceiverID>
<CORERuleVersion>2.2.0</CORERuleVersion>
<CheckSum>43B8485AB5</CheckSum>
<Payload>
<xop:Include href="cid:1.urn:uuid:[email protected]"
xmlns:xop="http://www.w3.org/2004/08/xop/include"/>
</Payload>
<ErrorCode>Success</ErrorCode>
<ErrorMessage/>
</ns1:COREEnvelopeBatchSubmissionAckRetrievalResponse>
</soapenv:Body>
</soapenv:Envelope>
--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339
Content-Type: application/pdf
Content-Transfer-Encoding: binary
Content-ID: <1.urn:uuid:[email protected]>
ISA*00*
*00*
*28*PPPPP
*100811*1600*^*00501*100000001*1*P*>~
.........
*28*SSSSSS
--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339—
975
976
Page 25 of 26
5
CAQH CORE X12 Document Submission Service Interface
Specification
v 1.0
977
978
7
Appendix B: WSDL
979
7.1
980
Phase II CAQH CORE 270: Connectivity Rule Version 2.2.0 provides a WSDL definition.
981
982
The original CORE Phase II Connectivity WSDL can be downloaded at
http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.wsdl
Phase II CAQH CORE 270: Connectivity Rule Version 2.2.0 WSDL
983
984
985
8
Appendix C: XML Schema (XSD)
986
987
988
8.1
989
990
Phase II CAQH CORE 270: Connectivity Rule Version 2.2.0 provides schema definition
at http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.xsd
Phase II CAQH CORE 270: Connectivity Rule Version 2.2.0 compliant XML Schema
Specification
Page 26 of 26