001package org.hl7.fhir.dstu3.model.codesystems;
002
003/*-
004 * #%L
005 * org.hl7.fhir.dstu3
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 Sat, Mar 25, 2017 21:03-0400 for FHIR v3.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         * added to help the parsers
102         */
103        NULL;
104        public static SearchModifierCode fromCode(String codeString) throws FHIRException {
105            if (codeString == null || "".equals(codeString))
106                return null;
107        if ("missing".equals(codeString))
108          return MISSING;
109        if ("exact".equals(codeString))
110          return EXACT;
111        if ("contains".equals(codeString))
112          return CONTAINS;
113        if ("not".equals(codeString))
114          return NOT;
115        if ("text".equals(codeString))
116          return TEXT;
117        if ("in".equals(codeString))
118          return IN;
119        if ("not-in".equals(codeString))
120          return NOTIN;
121        if ("below".equals(codeString))
122          return BELOW;
123        if ("above".equals(codeString))
124          return ABOVE;
125        if ("type".equals(codeString))
126          return TYPE;
127        throw new FHIRException("Unknown SearchModifierCode code '"+codeString+"'");
128        }
129        public String toCode() {
130          switch (this) {
131            case MISSING: return "missing";
132            case EXACT: return "exact";
133            case CONTAINS: return "contains";
134            case NOT: return "not";
135            case TEXT: return "text";
136            case IN: return "in";
137            case NOTIN: return "not-in";
138            case BELOW: return "below";
139            case ABOVE: return "above";
140            case TYPE: return "type";
141            default: return "?";
142          }
143        }
144        public String getSystem() {
145          return "http://hl7.org/fhir/search-modifier-code";
146        }
147        public String getDefinition() {
148          switch (this) {
149            case MISSING: return "The search parameter returns resources that have a value or not.";
150            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).";
151            case CONTAINS: return "The search parameter returns resources that include the supplied parameter value anywhere within the field being searched.";
152            case NOT: return "The search parameter returns resources that do not contain a match.";
153            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.";
154            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.";
155            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.";
156            case BELOW: return "The search parameter tests whether the value in a resource is subsumed by the specified value (is-a, or hierarchical relationships).";
157            case ABOVE: return "The search parameter tests whether the value in a resource subsumes the specified value (is-a, or hierarchical relationships).";
158            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.).";
159            default: return "?";
160          }
161        }
162        public String getDisplay() {
163          switch (this) {
164            case MISSING: return "Missing";
165            case EXACT: return "Exact";
166            case CONTAINS: return "Contains";
167            case NOT: return "Not";
168            case TEXT: return "Text";
169            case IN: return "In";
170            case NOTIN: return "Not In";
171            case BELOW: return "Below";
172            case ABOVE: return "Above";
173            case TYPE: return "Type";
174            default: return "?";
175          }
176    }
177
178
179}
180