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 V3Confidentiality {
059
060        /**
061         * A specializable code and its leaf codes used in Confidentiality value sets to value the Act.Confidentiality and Role.Confidentiality attribute in accordance with the definition for concept domain "Confidentiality".
062         */
063        _CONFIDENTIALITY, 
064        /**
065         * Definition: Privacy metadata indicating that the information has been de-identified, and there are mitigating circumstances that prevent re-identification, which minimize risk of harm from unauthorized disclosure.  The information requires protection to maintain low sensitivity.
066
067                        
068                           Examples: Includes anonymized, pseudonymized, or non-personally identifiable information such as HIPAA limited data sets.
069
070                        
071                           Map: No clear map to ISO 13606-4 Sensitivity Level (1) Care Management:   RECORD_COMPONENTs that might need to be accessed by a wide range of administrative staff to manage the subject of care's access to health services.
072
073                        
074                           Usage Note: This metadata indicates the receiver may have an obligation to comply with a data use agreement.
075         */
076        L, 
077        /**
078         * Definition: Privacy metadata indicating moderately sensitive information, which presents moderate risk of harm if disclosed without authorization.
079
080                        
081                           Examples: Includes allergies of non-sensitive nature used inform food service; health information a patient authorizes to be used for marketing, released to a bank for a health credit card or savings account; or information in personal health record systems that are not governed under health privacy laws.
082
083                        
084                           Map: Partial Map to ISO 13606-4 Sensitivity Level (2) Clinical Management:  Less sensitive RECORD_COMPONENTs that might need to be accessed by a wider range of personnel not all of whom are actively caring for the patient (e.g. radiology staff).
085
086                        
087                           Usage Note: This metadata indicates that the receiver may be obligated to comply with the receiver's terms of use or privacy policies.
088         */
089        M, 
090        /**
091         * Definition: Privacy metadata indicating that the information is typical, non-stigmatizing health information, which presents typical risk of harm if disclosed without authorization.
092
093                        
094                           Examples: In the US, this includes what HIPAA identifies as the minimum necessary protected health information (PHI) given a covered purpose of use (treatment, payment, or operations).  Includes typical, non-stigmatizing health information disclosed in an application for health, workers compensation, disability, or life insurance.
095
096                        
097                           Map: Partial Map to ISO 13606-4 Sensitivity Level (3) Clinical Care:   Default for normal clinical care access (i.e. most clinical staff directly caring for the patient should be able to access nearly all of the EHR).   Maps to normal confidentiality for treatment information but not to ancillary care, payment and operations.
098
099                        
100                           Usage Note: This metadata indicates that the receiver may be obligated to comply with applicable jurisdictional privacy law or disclosure authorization.
101         */
102        N, 
103        /**
104         * Privacy metadata indicating highly sensitive, potentially stigmatizing information, which presents a high risk to the information subject if disclosed without authorization. May be pre-empted by jurisdictional law, e.g., for public health reporting or emergency treatment.
105
106                        
107                           Examples: Includes information that is additionally protected such as sensitive conditions mental health, HIV, substance abuse, domestic violence, child abuse, genetic disease, and reproductive health; or sensitive demographic information such as a patient's standing as an employee or a celebrity. May be used to indicate proprietary or classified information that is not related to an individual, e.g., secret ingredients in a therapeutic substance; or the name of a manufacturer.
108
109                        
110                           Map: Partial Map to ISO 13606-4 Sensitivity Level (3) Clinical Care: Default for normal clinical care access (i.e. most clinical staff directly caring for the patient should be able to access nearly all of the EHR). Maps to normal confidentiality for treatment information but not to ancillary care, payment and operations..
111
112                        
113                           Usage Note: This metadata indicates that the receiver may be obligated to comply with applicable, prevailing (default) jurisdictional privacy law or disclosure authorization..
114         */
115        R, 
116        /**
117         * Definition: Privacy metadata indicating that the information is not classified as sensitive.
118
119                        
120                           Examples: Includes publicly available information, e.g., business name, phone, email or physical address.
121
122                        
123                           Usage Note: This metadata indicates that the receiver has no obligation to consider additional policies when making access control decisions.   Note that in some jurisdictions, personally identifiable information must be protected as confidential, so it would not be appropriate to assign a confidentiality code of "unrestricted"  to that information even if it is publicly available.
124         */
125        U, 
126        /**
127         * . Privacy metadata indicating that the information is extremely sensitive and likely stigmatizing health information that presents a very high risk if disclosed without authorization.  This information must be kept in the highest confidence.  
128
129                        
130                           Examples:  Includes information about a victim of abuse, patient requested information sensitivity, and taboo subjects relating to health status that must be discussed with the patient by an attending provider before sharing with the patient.  May also include information held under “legal lock� or attorney-client privilege
131
132                        
133                           Map:  This metadata indicates that the receiver may not disclose this information except as directed by the information custodian, who may be the information subject.
134
135                        
136                           Usage Note:  This metadata indicates that the receiver may not disclose this information except as directed by the information custodian, who may be the information subject.
137         */
138        V, 
139        /**
140         * Description: By accessing subject / role and relationship based  rights  (These concepts are mutually exclusive, one and only one is required for a valid confidentiality coding.)
141
142                        
143                           Deprecation Comment:Deprecated due to updated confidentiality codes under ActCode
144         */
145        _CONFIDENTIALITYBYACCESSKIND, 
146        /**
147         * Description: Since the service class can represent knowledge structures that may be considered a trade or business secret, there is sometimes (though rarely) the need to flag those items as of business level confidentiality.  However, no patient related information may ever be of this confidentiality level.
148
149                        
150                           Deprecation Comment: Replced by ActCode.B
151         */
152        B, 
153        /**
154         * Description: Only clinicians may see this item, billing and administration persons can not access this item without special permission.
155
156                        
157                           Deprecation Comment:Deprecated due to updated confidentiality codes under ActCode
158         */
159        D, 
160        /**
161         * Description: Access only to individual persons who are mentioned explicitly as actors of this service and whose actor type warrants that access (cf. to actor type code).
162
163                        
164                           Deprecation Comment:Deprecated due to updated confidentiality codes under ActCode
165         */
166        I, 
167        /**
168         * Description: By information type, only for service catalog entries (multiples allowed). Not to be used with actual patient data!
169
170                        
171                           Deprecation Comment:Deprecated due to updated confidentiality codes under ActCode
172         */
173        _CONFIDENTIALITYBYINFOTYPE, 
174        /**
175         * Description: Alcohol/drug-abuse related item
176
177                        
178                           Deprecation Comment:Replced by ActCode.ETH
179         */
180        ETH, 
181        /**
182         * Description: HIV and AIDS related item
183
184                        
185                           Deprecation Comment:Replced by ActCode.HIV
186         */
187        HIV, 
188        /**
189         * Description: Psychiatry related item
190
191                        
192                           Deprecation Comment:Replced by ActCode.PSY
193         */
194        PSY, 
195        /**
196         * Description: Sexual assault / domestic violence related item
197
198                        
199                           Deprecation Comment:Replced by ActCode.SDV
200         */
201        SDV, 
202        /**
203         * Description: Modifiers of role based access rights  (multiple allowed)
204
205                        
206                           Deprecation Comment:Deprecated due to updated confidentiality codes under ActCode
207         */
208        _CONFIDENTIALITYMODIFIERS, 
209        /**
210         * Description: Celebrities are people of public interest (VIP) including employees, whose information require special protection.
211
212                        
213                           Deprecation Comment:Replced by ActCode.CEL
214         */
215        C, 
216        /**
217         * Description: 
218                        
219Information for which the patient seeks heightened confidentiality. Sensitive information is not to be shared with family members.  Information reported by the patient about family members is sensitive by default. Flag can be set or cleared on patient's request.
220                           Deprecation Comment:Deprecated due to updated confidentiality codes under ActCode
221         */
222        S, 
223        /**
224         * Description: Information not to be disclosed or discussed with patient except through physician assigned to patient in this case.  This is usually a temporary constraint only, example use is a new fatal diagnosis or finding, such as malignancy or HIV.
225
226                        
227                           Deprecation Note:Replced by ActCode.TBOO
228         */
229        T, 
230        /**
231         * added to help the parsers
232         */
233        NULL;
234        public static V3Confidentiality fromCode(String codeString) throws FHIRException {
235            if (codeString == null || "".equals(codeString))
236                return null;
237        if ("_Confidentiality".equals(codeString))
238          return _CONFIDENTIALITY;
239        if ("L".equals(codeString))
240          return L;
241        if ("M".equals(codeString))
242          return M;
243        if ("N".equals(codeString))
244          return N;
245        if ("R".equals(codeString))
246          return R;
247        if ("U".equals(codeString))
248          return U;
249        if ("V".equals(codeString))
250          return V;
251        if ("_ConfidentialityByAccessKind".equals(codeString))
252          return _CONFIDENTIALITYBYACCESSKIND;
253        if ("B".equals(codeString))
254          return B;
255        if ("D".equals(codeString))
256          return D;
257        if ("I".equals(codeString))
258          return I;
259        if ("_ConfidentialityByInfoType".equals(codeString))
260          return _CONFIDENTIALITYBYINFOTYPE;
261        if ("ETH".equals(codeString))
262          return ETH;
263        if ("HIV".equals(codeString))
264          return HIV;
265        if ("PSY".equals(codeString))
266          return PSY;
267        if ("SDV".equals(codeString))
268          return SDV;
269        if ("_ConfidentialityModifiers".equals(codeString))
270          return _CONFIDENTIALITYMODIFIERS;
271        if ("C".equals(codeString))
272          return C;
273        if ("S".equals(codeString))
274          return S;
275        if ("T".equals(codeString))
276          return T;
277        throw new FHIRException("Unknown V3Confidentiality code '"+codeString+"'");
278        }
279        public String toCode() {
280          switch (this) {
281            case _CONFIDENTIALITY: return "_Confidentiality";
282            case L: return "L";
283            case M: return "M";
284            case N: return "N";
285            case R: return "R";
286            case U: return "U";
287            case V: return "V";
288            case _CONFIDENTIALITYBYACCESSKIND: return "_ConfidentialityByAccessKind";
289            case B: return "B";
290            case D: return "D";
291            case I: return "I";
292            case _CONFIDENTIALITYBYINFOTYPE: return "_ConfidentialityByInfoType";
293            case ETH: return "ETH";
294            case HIV: return "HIV";
295            case PSY: return "PSY";
296            case SDV: return "SDV";
297            case _CONFIDENTIALITYMODIFIERS: return "_ConfidentialityModifiers";
298            case C: return "C";
299            case S: return "S";
300            case T: return "T";
301            default: return "?";
302          }
303        }
304        public String getSystem() {
305          return "http://terminology.hl7.org/CodeSystem/v3-Confidentiality";
306        }
307        public String getDefinition() {
308          switch (this) {
309            case _CONFIDENTIALITY: return "A specializable code and its leaf codes used in Confidentiality value sets to value the Act.Confidentiality and Role.Confidentiality attribute in accordance with the definition for concept domain \"Confidentiality\".";
310            case L: return "Definition: Privacy metadata indicating that the information has been de-identified, and there are mitigating circumstances that prevent re-identification, which minimize risk of harm from unauthorized disclosure.  The information requires protection to maintain low sensitivity.\r\n\n                        \n                           Examples: Includes anonymized, pseudonymized, or non-personally identifiable information such as HIPAA limited data sets.\r\n\n                        \n                           Map: No clear map to ISO 13606-4 Sensitivity Level (1) Care Management:   RECORD_COMPONENTs that might need to be accessed by a wide range of administrative staff to manage the subject of care's access to health services.\r\n\n                        \n                           Usage Note: This metadata indicates the receiver may have an obligation to comply with a data use agreement.";
311            case M: return "Definition: Privacy metadata indicating moderately sensitive information, which presents moderate risk of harm if disclosed without authorization.\r\n\n                        \n                           Examples: Includes allergies of non-sensitive nature used inform food service; health information a patient authorizes to be used for marketing, released to a bank for a health credit card or savings account; or information in personal health record systems that are not governed under health privacy laws.\r\n\n                        \n                           Map: Partial Map to ISO 13606-4 Sensitivity Level (2) Clinical Management:  Less sensitive RECORD_COMPONENTs that might need to be accessed by a wider range of personnel not all of whom are actively caring for the patient (e.g. radiology staff).\r\n\n                        \n                           Usage Note: This metadata indicates that the receiver may be obligated to comply with the receiver's terms of use or privacy policies.";
312            case N: return "Definition: Privacy metadata indicating that the information is typical, non-stigmatizing health information, which presents typical risk of harm if disclosed without authorization.\r\n\n                        \n                           Examples: In the US, this includes what HIPAA identifies as the minimum necessary protected health information (PHI) given a covered purpose of use (treatment, payment, or operations).  Includes typical, non-stigmatizing health information disclosed in an application for health, workers compensation, disability, or life insurance.\r\n\n                        \n                           Map: Partial Map to ISO 13606-4 Sensitivity Level (3) Clinical Care:   Default for normal clinical care access (i.e. most clinical staff directly caring for the patient should be able to access nearly all of the EHR).   Maps to normal confidentiality for treatment information but not to ancillary care, payment and operations.\r\n\n                        \n                           Usage Note: This metadata indicates that the receiver may be obligated to comply with applicable jurisdictional privacy law or disclosure authorization.";
313            case R: return "Privacy metadata indicating highly sensitive, potentially stigmatizing information, which presents a high risk to the information subject if disclosed without authorization. May be pre-empted by jurisdictional law, e.g., for public health reporting or emergency treatment.\r\n\n                        \n                           Examples: Includes information that is additionally protected such as sensitive conditions mental health, HIV, substance abuse, domestic violence, child abuse, genetic disease, and reproductive health; or sensitive demographic information such as a patient's standing as an employee or a celebrity. May be used to indicate proprietary or classified information that is not related to an individual, e.g., secret ingredients in a therapeutic substance; or the name of a manufacturer.\r\n\n                        \n                           Map: Partial Map to ISO 13606-4 Sensitivity Level (3) Clinical Care: Default for normal clinical care access (i.e. most clinical staff directly caring for the patient should be able to access nearly all of the EHR). Maps to normal confidentiality for treatment information but not to ancillary care, payment and operations..\r\n\n                        \n                           Usage Note: This metadata indicates that the receiver may be obligated to comply with applicable, prevailing (default) jurisdictional privacy law or disclosure authorization..";
314            case U: return "Definition: Privacy metadata indicating that the information is not classified as sensitive.\r\n\n                        \n                           Examples: Includes publicly available information, e.g., business name, phone, email or physical address.\r\n\n                        \n                           Usage Note: This metadata indicates that the receiver has no obligation to consider additional policies when making access control decisions.   Note that in some jurisdictions, personally identifiable information must be protected as confidential, so it would not be appropriate to assign a confidentiality code of \"unrestricted\"  to that information even if it is publicly available.";
315            case V: return ". Privacy metadata indicating that the information is extremely sensitive and likely stigmatizing health information that presents a very high risk if disclosed without authorization.  This information must be kept in the highest confidence.  \r\n\n                        \n                           Examples:  Includes information about a victim of abuse, patient requested information sensitivity, and taboo subjects relating to health status that must be discussed with the patient by an attending provider before sharing with the patient.  May also include information held under “legal lock� or attorney-client privilege\r\n\n                        \n                           Map:  This metadata indicates that the receiver may not disclose this information except as directed by the information custodian, who may be the information subject.\r\n\n                        \n                           Usage Note:  This metadata indicates that the receiver may not disclose this information except as directed by the information custodian, who may be the information subject.";
316            case _CONFIDENTIALITYBYACCESSKIND: return "Description: By accessing subject / role and relationship based  rights  (These concepts are mutually exclusive, one and only one is required for a valid confidentiality coding.)\r\n\n                        \n                           Deprecation Comment:Deprecated due to updated confidentiality codes under ActCode";
317            case B: return "Description: Since the service class can represent knowledge structures that may be considered a trade or business secret, there is sometimes (though rarely) the need to flag those items as of business level confidentiality.  However, no patient related information may ever be of this confidentiality level.\r\n\n                        \n                           Deprecation Comment: Replced by ActCode.B";
318            case D: return "Description: Only clinicians may see this item, billing and administration persons can not access this item without special permission.\r\n\n                        \n                           Deprecation Comment:Deprecated due to updated confidentiality codes under ActCode";
319            case I: return "Description: Access only to individual persons who are mentioned explicitly as actors of this service and whose actor type warrants that access (cf. to actor type code).\r\n\n                        \n                           Deprecation Comment:Deprecated due to updated confidentiality codes under ActCode";
320            case _CONFIDENTIALITYBYINFOTYPE: return "Description: By information type, only for service catalog entries (multiples allowed). Not to be used with actual patient data!\r\n\n                        \n                           Deprecation Comment:Deprecated due to updated confidentiality codes under ActCode";
321            case ETH: return "Description: Alcohol/drug-abuse related item\r\n\n                        \n                           Deprecation Comment:Replced by ActCode.ETH";
322            case HIV: return "Description: HIV and AIDS related item\r\n\n                        \n                           Deprecation Comment:Replced by ActCode.HIV";
323            case PSY: return "Description: Psychiatry related item\r\n\n                        \n                           Deprecation Comment:Replced by ActCode.PSY";
324            case SDV: return "Description: Sexual assault / domestic violence related item\r\n\n                        \n                           Deprecation Comment:Replced by ActCode.SDV";
325            case _CONFIDENTIALITYMODIFIERS: return "Description: Modifiers of role based access rights  (multiple allowed)\r\n\n                        \n                           Deprecation Comment:Deprecated due to updated confidentiality codes under ActCode";
326            case C: return "Description: Celebrities are people of public interest (VIP) including employees, whose information require special protection.\r\n\n                        \n                           Deprecation Comment:Replced by ActCode.CEL";
327            case S: return "Description: \n                        \r\nInformation for which the patient seeks heightened confidentiality. Sensitive information is not to be shared with family members.  Information reported by the patient about family members is sensitive by default. Flag can be set or cleared on patient's request.\n                           Deprecation Comment:Deprecated due to updated confidentiality codes under ActCode";
328            case T: return "Description: Information not to be disclosed or discussed with patient except through physician assigned to patient in this case.  This is usually a temporary constraint only, example use is a new fatal diagnosis or finding, such as malignancy or HIV.\r\n\n                        \n                           Deprecation Note:Replced by ActCode.TBOO";
329            default: return "?";
330          }
331        }
332        public String getDisplay() {
333          switch (this) {
334            case _CONFIDENTIALITY: return "Confidentiality";
335            case L: return "low";
336            case M: return "moderate";
337            case N: return "normal";
338            case R: return "restricted";
339            case U: return "unrestricted";
340            case V: return "very restricted";
341            case _CONFIDENTIALITYBYACCESSKIND: return "ConfidentialityByAccessKind";
342            case B: return "business";
343            case D: return "clinician";
344            case I: return "individual";
345            case _CONFIDENTIALITYBYINFOTYPE: return "ConfidentialityByInfoType";
346            case ETH: return "substance abuse related";
347            case HIV: return "HIV related";
348            case PSY: return "psychiatry relate";
349            case SDV: return "sexual and domestic violence related";
350            case _CONFIDENTIALITYMODIFIERS: return "ConfidentialityModifiers";
351            case C: return "celebrity";
352            case S: return "sensitive";
353            case T: return "taboo";
354            default: return "?";
355          }
356    }
357
358
359}
360