001package org.hl7.fhir.r4.model.codesystems;
002
003/*
004  Copyright (c) 2011+, HL7, Inc.
005  All rights reserved.
006  
007  Redistribution and use in source and binary forms, with or without modification, 
008  are permitted provided that the following conditions are met:
009  
010   * Redistributions of source code must retain the above copyright notice, this 
011     list of conditions and the following disclaimer.
012   * Redistributions in binary form must reproduce the above copyright notice, 
013     this list of conditions and the following disclaimer in the documentation 
014     and/or other materials provided with the distribution.
015   * Neither the name of HL7 nor the names of its contributors may be used to 
016     endorse or promote products derived from this software without specific 
017     prior written permission.
018  
019  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
020  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
021  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
022  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
023  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
024  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
025  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
026  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
027  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
028  POSSIBILITY OF SUCH DAMAGE.
029  
030*/
031
032// Generated on Wed, Jan 30, 2019 16:19-0500 for FHIR v4.0.0
033
034import org.hl7.fhir.exceptions.FHIRException;
035
036public enum SignatureType {
037
038  /**
039   * the signature of the primary or sole author of a health information document.
040   * There can be only one primary author of a health information document.
041   */
042  OID_1_2_840_10065_1_12_1_1,
043  /**
044   * the signature of a health information document coauthor. There can be
045   * multiple coauthors of a health information document.
046   */
047  OID_1_2_840_10065_1_12_1_2,
048  /**
049   * the signature of an individual who is a participant in the health information
050   * document but is not an author or coauthor. (Example a surgeon who is required
051   * by institutional, regulatory, or legal rules to sign an operative report, but
052   * who was not involved in the authorship of that report.)
053   */
054  OID_1_2_840_10065_1_12_1_3,
055  /**
056   * the signature of an individual who has transcribed a dictated document or
057   * recorded written text into a digital machine readable format.
058   */
059  OID_1_2_840_10065_1_12_1_4,
060  /**
061   * a signature verifying the information contained in a document. (Example a
062   * physician is required to countersign a verbal order that has previously been
063   * recorded in the medical record by a registered nurse who has carried out the
064   * verbal order.)
065   */
066  OID_1_2_840_10065_1_12_1_5,
067  /**
068   * a signature validating a health information document for inclusion in the
069   * patient record. (Example a medical student or resident is credentialed to
070   * perform history or physical examinations and to write progress notes. The
071   * attending physician signs the history and physical examination to validate
072   * the entry for inclusion in the patient's medical record.)
073   */
074  OID_1_2_840_10065_1_12_1_6,
075  /**
076   * the signature of an individual consenting to what is described in a health
077   * information document.
078   */
079  OID_1_2_840_10065_1_12_1_7,
080  /**
081   * the signature of a witness to any other signature.
082   */
083  OID_1_2_840_10065_1_12_1_8,
084  /**
085   * the signature of a witness to an event. (Example the witness has observed a
086   * procedure and is attesting to this fact.)
087   */
088  OID_1_2_840_10065_1_12_1_9,
089  /**
090   * the signature of an individual who has witnessed another individual who is
091   * known to them signing a document. (Example the identity witness is a notary
092   * public.)
093   */
094  OID_1_2_840_10065_1_12_1_10,
095  /**
096   * the signature of an individual who has witnessed the health care provider
097   * counselling a patient.
098   */
099  OID_1_2_840_10065_1_12_1_11,
100  /**
101   * the signature of an individual who has translated health care information
102   * during an event or the obtaining of consent to a treatment.
103   */
104  OID_1_2_840_10065_1_12_1_12,
105  /**
106   * the signature of a person, device, or algorithm that has reviewed or filtered
107   * data for inclusion into the patient record. ( Examples: (1) a medical records
108   * clerk who scans a document for inclusion in the medical record, enters header
109   * information, or catalogues and classifies the data, or a combination thereof;
110   * (2) a gateway that receives data from another computer system and interprets
111   * that data or changes its format, or both, before entering it into the patient
112   * record.)
113   */
114  OID_1_2_840_10065_1_12_1_13,
115  /**
116   * the signature of an automated data source. (Examples: (1) the signature for
117   * an image that is generated by a device for inclusion in the patient record;
118   * (2) the signature for an ECG derived by an ECG system for inclusion in the
119   * patient record; (3) the data from a biomedical monitoring device or system
120   * that is for inclusion in the patient record.)
121   */
122  OID_1_2_840_10065_1_12_1_14,
123  /**
124   * the signature on a new amended document of an individual who has corrected,
125   * edited, or amended an original health information document. An addendum
126   * signature can either be a signature type or a signature sub-type (see 8.1).
127   * Any document with an addendum signature shall have a companion document that
128   * is the original document with its original, unaltered content, and original
129   * signatures. The original document shall be referenced via an attribute in the
130   * new document, which contains, for example, the digest of the old document.
131   * Whether the original, unaltered, document is always displayed with the
132   * addended document is a local matter, but the original, unaltered, document
133   * must remain as part of the patient record and be retrievable on demand.
134   */
135  OID_1_2_840_10065_1_12_1_15,
136  /**
137   * the signature on an original document of an individual who has generated a
138   * new amended document. This (original) document shall reference the new
139   * document via an additional signature purpose. This is the inverse of an
140   * addendum signature and provides a pointer from the original to the amended
141   * document.
142   */
143  OID_1_2_840_10065_1_12_1_16,
144  /**
145   * the signature of an individual who is certifying that the document is
146   * invalidated by an error(s), or is placed in the wrong chart. An
147   * administrative (error/edit) signature must include an addendum to the
148   * document and therefore shall have an addendum signature sub-type (see 8.1).
149   * This signature is reserved for the highest health information system
150   * administrative classification, since it is a statement that the entire
151   * document is invalidated by the error and that the document should no longer
152   * be used for patient care, although for legal reasons the document must remain
153   * part of the permanent patient record.
154   */
155  OID_1_2_840_10065_1_12_1_17,
156  /**
157   * the signature by an entity or device trusted to provide accurate timestamps.
158   * This timestamp might be provided, for example, in the signature time
159   * attribute.
160   */
161  OID_1_2_840_10065_1_12_1_18,
162  /**
163   * added to help the parsers
164   */
165  NULL;
166
167  public static SignatureType fromCode(String codeString) throws FHIRException {
168    if (codeString == null || "".equals(codeString))
169      return null;
170    if ("1.2.840.10065.1.12.1.1".equals(codeString))
171      return OID_1_2_840_10065_1_12_1_1;
172    if ("1.2.840.10065.1.12.1.2".equals(codeString))
173      return OID_1_2_840_10065_1_12_1_2;
174    if ("1.2.840.10065.1.12.1.3".equals(codeString))
175      return OID_1_2_840_10065_1_12_1_3;
176    if ("1.2.840.10065.1.12.1.4".equals(codeString))
177      return OID_1_2_840_10065_1_12_1_4;
178    if ("1.2.840.10065.1.12.1.5".equals(codeString))
179      return OID_1_2_840_10065_1_12_1_5;
180    if ("1.2.840.10065.1.12.1.6".equals(codeString))
181      return OID_1_2_840_10065_1_12_1_6;
182    if ("1.2.840.10065.1.12.1.7".equals(codeString))
183      return OID_1_2_840_10065_1_12_1_7;
184    if ("1.2.840.10065.1.12.1.8".equals(codeString))
185      return OID_1_2_840_10065_1_12_1_8;
186    if ("1.2.840.10065.1.12.1.9".equals(codeString))
187      return OID_1_2_840_10065_1_12_1_9;
188    if ("1.2.840.10065.1.12.1.10".equals(codeString))
189      return OID_1_2_840_10065_1_12_1_10;
190    if ("1.2.840.10065.1.12.1.11".equals(codeString))
191      return OID_1_2_840_10065_1_12_1_11;
192    if ("1.2.840.10065.1.12.1.12".equals(codeString))
193      return OID_1_2_840_10065_1_12_1_12;
194    if ("1.2.840.10065.1.12.1.13".equals(codeString))
195      return OID_1_2_840_10065_1_12_1_13;
196    if ("1.2.840.10065.1.12.1.14".equals(codeString))
197      return OID_1_2_840_10065_1_12_1_14;
198    if ("1.2.840.10065.1.12.1.15".equals(codeString))
199      return OID_1_2_840_10065_1_12_1_15;
200    if ("1.2.840.10065.1.12.1.16".equals(codeString))
201      return OID_1_2_840_10065_1_12_1_16;
202    if ("1.2.840.10065.1.12.1.17".equals(codeString))
203      return OID_1_2_840_10065_1_12_1_17;
204    if ("1.2.840.10065.1.12.1.18".equals(codeString))
205      return OID_1_2_840_10065_1_12_1_18;
206    throw new FHIRException("Unknown SignatureType code '" + codeString + "'");
207  }
208
209  public String toCode() {
210    switch (this) {
211    case OID_1_2_840_10065_1_12_1_1:
212      return "1.2.840.10065.1.12.1.1";
213    case OID_1_2_840_10065_1_12_1_2:
214      return "1.2.840.10065.1.12.1.2";
215    case OID_1_2_840_10065_1_12_1_3:
216      return "1.2.840.10065.1.12.1.3";
217    case OID_1_2_840_10065_1_12_1_4:
218      return "1.2.840.10065.1.12.1.4";
219    case OID_1_2_840_10065_1_12_1_5:
220      return "1.2.840.10065.1.12.1.5";
221    case OID_1_2_840_10065_1_12_1_6:
222      return "1.2.840.10065.1.12.1.6";
223    case OID_1_2_840_10065_1_12_1_7:
224      return "1.2.840.10065.1.12.1.7";
225    case OID_1_2_840_10065_1_12_1_8:
226      return "1.2.840.10065.1.12.1.8";
227    case OID_1_2_840_10065_1_12_1_9:
228      return "1.2.840.10065.1.12.1.9";
229    case OID_1_2_840_10065_1_12_1_10:
230      return "1.2.840.10065.1.12.1.10";
231    case OID_1_2_840_10065_1_12_1_11:
232      return "1.2.840.10065.1.12.1.11";
233    case OID_1_2_840_10065_1_12_1_12:
234      return "1.2.840.10065.1.12.1.12";
235    case OID_1_2_840_10065_1_12_1_13:
236      return "1.2.840.10065.1.12.1.13";
237    case OID_1_2_840_10065_1_12_1_14:
238      return "1.2.840.10065.1.12.1.14";
239    case OID_1_2_840_10065_1_12_1_15:
240      return "1.2.840.10065.1.12.1.15";
241    case OID_1_2_840_10065_1_12_1_16:
242      return "1.2.840.10065.1.12.1.16";
243    case OID_1_2_840_10065_1_12_1_17:
244      return "1.2.840.10065.1.12.1.17";
245    case OID_1_2_840_10065_1_12_1_18:
246      return "1.2.840.10065.1.12.1.18";
247    case NULL:
248      return null;
249    default:
250      return "?";
251    }
252  }
253
254  public String getSystem() {
255    return "urn:iso-astm:E1762-95:2013";
256  }
257
258  public String getDefinition() {
259    switch (this) {
260    case OID_1_2_840_10065_1_12_1_1:
261      return "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.";
262    case OID_1_2_840_10065_1_12_1_2:
263      return "the signature of a health information document coauthor. There can be multiple coauthors of a health information document.";
264    case OID_1_2_840_10065_1_12_1_3:
265      return "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.)";
266    case OID_1_2_840_10065_1_12_1_4:
267      return "the signature of an individual who has transcribed a dictated document or recorded written text into a digital machine readable format.";
268    case OID_1_2_840_10065_1_12_1_5:
269      return "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.)";
270    case OID_1_2_840_10065_1_12_1_6:
271      return "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.)";
272    case OID_1_2_840_10065_1_12_1_7:
273      return "the signature of an individual consenting to what is described in a health information document.";
274    case OID_1_2_840_10065_1_12_1_8:
275      return "the signature of a witness to any other signature.";
276    case OID_1_2_840_10065_1_12_1_9:
277      return "the signature of a witness to an event. (Example the witness has observed a procedure and is attesting to this fact.)";
278    case OID_1_2_840_10065_1_12_1_10:
279      return "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.)";
280    case OID_1_2_840_10065_1_12_1_11:
281      return "the signature of an individual who has witnessed the health care provider counselling a patient.";
282    case OID_1_2_840_10065_1_12_1_12:
283      return "the signature of an individual who has translated health care information during an event or the obtaining of consent to a treatment.";
284    case OID_1_2_840_10065_1_12_1_13:
285      return "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.)";
286    case OID_1_2_840_10065_1_12_1_14:
287      return "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.)";
288    case OID_1_2_840_10065_1_12_1_15:
289      return "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.";
290    case OID_1_2_840_10065_1_12_1_16:
291      return "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.";
292    case OID_1_2_840_10065_1_12_1_17:
293      return "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.";
294    case OID_1_2_840_10065_1_12_1_18:
295      return "the signature by an entity or device trusted to provide accurate timestamps. This timestamp might be provided, for example, in the signature time attribute.";
296    case NULL:
297      return null;
298    default:
299      return "?";
300    }
301  }
302
303  public String getDisplay() {
304    switch (this) {
305    case OID_1_2_840_10065_1_12_1_1:
306      return "Author's Signature";
307    case OID_1_2_840_10065_1_12_1_2:
308      return "Coauthor's Signature";
309    case OID_1_2_840_10065_1_12_1_3:
310      return "Co-participant's Signature";
311    case OID_1_2_840_10065_1_12_1_4:
312      return "Transcriptionist/Recorder Signature";
313    case OID_1_2_840_10065_1_12_1_5:
314      return "Verification Signature";
315    case OID_1_2_840_10065_1_12_1_6:
316      return "Validation Signature";
317    case OID_1_2_840_10065_1_12_1_7:
318      return "Consent Signature";
319    case OID_1_2_840_10065_1_12_1_8:
320      return "Signature Witness Signature";
321    case OID_1_2_840_10065_1_12_1_9:
322      return "Event Witness Signature";
323    case OID_1_2_840_10065_1_12_1_10:
324      return "Identity Witness Signature";
325    case OID_1_2_840_10065_1_12_1_11:
326      return "Consent Witness Signature";
327    case OID_1_2_840_10065_1_12_1_12:
328      return "Interpreter Signature";
329    case OID_1_2_840_10065_1_12_1_13:
330      return "Review Signature";
331    case OID_1_2_840_10065_1_12_1_14:
332      return "Source Signature";
333    case OID_1_2_840_10065_1_12_1_15:
334      return "Addendum Signature";
335    case OID_1_2_840_10065_1_12_1_16:
336      return "Modification Signature";
337    case OID_1_2_840_10065_1_12_1_17:
338      return "Administrative (Error/Edit) Signature";
339    case OID_1_2_840_10065_1_12_1_18:
340      return "Timestamp Signature";
341    case NULL:
342      return null;
343    default:
344      return "?";
345    }
346  }
347
348}