ech-0214 component

The ech-0214 component provides interfaces for the Query SPID request of the Swiss eCH-0214 standard, which is described in eCH-0214 EPR-SPID Query Service, Version 2.0.

The service is part of the EPR-SPID Query Service offered by the UPI register of the Central Compensation Office (ZAS). It is used to look up the EPR-SPID of a person, i.e. the sectoral personal identifier of the Swiss Electronic Patient Record.

Actors

eCH-0214 participants — eCH-0214 request and participants

Unlike IHE transactions, eCH-0214 does not define named actors. Producer side corresponds to the SPID Query Service consumer, i.e. usually an EPR community. Consumer side corresponds to the SPID Query Service provider (UPI).

Dependencies

In a Maven-based environment, the following dependency must be registered in pom.xml:

    <dependency>
        <groupId>org.openehealth.ipf.platform-camel</groupId>
        <artifactId>ipf-platform-camel-ihe-ech</artifactId>
        <version>${ipf-version}</version>
    </dependency>

Endpoint URI Format

Producer

The endpoint URI format of the ech-0214 component producers is:

ech-0214://hostname:port/path/to/service[?parameters]

where hostname is either an IP address or a domain name, port is a port number, and path/to/service represents additional path elements of the remote service. URI parameters are optional and control special features as described in the corresponding section below.

Consumer

The endpoint URI format of ech-0214 component consumers is:

ech-0214:serviceName[?parameters]

The resulting URL of the exposed Web Service endpoint depends on both the configuration of the deployment container and the serviceName parameter provided in the Camel endpoint URI. Serving this side is only relevant when simulating the UPI register, e.g. for testing.

Data Types

The ech-0214 component produces and consumes objects of the eCH-0214 model:

Request message – Request
Response message – Response

Both types belong to the package org.openehealth.ipf.commons.ihe.ech.stub.ech_0214._2 and are generated from the eCH-0214 schemas. The service contract is defined by Ech0214PortType, whose single operation is querySpid.

Example

This is an example on how to use the component on the producer side:

    from(...)
      // create an eCH-0214 Request object
      .to("ech-0214://upi.example.ch:8888/wupispid/ws/queryService/2")
      // process the eCH-0214 Response object

Auditing and Validation

eCH-0214 is not an IHE transaction, so no ATNA audit strategy and no message validator are defined for it. Setting the audit URI parameter has no effect, and no audit records are generated.