org.openehealth.ipf.commons.ihe.fhir.translation

Interface UriMapper

All Known Implementing Classes:

AbstractUriMapper, DefaultUriMapper

public interface UriMapper

The FHIR Identifier type introduces a new mechanism for conveying the originating system of a particular identifier. Whereas HL7 Version 2 and Version 3 messages identify an assigning 1480 organization as a HD or an OID in the 'root' attribute respectively, HL7 FHIR permits the use of a URI. This requires some configuration on the part of actors to correctly map a URL to an OID or HD to maintain consistency with other actors which are not implementing the FHIR specification.

Since:

3.1

Author:

Christian Ohr

Method Summary

Modifier and Type	Method and Description
String	oidToUri(String oid) Translates an OID into an URI.
String	uriToNamespace(String uri) Translates an URI into a Namespace.
String	uriToOid(String uri) Translates an URI into an OID.

Method Detail

uriToOid

String uriToOid(String uri)
         throws URISyntaxException

Translates an URI into an OID. If the URI is an (OID) URN, the namespace-specific part should, be used as the OID.

Parameters:

uri - the URI

Returns:

the mapped OID or null if no OID could be identified

Throws:

URISyntaxException - if the uri string is no valid URI

uriToNamespace

String uriToNamespace(String uri)
               throws URISyntaxException

Translates an URI into a Namespace.

Parameters:

uri - the URI

Returns:

the mapped namespace or null if no namespace could be identified

Throws:

URISyntaxException - if the uri string is no valid URI

oidToUri

String oidToUri(String oid)
         throws URISyntaxException

Translates an OID into an URI. Instead of a real mapping, an URN can be derived from the OID (i.e. urn:oid:1.2.3.4), but in general the inverse mapping to uriToOid(String) should be applied.

Parameters:

oid - the OID

Returns:

the mapped URI

Throws:

URISyntaxException