ca.uhn.hl7v2.conf.store

Class ProfileCodeStore

java.lang.Object

ca.uhn.hl7v2.conf.store.AbstractCodeStore

ca.uhn.hl7v2.conf.store.ProfileCodeStore

All Implemented Interfaces:

CodeStore

public class ProfileCodeStore
extends AbstractCodeStore

This particular implementation of CodeStore retrieves valid codes and validates codeSystems using tables found in 'spec xml tables only' docs generated from the HL7 Messaging Workbench tool. Note: The codeSystem parameter value used in the following methods must be a concatenation of a coding authority and coding table number that is 4 digits long. Note: The current implementation only accepts a coding authority of HL7

Author:

Neal Acharya, Christian Ohr

Constructor Summary

Constructors

Constructor and Description
ProfileCodeStore(String uri) Creates a ProfileCodeStore object that uses tables found in an 'spec xml tables only' xml doc specified by the input URI.
ProfileCodeStore(URL url) As string constructor but accepts a URL object

Method Summary

Modifier and Type	Method and Description
String[]	getValidCodes(String codeSystem) Retrieves all codes for a given conformance profile and codeSystem.
boolean	knowsCodes(String codeSystem) Validates the codeSystem against the input conformance profile.

Methods inherited from class ca.uhn.hl7v2.conf.store.AbstractCodeStore

isValidCode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProfileCodeStore

public ProfileCodeStore(String uri)
                 throws ProfileException,
                        IOException

Creates a ProfileCodeStore object that uses tables found in an 'spec xml tables only' xml doc specified by the input URI. The private field member tableDoc is created with content from the xml doc specified by the URI.

Parameters:

uri - the location of the specification XML file

Throws:

ProfileException

IOException

ProfileCodeStore

public ProfileCodeStore(URL url)
                 throws ProfileException,
                        IOException

As string constructor but accepts a URL object

Throws:

ProfileException

IOException

Method Detail

getValidCodes

public String[] getValidCodes(String codeSystem)
                       throws ProfileException

Retrieves all codes for a given conformance profile and codeSystem. Note: The codeSystem parameter value must be a concatenation of a coding authority and coding table number that is 4 digits long. Note: The current implementation only accepts a coding authority of HL7

Parameters:

codeSystem -

Returns:

String[]

Throws:

ProfileException

See Also:

ca.uhn.hl7v2.conf.store.CodeStore#getValidCodes(java.lang.String, java.lang.String)

knowsCodes

public boolean knowsCodes(String codeSystem)

Validates the codeSystem against the input conformance profile. If valid then output is 'true' else 'false'. Note: The codeSystem parameter value must be a concatenation of a coding authority and coding table number that is 4 digits long. Note: The current implementation only accepts a coding authority of HL7

Parameters:

codeSystem -

Returns:

boolean

See Also:

ca.uhn.hl7v2.conf.store.CodeStore#knowsCodes(java.lang.String, java.lang.String)