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 CodesystemHierarchyMeaning {
037
038  /**
039   * No particular relationship between the concepts can be assumed, except what
040   * can be determined by inspection of the definitions of the elements (possible
041   * reasons to use this: importing from a source where this is not defined, or
042   * where various parts of the hierarchy have different meanings).
043   */
044  GROUPEDBY,
045  /**
046   * A hierarchy where the child concepts have an IS-A relationship with the
047   * parents - that is, all the properties of the parent are also true for its
048   * child concepts. Not that is-a is a property of the concepts, so additional
049   * subsumption relationships may be defined using properties or the
050   * [subsumes](extension-codesystem-subsumes.html) extension.
051   */
052  ISA,
053  /**
054   * Child elements list the individual parts of a composite whole (e.g. body
055   * site).
056   */
057  PARTOF,
058  /**
059   * Child concepts in the hierarchy may have only one parent, and there is a
060   * presumption that the code system is a "closed world" meaning all things must
061   * be in the hierarchy. This results in concepts such as "not otherwise
062   * classified.".
063   */
064  CLASSIFIEDWITH,
065  /**
066   * added to help the parsers
067   */
068  NULL;
069
070  public static CodesystemHierarchyMeaning fromCode(String codeString) throws FHIRException {
071    if (codeString == null || "".equals(codeString))
072      return null;
073    if ("grouped-by".equals(codeString))
074      return GROUPEDBY;
075    if ("is-a".equals(codeString))
076      return ISA;
077    if ("part-of".equals(codeString))
078      return PARTOF;
079    if ("classified-with".equals(codeString))
080      return CLASSIFIEDWITH;
081    throw new FHIRException("Unknown CodesystemHierarchyMeaning code '" + codeString + "'");
082  }
083
084  public String toCode() {
085    switch (this) {
086    case GROUPEDBY:
087      return "grouped-by";
088    case ISA:
089      return "is-a";
090    case PARTOF:
091      return "part-of";
092    case CLASSIFIEDWITH:
093      return "classified-with";
094    case NULL:
095      return null;
096    default:
097      return "?";
098    }
099  }
100
101  public String getSystem() {
102    return "http://hl7.org/fhir/codesystem-hierarchy-meaning";
103  }
104
105  public String getDefinition() {
106    switch (this) {
107    case GROUPEDBY:
108      return "No particular relationship between the concepts can be assumed, except what can be determined by inspection of the definitions of the elements (possible reasons to use this: importing from a source where this is not defined, or where various parts of the hierarchy have different meanings).";
109    case ISA:
110      return "A hierarchy where the child concepts have an IS-A relationship with the parents - that is, all the properties of the parent are also true for its child concepts. Not that is-a is a property of the concepts, so additional subsumption relationships may be defined using properties or the [subsumes](extension-codesystem-subsumes.html) extension.";
111    case PARTOF:
112      return "Child elements list the individual parts of a composite whole (e.g. body site).";
113    case CLASSIFIEDWITH:
114      return "Child concepts in the hierarchy may have only one parent, and there is a presumption that the code system is a \"closed world\" meaning all things must be in the hierarchy. This results in concepts such as \"not otherwise classified.\".";
115    case NULL:
116      return null;
117    default:
118      return "?";
119    }
120  }
121
122  public String getDisplay() {
123    switch (this) {
124    case GROUPEDBY:
125      return "Grouped By";
126    case ISA:
127      return "Is-A";
128    case PARTOF:
129      return "Part Of";
130    case CLASSIFIEDWITH:
131      return "Classified With";
132    case NULL:
133      return null;
134    default:
135      return "?";
136    }
137  }
138
139}