SignatureTypeCodesEnum (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- java.lang.Enum<SignatureTypeCodesEnum>
- - ca.uhn.fhir.model.dstu2.valueset.SignatureTypeCodesEnum

All Implemented Interfaces:: Serializable, Comparable<SignatureTypeCodesEnum>

public enum SignatureTypeCodesEnum
extends Enum<SignatureTypeCodesEnum>

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADDENDUM` Display: Addendum Code Value: 1.2.840.10065.1.12.1.15 the signature on a new amended document of an individual who has corrected, edited, or amended an original health information document.
`ADMINISTRATIVE` Display: Administrative Code Value: 1.2.840.10065.1.12.1.16 the signature on an original document of an individual who has generated a new amended document.
`AUTHORID` Display: AuthorID Code Value: 1.2.840.10065.1.12.1.1 the signature of the primary or sole author of a health information document.
`CO_AUTHORID` Display: Co-AuthorID Code Value: 1.2.840.10065.1.12.1.2 the signature of a health information document coauthor.
`CO_PARTICIPATED` Display: Co-Participated Code Value: 1.2.840.10065.1.12.1.3 the signature of an individual who is a participant in the health information document but is not an author or coauthor.
`CONSENT` Display: Consent Code Value: 1.2.840.10065.1.12.1.7 the signature of an individual consenting to what is described in a health information document.
`CONSENT_WITNESS` Display: Consent-Witness Code Value: 1.2.840.10065.1.12.1.11 the signature of an individual who has witnessed the health care provider counselling a patient.
`EVENT_WITNESS` Display: Event-Witness Code Value: 1.2.840.10065.1.12.1.9 the signature of a witness to an event.
`IDENTITY_WITNESS` Display: Identity-Witness Code Value: 1.2.840.10065.1.12.1.10 the signature of an individual who has witnessed another individual who is known to them signing a document.
`INTERPRETER` Display: Interpreter Code Value: 1.2.840.10065.1.12.1.12 the signature of an individual who has translated health care information during an event or the obtaining of consent to a treatment.
`REVIEW` Display: Review Code Value: 1.2.840.10065.1.12.1.13 the signature of a person, device, or algorithm that has reviewed or filtered data for inclusion into the patient record.
`SOURCE` Display: Source Code Value: 1.2.840.10065.1.12.1.14 the signature of an automated data source.
`TIMESTAMP` Display: Timestamp Code Value: 1.2.840.10065.1.12.1.17 the signature of an individual who is certifying that the document is invalidated by an error(s), or is placed in the wrong chart.
`TRANSCRIPTIONIST` Display: Transcriptionist Code Value: 1.2.840.10065.1.12.1.4 the signature of an individual who has transcribed a dictated document or recorded written text into a digital machine readable format.
`VALIDATION` Display: Validation Code Value: 1.2.840.10065.1.12.1.6 a signature validating a health information document for inclusion in the patient record.
`VERIFICATION` Display: Verification Code Value: 1.2.840.10065.1.12.1.5 a signature verifying the information contained in a document.
`WITNESS` Display: Witness Code Value: 1.2.840.10065.1.12.1.8 the signature of a witness to any other signature.

Field Summary

Fields
Modifier and Type	Field and Description
`static IValueSetEnumBinder<SignatureTypeCodesEnum>`	`VALUESET_BINDER` Converts codes to their respective enumerated values
`static String`	`VALUESET_IDENTIFIER` Identifier for this Value Set:
`static String`	`VALUESET_NAME` Name for this Value Set: Signature Type Codes

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SignatureTypeCodesEnum`	`forCode(String theCode)` Returns the enumerated value associated with this code
`String`	`getCode()` Returns the code associated with this enumerated value
`String`	`getSystem()` Returns the code system associated with this enumerated value
`static SignatureTypeCodesEnum`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SignatureTypeCodesEnum[]`	`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
  - AUTHORID
```
public static final SignatureTypeCodesEnum AUTHORID
```
    Display: AuthorID
    Code Value: 1.2.840.10065.1.12.1.1 the signature of the primary or sole author of a health information document. There can be only one primary author of a health information document.
  - CO_AUTHORID
```
public static final SignatureTypeCodesEnum CO_AUTHORID
```
    Display: Co-AuthorID
    Code Value: 1.2.840.10065.1.12.1.2 the signature of a health information document coauthor. There can be multiple coauthors of a health information document.
  - CO_PARTICIPATED
```
public static final SignatureTypeCodesEnum CO_PARTICIPATED
```
    Display: Co-Participated
    Code Value: 1.2.840.10065.1.12.1.3 the signature of an individual who is a participant in the health information document but is not an author or coauthor. (Example a surgeon who is required by institutional, regulatory, or legal rules to sign an operative report, but who was not involved in the authorship of that report.)
  - TRANSCRIPTIONIST
```
public static final SignatureTypeCodesEnum TRANSCRIPTIONIST
```
    Display: Transcriptionist
    Code Value: 1.2.840.10065.1.12.1.4 the signature of an individual who has transcribed a dictated document or recorded written text into a digital machine readable format.
  - VERIFICATION
```
public static final SignatureTypeCodesEnum VERIFICATION
```
    Display: Verification
    Code Value: 1.2.840.10065.1.12.1.5 a signature verifying the information contained in a document. (Example a physician is required to countersign a verbal order that has previously been recorded in the medical record by a registered nurse who has carried out the verbal order.)
  - VALIDATION
```
public static final SignatureTypeCodesEnum VALIDATION
```
    Display: Validation
    Code Value: 1.2.840.10065.1.12.1.6 a signature validating a health information document for inclusion in the patient record. (Example a medical student or resident is credentialed to perform history or physical examinations and to write progress notes. The attending physician signs the history and physical examination to validate the entry for inclusion in the patient's medical record.)
  - CONSENT
```
public static final SignatureTypeCodesEnum CONSENT
```
    Display: Consent
    Code Value: 1.2.840.10065.1.12.1.7 the signature of an individual consenting to what is described in a health information document.
  - WITNESS
```
public static final SignatureTypeCodesEnum WITNESS
```
    Display: Witness
    Code Value: 1.2.840.10065.1.12.1.8 the signature of a witness to any other signature.
  - EVENT_WITNESS
```
public static final SignatureTypeCodesEnum EVENT_WITNESS
```
    Display: Event-Witness
    Code Value: 1.2.840.10065.1.12.1.9 the signature of a witness to an event. (Example the witness has observed a procedure and is attesting to this fact.)
  - IDENTITY_WITNESS
```
public static final SignatureTypeCodesEnum IDENTITY_WITNESS
```
    Display: Identity-Witness
    Code Value: 1.2.840.10065.1.12.1.10 the signature of an individual who has witnessed another individual who is known to them signing a document. (Example the identity witness is a notary public.)
  - CONSENT_WITNESS
```
public static final SignatureTypeCodesEnum CONSENT_WITNESS
```
    Display: Consent-Witness
    Code Value: 1.2.840.10065.1.12.1.11 the signature of an individual who has witnessed the health care provider counselling a patient.
  - INTERPRETER
```
public static final SignatureTypeCodesEnum INTERPRETER
```
    Display: Interpreter
    Code Value: 1.2.840.10065.1.12.1.12 the signature of an individual who has translated health care information during an event or the obtaining of consent to a treatment.
  - REVIEW
```
public static final SignatureTypeCodesEnum REVIEW
```
    Display: Review
    Code Value: 1.2.840.10065.1.12.1.13 the signature of a person, device, or algorithm that has reviewed or filtered data for inclusion into the patient record. ( Examples: (1) a medical records clerk who scans a document for inclusion in the medical record, enters header information, or catalogues and classifies the data, or a combination thereof; (2) a gateway that receives data from another computer system and interprets that data or changes its format, or both, before entering it into the patient record.)
  - SOURCE
```
public static final SignatureTypeCodesEnum SOURCE
```
    Display: Source
    Code Value: 1.2.840.10065.1.12.1.14 the signature of an automated data source. (Examples: (1) the signature for an image that is generated by a device for inclusion in the patient record; (2) the signature for an ECG derived by an ECG system for inclusion in the patient record; (3) the data from a biomedical monitoring device or system that is for inclusion in the patient record.)
  - ADDENDUM
```
public static final SignatureTypeCodesEnum ADDENDUM
```
    Display: Addendum
    Code Value: 1.2.840.10065.1.12.1.15 the signature on a new amended document of an individual who has corrected, edited, or amended an original health information document. An addendum signature can either be a signature type or a signature sub-type (see 8.1). Any document with an addendum signature shall have a companion document that is the original document with its original, unaltered content, and original signatures. The original document shall be referenced via an attribute in the new document, which contains, for example, the digest of the old document. Whether the original, unaltered, document is always displayed with the addended document is a local matter, but the original, unaltered, document must remain as part of the patient record and be retrievable on demand.
  - ADMINISTRATIVE
```
public static final SignatureTypeCodesEnum ADMINISTRATIVE
```
    Display: Administrative
    Code Value: 1.2.840.10065.1.12.1.16 the signature on an original document of an individual who has generated a new amended document. This (original) document shall reference the new document via an additional signature purpose. This is the inverse of an addendum signature and provides a pointer from the original to the amended document.
  - TIMESTAMP
```
public static final SignatureTypeCodesEnum TIMESTAMP
```
    Display: Timestamp
    Code Value: 1.2.840.10065.1.12.1.17 the signature of an individual who is certifying that the document is invalidated by an error(s), or is placed in the wrong chart. An administrative (error/edit) signature must include an addendum to the document and therefore shall have an addendum signature sub-type (see 8.1). This signature is reserved for the highest health information system administrative classification, since it is a statement that the entire document is invalidated by the error and that the document should no longer be used for patient care, although for legal reasons the document must remain part of the permanent patient record.
- Field Detail
  - VALUESET_IDENTIFIER
```
public static final String VALUESET_IDENTIFIER
```
    Identifier for this Value Set:
    
    See Also:
    
    Constant Field Values
  - VALUESET_NAME
```
public static final String VALUESET_NAME
```
    Name for this Value Set: Signature Type Codes
    
    See Also:
    
    Constant Field Values
  - VALUESET_BINDER
```
public static final IValueSetEnumBinder<SignatureTypeCodesEnum> VALUESET_BINDER
```
    Converts codes to their respective enumerated values
- Method Detail
  - values
```
public static SignatureTypeCodesEnum[] 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 (SignatureTypeCodesEnum c : SignatureTypeCodesEnum.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SignatureTypeCodesEnum valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getCode
```
public String getCode()
```
    Returns the code associated with this enumerated value
  - getSystem
```
public String getSystem()
```
    Returns the code system associated with this enumerated value
  - forCode
```
public static SignatureTypeCodesEnum forCode(String theCode)
```
    Returns the enumerated value associated with this code

Enum SignatureTypeCodesEnum

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AUTHORID

CO_AUTHORID

CO_PARTICIPATED

TRANSCRIPTIONIST

VERIFICATION

VALIDATION

CONSENT

WITNESS

EVENT_WITNESS

IDENTITY_WITNESS

CONSENT_WITNESS

INTERPRETER

REVIEW

SOURCE

ADDENDUM

ADMINISTRATIVE

TIMESTAMP

Field Detail

VALUESET_IDENTIFIER

VALUESET_NAME

VALUESET_BINDER

Method Detail

values

valueOf

getCode

getSystem

forCode