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 MeasurePopulation {
059
060        /**
061         * The initial population refers to all patients or events to be evaluated by a quality measure involving patients who share a common set of specified characterstics. All patients or events counted (for example, as numerator, as denominator) are drawn from the initial population.
062         */
063        INITIALPOPULATION, 
064        /**
065         * The upper portion of a fraction used to calculate a rate, proportion, or ratio. Also called the measure focus, it is the target process, condition, event, or outcome. Numerator criteria are the processes or outcomes expected for each patient, or event defined in the denominator. A numerator statement describes the clinical action that satisfies the conditions of the measure.
066         */
067        NUMERATOR, 
068        /**
069         * Numerator exclusion criteria define patients or events to be removed from the numerator. Numerator exclusions are used in proportion and ratio measures to help narrow the numerator (for inverted measures).
070         */
071        NUMERATOREXCLUSION, 
072        /**
073         * The lower portion of a fraction used to calculate a rate, proportion, or ratio. The denominator can be the same as the initial population, or a subset of the initial population to further constrain the population for the purpose of the measure.
074         */
075        DENOMINATOR, 
076        /**
077         * Denominator exclusion criteria define patients or events that should be removed from the denominator before determining if numerator criteria are met. Denominator exclusions are used in proportion and ratio measures to help narrow the denominator. For example, patients with bilateral lower extremity amputations would be listed as a denominator exclusion for a measure requiring foot exams.
078         */
079        DENOMINATOREXCLUSION, 
080        /**
081         * Denominator exceptions are conditions that should remove a patient or event from the denominator of a measure only if the numerator criteria are not met. Denominator exception allows for adjustment of the calculated score for those providers with higher risk populations. Denominator exception criteria are only used in proportion measures.
082         */
083        DENOMINATOREXCEPTION, 
084        /**
085         * Measure population criteria define the patients or events for which the individual observation for the measure should be taken. Measure populations are used for continuous variable measures rather than numerator and denominator criteria.
086         */
087        MEASUREPOPULATION, 
088        /**
089         * Measure population criteria define the patients or events that should be removed from the measure population before determining the outcome of one or more continuous variables defined for the measure observation. Measure population exclusion criteria are used within continuous variable measures to help narrow the measure population.
090         */
091        MEASUREPOPULATIONEXCLUSION, 
092        /**
093         * Defines the individual observation to be performed for each patient or event in the measure population. Measure observations for each case in the population are aggregated to determine the overall measure score for the population.
094         */
095        MEASUREOBSERVATION, 
096        /**
097         * added to help the parsers
098         */
099        NULL;
100        public static MeasurePopulation fromCode(String codeString) throws FHIRException {
101            if (codeString == null || "".equals(codeString))
102                return null;
103        if ("initial-population".equals(codeString))
104          return INITIALPOPULATION;
105        if ("numerator".equals(codeString))
106          return NUMERATOR;
107        if ("numerator-exclusion".equals(codeString))
108          return NUMERATOREXCLUSION;
109        if ("denominator".equals(codeString))
110          return DENOMINATOR;
111        if ("denominator-exclusion".equals(codeString))
112          return DENOMINATOREXCLUSION;
113        if ("denominator-exception".equals(codeString))
114          return DENOMINATOREXCEPTION;
115        if ("measure-population".equals(codeString))
116          return MEASUREPOPULATION;
117        if ("measure-population-exclusion".equals(codeString))
118          return MEASUREPOPULATIONEXCLUSION;
119        if ("measure-observation".equals(codeString))
120          return MEASUREOBSERVATION;
121        throw new FHIRException("Unknown MeasurePopulation code '"+codeString+"'");
122        }
123        public String toCode() {
124          switch (this) {
125            case INITIALPOPULATION: return "initial-population";
126            case NUMERATOR: return "numerator";
127            case NUMERATOREXCLUSION: return "numerator-exclusion";
128            case DENOMINATOR: return "denominator";
129            case DENOMINATOREXCLUSION: return "denominator-exclusion";
130            case DENOMINATOREXCEPTION: return "denominator-exception";
131            case MEASUREPOPULATION: return "measure-population";
132            case MEASUREPOPULATIONEXCLUSION: return "measure-population-exclusion";
133            case MEASUREOBSERVATION: return "measure-observation";
134            default: return "?";
135          }
136        }
137        public String getSystem() {
138          return "http://terminology.hl7.org/CodeSystem/measure-population";
139        }
140        public String getDefinition() {
141          switch (this) {
142            case INITIALPOPULATION: return "The initial population refers to all patients or events to be evaluated by a quality measure involving patients who share a common set of specified characterstics. All patients or events counted (for example, as numerator, as denominator) are drawn from the initial population.";
143            case NUMERATOR: return "The upper portion of a fraction used to calculate a rate, proportion, or ratio. Also called the measure focus, it is the target process, condition, event, or outcome. Numerator criteria are the processes or outcomes expected for each patient, or event defined in the denominator. A numerator statement describes the clinical action that satisfies the conditions of the measure.";
144            case NUMERATOREXCLUSION: return "Numerator exclusion criteria define patients or events to be removed from the numerator. Numerator exclusions are used in proportion and ratio measures to help narrow the numerator (for inverted measures).";
145            case DENOMINATOR: return "The lower portion of a fraction used to calculate a rate, proportion, or ratio. The denominator can be the same as the initial population, or a subset of the initial population to further constrain the population for the purpose of the measure.";
146            case DENOMINATOREXCLUSION: return "Denominator exclusion criteria define patients or events that should be removed from the denominator before determining if numerator criteria are met. Denominator exclusions are used in proportion and ratio measures to help narrow the denominator. For example, patients with bilateral lower extremity amputations would be listed as a denominator exclusion for a measure requiring foot exams.";
147            case DENOMINATOREXCEPTION: return "Denominator exceptions are conditions that should remove a patient or event from the denominator of a measure only if the numerator criteria are not met. Denominator exception allows for adjustment of the calculated score for those providers with higher risk populations. Denominator exception criteria are only used in proportion measures.";
148            case MEASUREPOPULATION: return "Measure population criteria define the patients or events for which the individual observation for the measure should be taken. Measure populations are used for continuous variable measures rather than numerator and denominator criteria.";
149            case MEASUREPOPULATIONEXCLUSION: return "Measure population criteria define the patients or events that should be removed from the measure population before determining the outcome of one or more continuous variables defined for the measure observation. Measure population exclusion criteria are used within continuous variable measures to help narrow the measure population.";
150            case MEASUREOBSERVATION: return "Defines the individual observation to be performed for each patient or event in the measure population. Measure observations for each case in the population are aggregated to determine the overall measure score for the population.";
151            default: return "?";
152          }
153        }
154        public String getDisplay() {
155          switch (this) {
156            case INITIALPOPULATION: return "Initial Population";
157            case NUMERATOR: return "Numerator";
158            case NUMERATOREXCLUSION: return "Numerator Exclusion";
159            case DENOMINATOR: return "Denominator";
160            case DENOMINATOREXCLUSION: return "Denominator Exclusion";
161            case DENOMINATOREXCEPTION: return "Denominator Exception";
162            case MEASUREPOPULATION: return "Measure Population";
163            case MEASUREPOPULATIONEXCLUSION: return "Measure Population Exclusion";
164            case MEASUREOBSERVATION: return "Measure Observation";
165            default: return "?";
166          }
167    }
168
169
170}
171