au.gov.nehta.vendorlibrary.pcehr.clients.common.type
Enum FormatCodes

java.lang.Object
  extended by java.lang.Enum<FormatCodes>
      extended by au.gov.nehta.vendorlibrary.pcehr.clients.common.type.FormatCodes
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FormatCodes>

public enum FormatCodes
extends java.lang.Enum<FormatCodes>

Template package identifiers for the various CDA documents and associated conformance levels.


Enum Constant Summary
ADVANCED_CARE_DIRECTIVE_CUSTODIAN_RECORD_3A
          Advanced care directive custodian record 3A.
AUSTRALIAN_CHILDHOOD_IMMUNISATION_REGISTER_3A
          Australian childhood immunisation register 3A.
AUSTRALIAN_ORGAN_DONOR_REGISTER_3A
          Australian organ donor register 3A.
CONSUMER_ENTERED_HEALTH_SUMMARY_3A
          Consumer entered health summary 3A.
CONSUMER_ENTERED_NOTES_3A
          Consumer entered notes 3A.
DISCHARGE_SUMMARY_1A
          Discharge summary 1A.
DISCHARGE_SUMMARY_1B
          Discharge summary 1B.
DISCHARGE_SUMMARY_2
          Discharge summary 2.
DISCHARGE_SUMMARY_3A
          Discharge summary 3A.
EREFERRAL_1A
          E-referral 1A.
EREFERRAL_1B
          E-referral 1B.
EREFERRAL_2
          E-referral 2.
EREFERRAL_3A
          E-referral 3A.
EVENT_SUMMARY_3A
          Event summary 3A.
MEDICARE_DVA_BENEFITS_RECORD_3A
          Medicare DVA benefits record 3A.
PCEHR_DISPENSE_RECORD
          PCEHR Dispense Record
PCEHR_PRESCRIPTION
          PCEHR Prescription
PHARMACEUTICAL_BENEFITS_REPORT_3A
          Pharmaceutical benefits report 3A.
SHARED_HEALTH_SUMMARY_3A
          Shared health summary 3A.
SPECIALIST_LETTER_1A
          Specialist letter 1A.
SPECIALIST_LETTER_1B
          Specialist letter 1B.
SPECIALIST_LETTER_2
          Specialist letter 2.
SPECIALIST_LETTER_3A
          Specialist letter 3A.
 
Method Summary
static FormatCodes findByTemplateId(java.lang.String templateId)
          Retrieves a FormatCodes based on a supplied concept code.
 CodedValue getCodedValue()
          Retrieves a coded value, representing the template ID.
static FormatCodes valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FormatCodes[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

SHARED_HEALTH_SUMMARY_3A

public static final FormatCodes SHARED_HEALTH_SUMMARY_3A
Shared health summary 3A.


EVENT_SUMMARY_3A

public static final FormatCodes EVENT_SUMMARY_3A
Event summary 3A.


CONSUMER_ENTERED_NOTES_3A

public static final FormatCodes CONSUMER_ENTERED_NOTES_3A
Consumer entered notes 3A.


CONSUMER_ENTERED_HEALTH_SUMMARY_3A

public static final FormatCodes CONSUMER_ENTERED_HEALTH_SUMMARY_3A
Consumer entered health summary 3A.


ADVANCED_CARE_DIRECTIVE_CUSTODIAN_RECORD_3A

public static final FormatCodes ADVANCED_CARE_DIRECTIVE_CUSTODIAN_RECORD_3A
Advanced care directive custodian record 3A.


SPECIALIST_LETTER_1A

public static final FormatCodes SPECIALIST_LETTER_1A
Specialist letter 1A.


SPECIALIST_LETTER_1B

public static final FormatCodes SPECIALIST_LETTER_1B
Specialist letter 1B.


SPECIALIST_LETTER_2

public static final FormatCodes SPECIALIST_LETTER_2
Specialist letter 2.


SPECIALIST_LETTER_3A

public static final FormatCodes SPECIALIST_LETTER_3A
Specialist letter 3A.


EREFERRAL_1A

public static final FormatCodes EREFERRAL_1A
E-referral 1A.


EREFERRAL_1B

public static final FormatCodes EREFERRAL_1B
E-referral 1B.


EREFERRAL_2

public static final FormatCodes EREFERRAL_2
E-referral 2.


EREFERRAL_3A

public static final FormatCodes EREFERRAL_3A
E-referral 3A.


DISCHARGE_SUMMARY_1A

public static final FormatCodes DISCHARGE_SUMMARY_1A
Discharge summary 1A.


DISCHARGE_SUMMARY_1B

public static final FormatCodes DISCHARGE_SUMMARY_1B
Discharge summary 1B.


DISCHARGE_SUMMARY_2

public static final FormatCodes DISCHARGE_SUMMARY_2
Discharge summary 2.


DISCHARGE_SUMMARY_3A

public static final FormatCodes DISCHARGE_SUMMARY_3A
Discharge summary 3A.


PCEHR_PRESCRIPTION

public static final FormatCodes PCEHR_PRESCRIPTION
PCEHR Prescription


PCEHR_DISPENSE_RECORD

public static final FormatCodes PCEHR_DISPENSE_RECORD
PCEHR Dispense Record


MEDICARE_DVA_BENEFITS_RECORD_3A

public static final FormatCodes MEDICARE_DVA_BENEFITS_RECORD_3A
Medicare DVA benefits record 3A.


PHARMACEUTICAL_BENEFITS_REPORT_3A

public static final FormatCodes PHARMACEUTICAL_BENEFITS_REPORT_3A
Pharmaceutical benefits report 3A.


AUSTRALIAN_CHILDHOOD_IMMUNISATION_REGISTER_3A

public static final FormatCodes AUSTRALIAN_CHILDHOOD_IMMUNISATION_REGISTER_3A
Australian childhood immunisation register 3A.


AUSTRALIAN_ORGAN_DONOR_REGISTER_3A

public static final FormatCodes AUSTRALIAN_ORGAN_DONOR_REGISTER_3A
Australian organ donor register 3A.

Method Detail

values

public static FormatCodes[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (FormatCodes c : FormatCodes.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static FormatCodes valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getCodedValue

public CodedValue getCodedValue()
Retrieves a coded value, representing the template ID.

Returns:
CodedValue

findByTemplateId

public static FormatCodes findByTemplateId(java.lang.String templateId)
Retrieves a FormatCodes based on a supplied concept code.

Parameters:
templateId - Template identifier to search for.
Returns:
Corresponding FormatCodes or null.