ca.uhn.hl7v2.conf.store
Interface CodeStore

All Known Implementing Classes:

AbstractCodeStore, ProfileCodeStore

public interface CodeStore

Created on 27-Aug-2003

Author:

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

Method Summary

String[]	getValidCodes(String codeSystem)
boolean	isValidCode(String codeSystem, String code)
boolean	knowsCodes(String codeSystem)

Method Detail

getValidCodes

String[] getValidCodes(String codeSystem)
                       throws ProfileException

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 - Retreives all codes for a given conformance profile and codeSystem.

knowsCodes

boolean knowsCodes(String codeSystem)

Parameters:

codeSystem -

Returns:

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

isValidCode

boolean isValidCode(String codeSystem,
                    String code)

Parameters:

codeSystem -

code -

Returns:

boolean boolean 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.