mhd-iti68 component

The mhd-iti68 component provides interfaces for actors of the Retrieve Document IHE transaction (ITI-68), which is described in the IHE IT Infrastructure Technical Framework Supplement, Mobile Access to Health Documents (MHD), Section 3.68.

Actors

The transaction defines the following actors:

ITI-68 actors
ITI-68 transaction and actors

Producer side corresponds to the Document Consumer actor. Consumer side corresponds to both Document Responder actor.

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-fhir-r4-mhd</artifactId>
        <version>${ipf-version}</version>
    </dependency>

Endpoint URI Format

Producer

There is no producer created by this endpoint. The component can only be used on the server-side.

Consumer

The endpoint URI format of mhd-iti68 component consumers is:

mhd-iti68://serviceName[?parameters]

The resulting URL of the exposed FHIR REST Service endpoint depends on the configuration of the deployment container. Consider a Tomcat container on host eHealth.server.org is configured in the following way:

port = 8888
contextPath = /IHE
servletPath = /fhir/*

Then the mhd-iti68 consumer will be available for external clients under the URL http://eHealth.server.org:8888/IHE/fhir.

URI parameters controlling the transaction features are described below.

Example

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

    from("mhd-iti68://service?audit=true&secure=true")
      .process(myProcessor)
      // process the incoming request and create a response

Basic Common Component Features

The ITI-68 endpoint forwards a preliminary Iti68AuditDataset instance in a Camel message header named AuditDataset. The Camel consumer route has the possibility adding the unique document ID, and, if applicable in scenarios involving XDS, an optional patient ID, repository ID and home community ID in order to populate this AuditDataset with more information. This is because the document retrieval URL is completely unspecified with regard to this information.

Remarks for this component

Although this component is part of a FHIR-specific module, it just responds to a plain servlet request, which can be about any URL that is mapped on the Camel servlet (see deployment container). The successful response does consist of a binary data stream, representing the document content.