SOAP > SOAP in CORE

This section contains examples of SOAP messages depicting the request and response required for patient eligibility checks.

The SOAP EDI messaging envelope contains metadata related to its payload and may sometimes not contain the payload it describes. Fields common to all the messaging envelopes are:

•	PayloadType: Identifies the kind of transaction the message is transmitting. Not all payload types are tied to a specific EDI transaction, some may be for confirmations of message arrival or error notifications.

•	ProcessingMode: Identifies whether the message is to be processed in real time or batch modes.

•	PayloadID: Unique identifier for the related payload. The payload does not need to be in the message; the message may be an acknowledgement of a received request.

•	TimeStamp: Time in which the message was sent.

•	SenderID: Identifies the sender of the message.

•	ReceiverID: Identifies the recipient of the message.

•	CORERuleVersion: Idenfities the CORE rules in effect. Currently 2.2.0.

Request messages will always contain a header through which the sender is verified as an authorized user of the receiving service. This verification can be done through username/password tokens or the use of an x.509 certificate. The examples provided use the former method, as does HIPAAsuite RealTime Server.

The response message will not contain a header, but does have two additional fields for error processing: ErrorCode and ErrorMessage.

The SOAP message envelopes for real time transactions are almost identical. Their only difference is the aforementioned distinction between request and response messages. The response in real time is meant to answer the request in full. The following are examples of a real time request and a real time response.

Real time Eligibility Request message:

POST /core/eligibility HTTP/1.1

Host: server_host:server_port

Content-Type: application/soap+xml; charset=UTF-8; action="RealTimeTransaction"

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">

<soapenv:Header>

<wsse:Security

xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext1.0.xsd" soapenv:mustUnderstand="true">

<wsse:UsernameToken xmlns:wsu=http://docs.oasis-open.org/wss/2004/01/oasis-200401-wsswssecurity-utility-1.0.xsd wsu:Id="UsernameToken-21621663">

<wsse:Username>bob</wsse:Username>

<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-usernametoken-profile-1.0#PasswordText">bobPW</wsse:Password>

</wsse:UsernameToken>

</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>

<SenderID>HospitalA</SenderID>

<ReceiverID>PayerB</ReceiverID>

</ns1:COREEnvelopeRealTimeRequest>

</soapenv:Body>

</soapenv:Envelope>

Real time Eligibility Response message:

HTTP/1.1 200 OK

Content-Type: application/soap+xml; action="http://www.caqh.org/SOAP/WSDL/CORETransactions/RealTimeTransactionResponse";charset=UTF-8

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">

<soapenv:Body>

<ns1:COREEnvelopeRealTimeResponse

xmlns:ns1="http://www.caqh.org/SOAP/WSDL/CORERule2.2.0xsd">

<PayloadType>X12_271_Response_005010X279A1</PayloadType>

<ProcessingMode>RealTime</ProcessingMode>

<SenderID>PayerB</SenderID>

<ReceiverID>HospitalA</ReceiverID>

<ErrorCode>Success</ErrorCode>

</ns1:COREEnvelopeRealTimeResponse>

</soapenv:Body>

</soapenv:Envelope>

SOAP Batch messages also use MTOM to send the Payload file. The use of MTOM in Batch mode requests/responses creates multipart MIME messages in order to separate the payload from the other message elements even if there is no payload (which is the case for Batch Retrieval Requests, Batch Submission Acknowledgement Retrieval Requests, Batch Submission Responses, and Batch Results Acknowledgement Submission Responses) or if the payload size is too small to justify the use of MTOM.

If WCF determines that the size of the overhead of a multipart header in addition to the encoded payload is less than the payload without MTOM encoding, the payload is instead referenced from the SOAP message and appended as an attachment of the multipart message.

In addition to the fields in the real time SOAP messages, batch SOAP messages, or MTOM-encoded SOAP messages, have the following fields whenever a payload is included in the message:

•	PayloadLength: Defines the length of the actual payload in bytes.

•	Checksum: An element used to allow the receiver to verify the integrity of the included payload.

Batch Submission message:

POST /core/eligibilityBatch HTTP/1.1

Content-Type: multipart/related; boundary=MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614;

type="application/xop+xml"; start="0.urn:uuid:5117AAE1116EA8B87A1200060184615@apache.org"; startinfo="application/soap+xml"; action="BatchSubmitTransaction"

--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614

Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml"

Content-Transfer-Encoding: binary

Content-ID: <0.urn:uuid:5117AAE1116EA8B87A1200060184615@apache.org>

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">

<soapenv:Header>

<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext-1.0.xsd" soapenv:mustUnderstand="true">

<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wsswssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-21621664">

<wsse:Username>bob</wsse:Username>

<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile-1.0#PasswordText">bobPW</wsse:Password>

</wsse:UsernameToken>

</wsse:Security>

</soapenv:Header>

<soapenv:Body>

<ns1:COREEnvelopeBatchSubmission

xmlns:ns1="http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.xsd">

<PayloadType>X12_270_Request_005010X279A1</PayloadType>

<ProcessingMode>Batch</ProcessingMode>

<SenderID>HospitalA</SenderID>

<ReceiverID>PayerB</ReceiverID>

<xop:Include href="cid:1.urn:uuid:5117AAE1116EA8B87A1200060184692@apache.org"

xmlns:xop="http://www.w3.org/2004/08/xop/include" />

</Payload>

</ns1:COREEnvelopeBatchSubmission>

</soapenv:Body>

</soapenv:Envelope>

--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614

Content-Type: image/jpeg

Content-Transfer-Encoding: binary

Content-ID: <1.urn:uuid:5117AAE1116EA8B87A1200060184692@apache.org>

--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614--

The Generic Batch Submission Request uses the same request message as the Batch Submission Request message structure depicted above, with PayloadType values based on what is being submitted.

Batch Submission Response message:

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:0B72121B1FEFA9BDD31200060195340@apache.org"; startinfo="application/soap+xml";

action="http://www.caqh.org/SOAP/WSDL/CORETransactions/BatchSubmitTransactionResponse"

--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339

Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml"

Content-Transfer-Encoding: binary

Content-ID: <0.urn:uuid:0B72121B1FEFA9BDD31200060195340@apache.org>

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">

<soapenv:Body>

<ns1:COREEnvelopeBatchSubmissionResponse

xmlns:ns1="http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.xsd">

<PayloadType>X12_BatchReceiptConfirmation</PayloadType>

<ProcessingMode>Batch</ProcessingMode>

<SenderID>PayerB</SenderID>

<ReceiverID>HospitalA</ReceiverID>

<ErrorCode>Success</ErrorCode>

</ns1:COREEnvelopeBatchSubmissionResponse>

</soapenv:Body>

</soapenv:Envelope>

--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339--

Batch Submission Acknowledgement Retrieval Request message:

POST /core/eligibilityBatch HTTP/1.1

Content-Type: multipart/related; boundary=MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614;

type="application/xop+xml"; start="0.urn:uuid:5117AAE1116EA8B87A1200060184615@apache.org"; startinfo="application/soap+xml"; action="BatchSubmitAckRetrievalTransaction"

--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614

Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml"

Content-Transfer-Encoding: binary

Content-ID: <0.urn:uuid:5117AAE1116EA8B87A1200060184615@apache.org>

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">

<soapenv:Header>

<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext-1.0.xsd" soapenv:mustUnderstand="true">

<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wsswssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-21621664">

<wsse:Username>bob</wsse:Username>

<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile-1.0#PasswordText">bobPW</wsse:Password>

</wsse:UsernameToken>

</wsse:Security>

</soapenv:Header>

<soapenv:Body>

<ns1:COREEnvelopeBatchSubmissionAckRetrievalRequest

xmlns:ns1="http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.xsd">

<PayloadType>X12_999_RetrievalRequest_005010X231A1</PayloadType>

<ProcessingMode>Batch</ProcessingMode>

<SenderID>HospitalA</SenderID>

<ReceiverID>PayerB</ReceiverID>

</ns1:COREEnvelopeBatchSubmissionAckRetrievalRequest>

</soapenv:Body>

</soapenv:Envelope>

--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614--

Batch Submission Acknowledgement Retrieval Response message:

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:0B72121B1FEFA9BDD31200060195340@apache.org"; 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:0B72121B1FEFA9BDD31200060195340@apache.org>

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">

<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>

<SenderID>PayerB</SenderID>

<ReceiverID>HospitalA</ReceiverID>

<xop:Include href="cid:1.urn:uuid:5117AAE1116EA8B87A1200060184692@apache.org"

xmlns:xop="http://www.w3.org/2004/08/xop/include" />

</Payload>

<ErrorCode>Success</ErrorCode>

</ns1:COREEnvelopeBatchSubmissionAckRetrievalResponse>

</soapenv:Body>

</soapenv:Envelope>

--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339

Content-Type: image/jpeg

Content-Transfer-Encoding: binary

Content-ID: <1.urn:uuid:5117AAE1116EA8B87A1200060184692@apache.org>

<999 file>

--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339--

Batch Results Retrieval Request message:

POST /core/eligibilityBatch HTTP/1.1

Content-Type: multipart/related; boundary=MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614;

type="application/xop+xml"; start="0.urn:uuid:5117AAE1116EA8B87A1200060184615@apache.org"; startinfo="application/soap+xml"; action="BatchResultsRetrievalTransaction"

--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614

Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml"

Content-Transfer-Encoding: binary

Content-ID: <0.urn:uuid:5117AAE1116EA8B87A1200060184615@apache.org>

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">

<soapenv:Header>

<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext-1.0.xsd" soapenv:mustUnderstand="true">

<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wsswssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-21621664">

<wsse:Username>bob</wsse:Username>

<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile-1.0#PasswordText">bobPW</wsse:Password>

</wsse:UsernameToken>

</wsse:Security>

</soapenv:Header>

<soapenv:Body>

<ns1:COREEnvelopeBatchResultsRetrievalRequest

xmlns:ns1="http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.xsd">

<PayloadType>X12_005010_Request_Batch_Results_271</PayloadType>

<ProcessingMode>Batch</ProcessingMode>

<SenderID>HospitalA</SenderID>

<ReceiverID>PayerB</ReceiverID>

</ns1:COREEnvelopeBatchResultsRetrievalRequest>

</soapenv:Body>

</soapenv:Envelope>

--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614--

Batch Results Retrieval Response message:

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:0B72121B1FEFA9BDD31200060195340@apache.org"; startinfo="application/soap+xml"; action="BatchResultsRetrievalTransaction"

--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339

Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml"

Content-Transfer-Encoding: binary

Content-ID: <0.urn:uuid:0B72121B1FEFA9BDD31200060195340@apache.org>

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">

<soapenv:Body>

<ns1:COREEnvelopeBatchResultsRetrievalResponse

xmlns:ns1="http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.xsd">

<PayloadType>X12_271_Response_005010X279A1</PayloadType>

<ProcessingMode>Batch</ProcessingMode>

<SenderID>PayerB</SenderID>

<ReceiverID>HospitalA</ReceiverID>

<xop:Include href="cid:1.urn:uuid:5117AAE1116EA8B87A1200060184692@apache.org"

xmlns:xop="http://www.w3.org/2004/08/xop/include" />

</Payload>

<ErrorCode>Success</ErrorCode>

</ns1:COREEnvelopeBatchResultsRetrievalResponse>

</soapenv:Body>

</soapenv:Envelope>

--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339

Content-Type: image/jpeg

Content-Transfer-Encoding: binary

Content-ID: <1.urn:uuid:5117AAE1116EA8B87A1200060184692@apache.org>

--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339--

Batch Results Acknowledgement Submission message:

POST /core/eligibilityBatch HTTP/1.1

Content-Type: multipart/related; boundary=MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614;

type="application/xop+xml"; start="0.urn:uuid:5117AAE1116EA8B87A1200060184615@apache.org"; startinfo="application/soap+xml"; action="BatchResultsAckTransaction"

--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614

Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml"

Content-Transfer-Encoding: binary

Content-ID: <0.urn:uuid:5117AAE1116EA8B87A1200060184615@apache.org>

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">

<soapenv:Header>

<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext-1.0.xsd" soapenv:mustUnderstand="true">

<wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wsswssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-21621664">

<wsse:Username>bob</wsse:Username>

<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile-1.0#PasswordText">bobPW</wsse:Password>

</wsse:UsernameToken>

</wsse:Security>

</soapenv:Header>

<soapenv:Body>

<ns1:COREEnvelopeBatchResultsAckSubmission

xmlns:ns1="http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.xsd">

<PayloadType>X12_999_SubmissionRequest_005010X231A1</PayloadType>

<ProcessingMode>Batch</ProcessingMode>

<SenderID>HospitalA</SenderID>

<ReceiverID>PayerB</ReceiverID>

<xop:Include href="cid:1.urn:uuid:5117AAE1116EA8B87A1200060184692@apache.org"

xmlns:xop="http://www.w3.org/2004/08/xop/include" />

</Payload>

</ns1:COREEnvelopeBatchResultsAckSubmission>

</soapenv:Body>

</soapenv:Envelope>

--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614

Content-Type: image/jpeg

Content-Transfer-Encoding: binary

Content-ID: <1.urn:uuid:5117AAE1116EA8B87A1200060184692@apache.org>

<999 file>

--MIMEBoundaryurn_uuid_5117AAE1116EA8B87A1200060184614--

Batch Results Acknowledgement Submission Response message:

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:0B72121B1FEFA9BDD31200060195340@apache.org"; startinfo="application/soap+xml"; action="BatchResultsAckTransaction"

--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339

Content-Type: application/xop+xml; charset=UTF-8; type="application/soap+xml"

Content-Transfer-Encoding: binary

Content-ID: <0.urn:uuid:0B72121B1FEFA9BDD31200060195340@apache.org>

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">

<soapenv:Body>

<ns1:COREEnvelopeBatchResultsAckSubmissionResponse

xmlns:ns1="http://www.caqh.org/SOAP/WSDL/CORERule2.2.0.xsd">

<PayloadType>X12_Response_ConfirmReceiptReceived</PayloadType>

<ProcessingMode>Batch</ProcessingMode>

<SenderID>PayerB</SenderID>

<ReceiverID>HospitalA</ReceiverID>

<ErrorCode>Success</ErrorCode>

</ns1:COREEnvelopeBatchResultsAckSubmissionResponse>

</soapenv:Body>

</soapenv:Envelope>

--MIMEBoundaryurn_uuid_0B72121B1FEFA9BDD31200060195339--