001package org.hl7.fhir.r4.model.codesystems;
002
003/*-
004 * #%L
005 * org.hl7.fhir.r4
006 * %%
007 * Copyright (C) 2014 - 2019 Health Level 7
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 * 
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 * 
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023
024/*
025  Copyright (c) 2011+, HL7, Inc.
026  All rights reserved.
027  
028  Redistribution and use in source and binary forms, with or without modification, 
029  are permitted provided that the following conditions are met:
030  
031   * Redistributions of source code must retain the above copyright notice, this 
032     list of conditions and the following disclaimer.
033   * Redistributions in binary form must reproduce the above copyright notice, 
034     this list of conditions and the following disclaimer in the documentation 
035     and/or other materials provided with the distribution.
036   * Neither the name of HL7 nor the names of its contributors may be used to 
037     endorse or promote products derived from this software without specific 
038     prior written permission.
039  
040  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
041  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
042  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
043  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
044  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
045  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
046  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
047  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
048  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
049  POSSIBILITY OF SUCH DAMAGE.
050  
051*/
052
053// Generated on Wed, Jan 30, 2019 16:19-0500 for FHIR v4.0.0
054
055
056import org.hl7.fhir.exceptions.FHIRException;
057
058public enum SearchModifierCode {
059
060        /**
061         * The search parameter returns resources that have a value or not.
062         */
063        MISSING, 
064        /**
065         * The search parameter returns resources that have a value that exactly matches the supplied parameter (the whole string, including casing and accents).
066         */
067        EXACT, 
068        /**
069         * The search parameter returns resources that include the supplied parameter value anywhere within the field being searched.
070         */
071        CONTAINS, 
072        /**
073         * The search parameter returns resources that do not contain a match.
074         */
075        NOT, 
076        /**
077         * The search parameter is processed as a string that searches text associated with the code/value - either CodeableConcept.text, Coding.display, or Identifier.type.text.
078         */
079        TEXT, 
080        /**
081         * The search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is in the specified value set.
082         */
083        IN, 
084        /**
085         * The search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is not in the specified value set.
086         */
087        NOTIN, 
088        /**
089         * The search parameter tests whether the value in a resource is subsumed by the specified value (is-a, or hierarchical relationships).
090         */
091        BELOW, 
092        /**
093         * The search parameter tests whether the value in a resource subsumes the specified value (is-a, or hierarchical relationships).
094         */
095        ABOVE, 
096        /**
097         * The search parameter only applies to the Resource Type specified as a modifier (e.g. the modifier is not actually :type, but :Patient etc.).
098         */
099        TYPE, 
100        /**
101         * The search parameter applies to the identifier on the resource, not the reference.
102         */
103        IDENTIFIER, 
104        /**
105         * The search parameter has the format system|code|value, where the system and code refer to an Identifier.type.coding.system and .code, and match if any of the type codes match. All 3 parts must be present.
106         */
107        OFTYPE, 
108        /**
109         * added to help the parsers
110         */
111        NULL;
112        public static SearchModifierCode fromCode(String codeString) throws FHIRException {
113            if (codeString == null || "".equals(codeString))
114                return null;
115        if ("missing".equals(codeString))
116          return MISSING;
117        if ("exact".equals(codeString))
118          return EXACT;
119        if ("contains".equals(codeString))
120          return CONTAINS;
121        if ("not".equals(codeString))
122          return NOT;
123        if ("text".equals(codeString))
124          return TEXT;
125        if ("in".equals(codeString))
126          return IN;
127        if ("not-in".equals(codeString))
128          return NOTIN;
129        if ("below".equals(codeString))
130          return BELOW;
131        if ("above".equals(codeString))
132          return ABOVE;
133        if ("type".equals(codeString))
134          return TYPE;
135        if ("identifier".equals(codeString))
136          return IDENTIFIER;
137        if ("ofType".equals(codeString))
138          return OFTYPE;
139        throw new FHIRException("Unknown SearchModifierCode code '"+codeString+"'");
140        }
141        public String toCode() {
142          switch (this) {
143            case MISSING: return "missing";
144            case EXACT: return "exact";
145            case CONTAINS: return "contains";
146            case NOT: return "not";
147            case TEXT: return "text";
148            case IN: return "in";
149            case NOTIN: return "not-in";
150            case BELOW: return "below";
151            case ABOVE: return "above";
152            case TYPE: return "type";
153            case IDENTIFIER: return "identifier";
154            case OFTYPE: return "ofType";
155            default: return "?";
156          }
157        }
158        public String getSystem() {
159          return "http://hl7.org/fhir/search-modifier-code";
160        }
161        public String getDefinition() {
162          switch (this) {
163            case MISSING: return "The search parameter returns resources that have a value or not.";
164            case EXACT: return "The search parameter returns resources that have a value that exactly matches the supplied parameter (the whole string, including casing and accents).";
165            case CONTAINS: return "The search parameter returns resources that include the supplied parameter value anywhere within the field being searched.";
166            case NOT: return "The search parameter returns resources that do not contain a match.";
167            case TEXT: return "The search parameter is processed as a string that searches text associated with the code/value - either CodeableConcept.text, Coding.display, or Identifier.type.text.";
168            case IN: return "The search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is in the specified value set.";
169            case NOTIN: return "The search parameter is a URI (relative or absolute) that identifies a value set, and the search parameter tests whether the coding is not in the specified value set.";
170            case BELOW: return "The search parameter tests whether the value in a resource is subsumed by the specified value (is-a, or hierarchical relationships).";
171            case ABOVE: return "The search parameter tests whether the value in a resource subsumes the specified value (is-a, or hierarchical relationships).";
172            case TYPE: return "The search parameter only applies to the Resource Type specified as a modifier (e.g. the modifier is not actually :type, but :Patient etc.).";
173            case IDENTIFIER: return "The search parameter applies to the identifier on the resource, not the reference.";
174            case OFTYPE: return "The search parameter has the format system|code|value, where the system and code refer to an Identifier.type.coding.system and .code, and match if any of the type codes match. All 3 parts must be present.";
175            default: return "?";
176          }
177        }
178        public String getDisplay() {
179          switch (this) {
180            case MISSING: return "Missing";
181            case EXACT: return "Exact";
182            case CONTAINS: return "Contains";
183            case NOT: return "Not";
184            case TEXT: return "Text";
185            case IN: return "In";
186            case NOTIN: return "Not In";
187            case BELOW: return "Below";
188            case ABOVE: return "Above";
189            case TYPE: return "Type";
190            case IDENTIFIER: return "Identifier";
191            case OFTYPE: return "Of Type";
192            default: return "?";
193          }
194    }
195
196
197}
198