eHealth Ontario Messages


This is an introduction to our HIAL messages and the messages' structures.  For more details, please refer to our full HIAL Transport and Message Specification


Transport Details

Message Deliver

The CHI TLI specification describes three message exchange patterns (or response modes) that may be utilized by a POS system when communicating with a HIAL. These are: immediate (synchronous request-response), deferred (asynchronous), and queued (polling) modes. eHealth Ontario HIAL supports immediate mode.

Consumer application systems MUST NOT communicate with eHealth Ontario HIAL using the deferred mode (asynchronous).

 

Our Transport Layer Security

The consumer applications systems MUST communicate with eHealth Ontario HIAL over mutually authenticated HTTPS (TLS v1.1 ot TLS v1.2) connections.

To connect to eHealth Ontario HIAL, consumer application systems MUST provide a SSL client certificate issued by eHealth ONE®ID* for this purpose. Consumer application requests that don’t provide a valid client certificate will be rejected.

 (*There will be more details on this in the near future)

 


Message Details Overview

eHealth Ontario’s implements SOAP Specification version 1.1 or 1.2 using a document-literal approach.

NOTE: SOAP RPC (Remote Procedure Call) is NOT supported.


Sample SOAP Request:

<?xml version="1.0" encoding="UTF-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsa="http://www.w3.org/2005/08/addressing>

            <soap:Header>

                        <Security xmlns="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">

<!-- SAML Token { -->

                               <saml:Assertion ID="ID2cfd02bf-a443-43fa-818b-ae527da1a4a4" IssueInstant="2010-12-31T16:42:22Z" Version="2.0" xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion">

                                    ...

                               </saml:Assertion>

<!-- } SAML Token -->

                        </Security>

<!-- Addressing { -->

                        <wsa:MessageID >uuid:c53939cf-81c6-4697-bed3-e4a3987eb8e2</wsa:MessageID>

                        <wsa:ReplyTo>

                                    <wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>

                        </wsa:ReplyTo>

                        <wsa:Action>urn:hl7-org:v3:PRPA_IN101101CA.LE200903</wsa:Action>

                        <wsa:To>http://location/P/V3-LE200903/XML/PRPA_AR101102CA</wsa:To>

<!-- } Addressing -->

            </soap:Header>

            <soap:Body>

<!-- Sample HL7v3 Request { -->

                      <v3:PRPA_IN101101CA xmlns:v3="urn:hl7-org:v3">

                           ...

                      </v3:PRPA_IN101101CA>

<!-- } Sample HL7v3 Request -->

            </soap:Body>

</soap:Envelope>




Sample SOAP Response:

<?xml version="1.0" encoding="UTF-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsa="http://www.w3.org/2005/08/addressing">

            <soap:Header>

<!-- Addressing { -->

                        <wsa:MessageID>uuid:c57883cf-81c7-4677-b873-e4a3987eb77</wsa:MessageID>

                        <wsa:RelatesTo> uuid:c53939cf-81c6-4697-bed3-e4a3987eb8e2 </wsa:RelatesTo>

                        <wsa:Action>urn:hl7-org:v3:PRPA_IN101101CA.LE200903</wsa:Action>

                        <wsa:To>http://location/P/V3-LE200903/XML/PRPA_AR101102CA</wsa:To>

<!-- } Addressing -->

            </soap:Header>

            <soap:Body>

<!-- Sample HL7v3 Response { -->

                        <v3:PRPA_IN101101CA xmlns:v3="urn:hl7-org:v3">

                           ...

                        </v3:PRPA_IN101101CA>

<!-- } Sample HL7v3 Response -->

            </soap:Body>

</soap:Envelope>

 


WS-I Basic Profile

For the purpose of consumer application integration, eHealth’s HIAL SOAP 1.1 Web Services interfaces are compliant with the WS-I Basic Profile 1.2 . The WS-I Basic Profile 1.2 is a set of guidelines for implementing Web Services interfaces for maximum interoperability. HIAL SOAP 1.2 Web Services interfaces are compliant with the WS-I Basic Profile 2.0.

 

WS-Security – SAML

In addition to the mutual Transport Layer Security (TLS) authentication, eHealth Ontario also makes use of WS-Security specifications for securing web services exchanges. The security is realized through the use of Security Assertion Markup Language (SAML) 2.0.

Consumer application systems MUST implement SAML 2.0.

 

WS-Addressing

eHealth Ontario’s HIAL implements WS-Addressing Specification version 1.0.

For the purpose of consumer application integration, eHealth Ontario HIAL DOES NOT support integrations through multiple intermediaries. The endpoint for the consumer application exchanges is the eHealth Ontario HIAL.

 

WSDL

eHealth Ontario HIAL services implement WSDL Specification version 1.1.

It is important to note that eHealth Ontario HIAL does not expose WSDL artifacts through WSDL queries, and that WSDL queries are not available at runtime. Consumer application systems MUST obtain WSDL artifacts manually from eHealth Ontario.