Package ca.uhn.hl7v2.conf.store

Interface CodeStore

All Known Implementing Classes:

AbstractCodeStore, ProfileCodeStore

public interface CodeStore

Interface used retrieving and validating codes from user defined and HL7 specific tables that correspond to a conformance profile.

Author:

Neal Acharya

Method Summary

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

Method Details

getValidCodes

String[] getValidCodes(String codeSystem)
                throws ProfileException

Retrieves all codes for a given conformance profile and codeSystem.

Parameters:

codeSystem - a table of codes (for example, HL70001 for administrative sex) valid tables are defined in the HL7 table 0396

Returns:

a list of valid codes

Throws:

ProfileException

knowsCodes

boolean knowsCodes(String codeSystem)

Validates the codeSystem against the input conformance profile. If valid then output is 'true' else 'false'.

Parameters:

codeSystem -

Returns:

true if CodeStore knows the codeSystem

isValidCode

boolean isValidCode(String codeSystem,
 String code)

Validates the input code value against the input conformance profile and corresponding input codeSystem. Returns true if the code is valid and false if it isn't.

Parameters:

codeSystem -

code -

Returns:

true if code is valid for the codeSystem