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
 java.lang.String[] getValidCodes(java.lang.String codeSystem)
           
 boolean isValidCode(java.lang.String codeSystem, java.lang.String code)
           
 boolean knowsCodes(java.lang.String codeSystem)
           
 

Method Detail

getValidCodes

java.lang.String[] getValidCodes(java.lang.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(java.lang.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(java.lang.String codeSystem,
                    java.lang.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.


Copyright © 2001-2011 University Health Network. All Rights Reserved.