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 ReferenceHandlingPolicy {
037
038  /**
039   * The server supports and populates Literal references (i.e. using
040   * Reference.reference) where they are known (this code does not guarantee that
041   * all references are literal; see 'enforced').
042   */
043  LITERAL,
044  /**
045   * The server allows logical references (i.e. using Reference.identifier).
046   */
047  LOGICAL,
048  /**
049   * The server will attempt to resolve logical references to literal references -
050   * i.e. converting Reference.identifier to Reference.reference (if resolution
051   * fails, the server may still accept resources; see logical).
052   */
053  RESOLVES,
054  /**
055   * The server enforces that references have integrity - e.g. it ensures that
056   * references can always be resolved. This is typically the case for clinical
057   * record systems, but often not the case for middleware/proxy systems.
058   */
059  ENFORCED,
060  /**
061   * The server does not support references that point to other servers.
062   */
063  LOCAL,
064  /**
065   * added to help the parsers
066   */
067  NULL;
068
069  public static ReferenceHandlingPolicy fromCode(String codeString) throws FHIRException {
070    if (codeString == null || "".equals(codeString))
071      return null;
072    if ("literal".equals(codeString))
073      return LITERAL;
074    if ("logical".equals(codeString))
075      return LOGICAL;
076    if ("resolves".equals(codeString))
077      return RESOLVES;
078    if ("enforced".equals(codeString))
079      return ENFORCED;
080    if ("local".equals(codeString))
081      return LOCAL;
082    throw new FHIRException("Unknown ReferenceHandlingPolicy code '" + codeString + "'");
083  }
084
085  public String toCode() {
086    switch (this) {
087    case LITERAL:
088      return "literal";
089    case LOGICAL:
090      return "logical";
091    case RESOLVES:
092      return "resolves";
093    case ENFORCED:
094      return "enforced";
095    case LOCAL:
096      return "local";
097    case NULL:
098      return null;
099    default:
100      return "?";
101    }
102  }
103
104  public String getSystem() {
105    return "http://hl7.org/fhir/reference-handling-policy";
106  }
107
108  public String getDefinition() {
109    switch (this) {
110    case LITERAL:
111      return "The server supports and populates Literal references (i.e. using Reference.reference) where they are known (this code does not guarantee that all references are literal; see 'enforced').";
112    case LOGICAL:
113      return "The server allows logical references (i.e. using Reference.identifier).";
114    case RESOLVES:
115      return "The server will attempt to resolve logical references to literal references - i.e. converting Reference.identifier to Reference.reference (if resolution fails, the server may still accept resources; see logical).";
116    case ENFORCED:
117      return "The server enforces that references have integrity - e.g. it ensures that references can always be resolved. This is typically the case for clinical record systems, but often not the case for middleware/proxy systems.";
118    case LOCAL:
119      return "The server does not support references that point to other servers.";
120    case NULL:
121      return null;
122    default:
123      return "?";
124    }
125  }
126
127  public String getDisplay() {
128    switch (this) {
129    case LITERAL:
130      return "Literal References";
131    case LOGICAL:
132      return "Logical References";
133    case RESOLVES:
134      return "Resolves References";
135    case ENFORCED:
136      return "Reference Integrity Enforced";
137    case LOCAL:
138      return "Local References Only";
139    case NULL:
140      return null;
141    default:
142      return "?";
143    }
144  }
145
146}