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

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

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

Enumeration of Document Class, Document Type and Content Type Codes.


Enum Constant Summary
ADVANCED_CARE_DIRECTIVE_CUSTODIAN_RECORD
          Advanced care directive custodian record code.
AUSTRALIAN_CHILDHOOD_IMMUNISATION_REGISTER
          Australian childhood immunisation register code.
AUSTRALIAN_ORGAN_DONOR_REGISTER
          Australian organ donor register code.
CONSUMER_ENTERED_HEALTH_SUMMARY
          Consumer entered health summary code.
CONSUMER_ENTERED_NOTES
          Consumer entered notes code.
DISCHARGE_SUMMARY
          Discharge summary code.
EREFERRAL
          eReferral code.
EVENT_SUMMARY
          Event summary code.
MEDICARE_DVA_BENEFITS_REPORT
          Medicare/DVA benefits report code.
PCEHR_DISPENSE_RECORD
          PCEHR Dispense code.
PCEHR_PRESCRIPTION
          PCEHR Prescription code.
PHARMACEUTICAL_BENEFITS_REPORT
          Pharmaceutical benefits report code.
SHARED_HEALTH_SUMMARY
          Shared health summary code.
SPECIALIST_LETTER
          Specialist letter code.
 
Method Summary
static DocumentTypeCodes findByConceptCode(java.lang.String conceptCode)
          Retrieves a DocumentTypeCodes based on a supplied concept code.
 CodedValue getCodingSystem()
          Retrieve the coding scheme.
 java.lang.String getTypeCodeDisplayName()
          Retrieve type code display name.
static DocumentTypeCodes valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static DocumentTypeCodes[] 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

public static final DocumentTypeCodes SHARED_HEALTH_SUMMARY
Shared health summary code.


EREFERRAL

public static final DocumentTypeCodes EREFERRAL
eReferral code.


SPECIALIST_LETTER

public static final DocumentTypeCodes SPECIALIST_LETTER
Specialist letter code.


DISCHARGE_SUMMARY

public static final DocumentTypeCodes DISCHARGE_SUMMARY
Discharge summary code.


EVENT_SUMMARY

public static final DocumentTypeCodes EVENT_SUMMARY
Event summary code.


PHARMACEUTICAL_BENEFITS_REPORT

public static final DocumentTypeCodes PHARMACEUTICAL_BENEFITS_REPORT
Pharmaceutical benefits report code.


AUSTRALIAN_ORGAN_DONOR_REGISTER

public static final DocumentTypeCodes AUSTRALIAN_ORGAN_DONOR_REGISTER
Australian organ donor register code.


AUSTRALIAN_CHILDHOOD_IMMUNISATION_REGISTER

public static final DocumentTypeCodes AUSTRALIAN_CHILDHOOD_IMMUNISATION_REGISTER
Australian childhood immunisation register code.


MEDICARE_DVA_BENEFITS_REPORT

public static final DocumentTypeCodes MEDICARE_DVA_BENEFITS_REPORT
Medicare/DVA benefits report code.


CONSUMER_ENTERED_NOTES

public static final DocumentTypeCodes CONSUMER_ENTERED_NOTES
Consumer entered notes code.


CONSUMER_ENTERED_HEALTH_SUMMARY

public static final DocumentTypeCodes CONSUMER_ENTERED_HEALTH_SUMMARY
Consumer entered health summary code.


ADVANCED_CARE_DIRECTIVE_CUSTODIAN_RECORD

public static final DocumentTypeCodes ADVANCED_CARE_DIRECTIVE_CUSTODIAN_RECORD
Advanced care directive custodian record code.


PCEHR_PRESCRIPTION

public static final DocumentTypeCodes PCEHR_PRESCRIPTION
PCEHR Prescription code.


PCEHR_DISPENSE_RECORD

public static final DocumentTypeCodes PCEHR_DISPENSE_RECORD
PCEHR Dispense code.

Method Detail

values

public static DocumentTypeCodes[] 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 (DocumentTypeCodes c : DocumentTypeCodes.values())
    System.out.println(c);

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

valueOf

public static DocumentTypeCodes 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

getCodingSystem

public CodedValue getCodingSystem()
Retrieve the coding scheme.

Returns:
CodedValue.

findByConceptCode

public static DocumentTypeCodes findByConceptCode(java.lang.String conceptCode)
Retrieves a DocumentTypeCodes based on a supplied concept code.

Parameters:
conceptCode - Concept to search for.
Returns:
Corresponding DocumentTypeCodes or null.

getTypeCodeDisplayName

public java.lang.String getTypeCodeDisplayName()
Retrieve type code display name.

Returns:
Type code display name.