canvas 0.1.15__py3-none-any.whl → 0.2.10__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of canvas might be problematic. Click here for more details.

Files changed (94) hide show
  1. {canvas-0.1.15.dist-info → canvas-0.2.10.dist-info}/METADATA +7 -1
  2. canvas-0.2.10.dist-info/RECORD +143 -0
  3. canvas_cli/apps/plugin/plugin.py +51 -9
  4. canvas_cli/apps/plugin/tests.py +51 -0
  5. canvas_cli/tests.py +193 -4
  6. canvas_cli/utils/validators/manifest_schema.py +1 -0
  7. canvas_generated/messages/effects_pb2.py +2 -2
  8. canvas_generated/messages/effects_pb2.pyi +138 -0
  9. canvas_generated/messages/events_pb2.py +3 -3
  10. canvas_generated/messages/events_pb2.pyi +616 -0
  11. canvas_sdk/__init__.py +7 -0
  12. canvas_sdk/base.py +6 -2
  13. canvas_sdk/commands/__init__.py +26 -0
  14. canvas_sdk/commands/base.py +35 -32
  15. canvas_sdk/commands/commands/allergy.py +49 -0
  16. canvas_sdk/commands/commands/assess.py +1 -1
  17. canvas_sdk/commands/commands/close_goal.py +22 -0
  18. canvas_sdk/commands/commands/diagnose.py +3 -3
  19. canvas_sdk/commands/commands/family_history.py +18 -0
  20. canvas_sdk/commands/commands/goal.py +3 -3
  21. canvas_sdk/commands/commands/history_present_illness.py +1 -1
  22. canvas_sdk/commands/commands/instruct.py +17 -0
  23. canvas_sdk/commands/commands/lab_order.py +33 -0
  24. canvas_sdk/commands/commands/medical_history.py +34 -0
  25. canvas_sdk/commands/commands/medication_statement.py +1 -1
  26. canvas_sdk/commands/commands/past_surgical_history.py +28 -0
  27. canvas_sdk/commands/commands/perform.py +17 -0
  28. canvas_sdk/commands/commands/plan.py +2 -2
  29. canvas_sdk/commands/commands/prescribe.py +10 -7
  30. canvas_sdk/commands/commands/questionnaire.py +1 -1
  31. canvas_sdk/commands/commands/refill.py +16 -0
  32. canvas_sdk/commands/commands/remove_allergy.py +26 -0
  33. canvas_sdk/commands/commands/stop_medication.py +1 -1
  34. canvas_sdk/commands/commands/task.py +52 -0
  35. canvas_sdk/commands/commands/update_diagnosis.py +27 -0
  36. canvas_sdk/commands/commands/update_goal.py +1 -1
  37. canvas_sdk/commands/commands/vitals.py +78 -0
  38. canvas_sdk/commands/constants.py +7 -0
  39. canvas_sdk/commands/tests/protocol/__init__.py +0 -0
  40. canvas_sdk/commands/tests/protocol/tests.py +55 -0
  41. canvas_sdk/commands/tests/schema/__init__.py +0 -0
  42. canvas_sdk/commands/tests/schema/tests.py +104 -0
  43. canvas_sdk/commands/tests/test_utils.py +170 -6
  44. canvas_sdk/commands/tests/unit/__init__.py +0 -0
  45. canvas_sdk/commands/tests/{tests.py → unit/tests.py} +20 -194
  46. canvas_sdk/data/client.py +82 -0
  47. canvas_sdk/data/patient.py +1 -21
  48. canvas_sdk/effects/banner_alert/add_banner_alert.py +8 -7
  49. canvas_sdk/effects/banner_alert/remove_banner_alert.py +3 -2
  50. canvas_sdk/effects/banner_alert/tests.py +224 -0
  51. canvas_sdk/effects/base.py +3 -5
  52. canvas_sdk/effects/patient_chart_summary_configuration.py +39 -0
  53. canvas_sdk/effects/protocol_card/__init__.py +1 -0
  54. canvas_sdk/effects/protocol_card/protocol_card.py +83 -0
  55. canvas_sdk/effects/protocol_card/tests.py +184 -0
  56. canvas_sdk/handlers/base.py +14 -1
  57. canvas_sdk/protocols/base.py +14 -0
  58. canvas_sdk/protocols/clinical_quality_measure.py +41 -0
  59. canvas_sdk/utils/db.py +17 -0
  60. canvas_sdk/v1/__init__.py +0 -0
  61. canvas_sdk/v1/data/__init__.py +3 -0
  62. canvas_sdk/v1/data/allergy_intolerance.py +63 -0
  63. canvas_sdk/v1/data/base.py +47 -0
  64. canvas_sdk/v1/data/condition.py +48 -0
  65. canvas_sdk/v1/data/lab.py +96 -0
  66. canvas_sdk/v1/data/medication.py +54 -0
  67. canvas_sdk/v1/data/patient.py +49 -0
  68. canvas_sdk/v1/data/user.py +10 -0
  69. canvas_sdk/value_set/tests/test_value_sets.py +65 -0
  70. canvas_sdk/value_set/v2022/adverse_event.py +33 -0
  71. canvas_sdk/value_set/v2022/allergy.py +232 -0
  72. canvas_sdk/value_set/v2022/assessment.py +215 -0
  73. canvas_sdk/value_set/v2022/communication.py +325 -0
  74. canvas_sdk/value_set/v2022/condition.py +40654 -0
  75. canvas_sdk/value_set/v2022/device.py +174 -0
  76. canvas_sdk/value_set/v2022/diagnostic_study.py +4967 -0
  77. canvas_sdk/value_set/v2022/encounter.py +2564 -0
  78. canvas_sdk/value_set/v2022/immunization.py +341 -0
  79. canvas_sdk/value_set/v2022/individual_characteristic.py +307 -0
  80. canvas_sdk/value_set/v2022/intervention.py +1356 -0
  81. canvas_sdk/value_set/v2022/laboratory_test.py +1250 -0
  82. canvas_sdk/value_set/v2022/medication.py +5130 -0
  83. canvas_sdk/value_set/v2022/physical_exam.py +201 -0
  84. canvas_sdk/value_set/v2022/procedure.py +4037 -0
  85. canvas_sdk/value_set/v2022/symptom.py +176 -0
  86. canvas_sdk/value_set/value_set.py +91 -0
  87. canvas-0.1.15.dist-info/RECORD +0 -95
  88. canvas_generated/data_access_layer/data_access_layer_pb2.py +0 -30
  89. canvas_generated/data_access_layer/data_access_layer_pb2.pyi +0 -23
  90. canvas_generated/data_access_layer/data_access_layer_pb2_grpc.py +0 -66
  91. canvas_sdk/data/data_access_layer_client.py +0 -95
  92. canvas_sdk/data/exceptions.py +0 -16
  93. {canvas-0.1.15.dist-info → canvas-0.2.10.dist-info}/WHEEL +0 -0
  94. {canvas-0.1.15.dist-info → canvas-0.2.10.dist-info}/entry_points.txt +0 -0
@@ -0,0 +1,341 @@
1
+ from ..value_set import ValueSet
2
+
3
+
4
+ class DtapVaccine(ValueSet):
5
+ """
6
+ **Clinical Focus:** The purpose of this value set is to represent concepts for immunizations with diphtheria, tetanus, and pertussis (DTaP) vaccines.
7
+
8
+ **Data Element Scope:** This value set may use a model element related to Immunization.
9
+
10
+ **Inclusion Criteria:** Includes concepts that represent a diphtheria, tetanus, and pertussis (DTaP) vaccine.
11
+
12
+ **Exclusion Criteria:** No exclusions.
13
+
14
+ ** Used in:** CMS117v10
15
+ """
16
+
17
+ VALUE_SET_NAME = "DTaP Vaccine"
18
+ OID = "2.16.840.1.113883.3.464.1003.196.12.1214"
19
+ DEFINITION_VERSION = "20170504"
20
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
21
+
22
+ CVX = {
23
+ "20", # diphtheria, tetanus toxoids and acellular pertussis vaccine
24
+ "50", # DTaP-Haemophilus influenzae type b conjugate vaccine
25
+ "106", # diphtheria, tetanus toxoids and acellular pertussis vaccine, 5 pertussis antigens
26
+ "107", # diphtheria, tetanus toxoids and acellular pertussis vaccine, unspecified formulation
27
+ "110", # DTaP-hepatitis B and poliovirus vaccine
28
+ "120", # diphtheria, tetanus toxoids and acellular pertussis vaccine, Haemophilus influenzae type b conjugate, and poliovirus vaccine, inactivated (DTaP-Hib-IPV)
29
+ }
30
+
31
+
32
+ class HepatitisAVaccine(ValueSet):
33
+ """
34
+ **Clinical Focus:** The purpose of this value set is to represent concepts for immunizations with Hepatitis A vaccines.
35
+
36
+ **Data Element Scope:** This value set may use a model element related to Immunization.
37
+
38
+ **Inclusion Criteria:** Includes concepts that represent a Hepatitis A vaccine.
39
+
40
+ **Exclusion Criteria:** No exclusions.
41
+
42
+ ** Used in:** CMS117v10
43
+ """
44
+
45
+ VALUE_SET_NAME = "Hepatitis A Vaccine"
46
+ OID = "2.16.840.1.113883.3.464.1003.196.12.1215"
47
+ DEFINITION_VERSION = "20170504"
48
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
49
+
50
+ CVX = {
51
+ "31", # hepatitis A vaccine, pediatric dosage, unspecified formulation
52
+ "83", # hepatitis A vaccine, pediatric/adolescent dosage, 2 dose schedule
53
+ "85", # hepatitis A vaccine, unspecified formulation
54
+ }
55
+
56
+
57
+ class HepatitisBVaccine(ValueSet):
58
+ """
59
+ **Clinical Focus:** The purpose of this value set is to represent concepts for immunizations with Hepatitis B vaccines.
60
+
61
+ **Data Element Scope:** This value set may use a model element related to Immunization.
62
+
63
+ **Inclusion Criteria:** Includes concepts that represent a Hepatitis B vaccine.
64
+
65
+ **Exclusion Criteria:** No exclusions.
66
+
67
+ ** Used in:** CMS117v10
68
+ """
69
+
70
+ VALUE_SET_NAME = "Hepatitis B Vaccine"
71
+ OID = "2.16.840.1.113883.3.464.1003.196.12.1216"
72
+ DEFINITION_VERSION = "20170504"
73
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
74
+
75
+ CVX = {
76
+ "08", # hepatitis B vaccine, pediatric or pediatric/adolescent dosage
77
+ "44", # hepatitis B vaccine, dialysis patient dosage
78
+ "45", # hepatitis B vaccine, unspecified formulation
79
+ "51", # Haemophilus influenzae type b conjugate and Hepatitis B vaccine
80
+ "110", # DTaP-hepatitis B and poliovirus vaccine
81
+ }
82
+
83
+
84
+ class HibVaccine3DoseSchedule(ValueSet):
85
+ """
86
+ **Clinical Focus:** The purpose of this value set is to represent concepts for immunizations with 3-dose haemophilus influenzae type b (Hib) vaccines.
87
+
88
+ **Data Element Scope:** This value set may use a model element related to Immunization.
89
+
90
+ **Inclusion Criteria:** Includes concepts that represent a 3-dose haemophilus influenzae type b (Hib) vaccine.
91
+
92
+ **Exclusion Criteria:** No exclusions.
93
+
94
+ ** Used in:** CMS117v10
95
+ """
96
+
97
+ VALUE_SET_NAME = "Hib Vaccine (3 dose schedule)"
98
+ OID = "2.16.840.1.113883.3.464.1003.110.12.1083"
99
+ DEFINITION_VERSION = "20190315"
100
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
101
+
102
+ CVX = {
103
+ "49", # Haemophilus influenzae type b vaccine, PRP-OMP conjugate
104
+ }
105
+
106
+
107
+ class HibVaccine4DoseSchedule(ValueSet):
108
+ """
109
+ **Clinical Focus:** The purpose of this value set is to represent concepts for immunizations with 4-dose haemophilus influenzae type b (Hib) vaccines.
110
+
111
+ **Data Element Scope:** This value set may use a model element related to Immunization.
112
+
113
+ **Inclusion Criteria:** Includes concepts that represent a 4-dose haemophilus influenzae type b (Hib) vaccine.
114
+
115
+ **Exclusion Criteria:** No exclusions.
116
+
117
+ ** Used in:** CMS117v10
118
+ """
119
+
120
+ VALUE_SET_NAME = "Hib Vaccine (4 dose schedule)"
121
+ OID = "2.16.840.1.113883.3.464.1003.110.12.1085"
122
+ DEFINITION_VERSION = "20190315"
123
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
124
+
125
+ CVX = {
126
+ "48", # Haemophilus influenzae type b vaccine, PRP-T conjugate
127
+ "50", # DTaP-Haemophilus influenzae type b conjugate vaccine
128
+ "51", # Haemophilus influenzae type b conjugate and Hepatitis B vaccine
129
+ "120", # diphtheria, tetanus toxoids and acellular pertussis vaccine, Haemophilus influenzae type b conjugate, and poliovirus vaccine, inactivated (DTaP-Hib-IPV)
130
+ "148", # Meningococcal Groups C and Y and Haemophilus b Tetanus Toxoid Conjugate Vaccine
131
+ }
132
+
133
+
134
+ class InactivatedPolioVaccineIpv(ValueSet):
135
+ """
136
+ **Clinical Focus:** The purpose of this value set is to represent concepts for immunizations with inactivated polio vaccines (IPV).
137
+
138
+ **Data Element Scope:** This value set may use a model element related to Immunization.
139
+
140
+ **Inclusion Criteria:** Includes concepts that represent an inactivated polio vaccine (IPV).
141
+
142
+ **Exclusion Criteria:** No exclusions.
143
+
144
+ ** Used in:** CMS117v10
145
+ """
146
+
147
+ VALUE_SET_NAME = "Inactivated Polio Vaccine (IPV)"
148
+ OID = "2.16.840.1.113883.3.464.1003.196.12.1219"
149
+ DEFINITION_VERSION = "20170504"
150
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
151
+
152
+ CVX = {
153
+ "10", # poliovirus vaccine, inactivated
154
+ "89", # poliovirus vaccine, unspecified formulation
155
+ "110", # DTaP-hepatitis B and poliovirus vaccine
156
+ "120", # diphtheria, tetanus toxoids and acellular pertussis vaccine, Haemophilus influenzae type b conjugate, and poliovirus vaccine, inactivated (DTaP-Hib-IPV)
157
+ }
158
+
159
+
160
+ class InfluenzaVaccine(ValueSet):
161
+ """
162
+ **Clinical Focus:** The purpose of this value set is to represent concepts for immunizations with influenza vaccines.
163
+
164
+ **Data Element Scope:** This value set may use a model element related to Immunization.
165
+
166
+ **Inclusion Criteria:** Includes concepts that represent an influenza vaccine.
167
+
168
+ **Exclusion Criteria:** No exclusions.
169
+
170
+ ** Used in:** CMS147v11, CMS117v10
171
+ """
172
+
173
+ VALUE_SET_NAME = "Influenza Vaccine"
174
+ OID = "2.16.840.1.113883.3.526.3.1254"
175
+ DEFINITION_VERSION = "20170908"
176
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
177
+
178
+ CVX = {
179
+ "88", # influenza virus vaccine, unspecified formulation
180
+ "135", # influenza, high dose seasonal, preservative-free
181
+ "140", # Influenza, seasonal, injectable, preservative free
182
+ "141", # Influenza, seasonal, injectable
183
+ "144", # seasonal influenza, intradermal, preservative free
184
+ "149", # influenza, live, intranasal, quadrivalent
185
+ "150", # Influenza, injectable, quadrivalent, preservative free
186
+ "153", # Influenza, injectable, Madin Darby Canine Kidney, preservative free
187
+ "155", # Seasonal, trivalent, recombinant, injectable influenza vaccine, preservative free
188
+ "158", # influenza, injectable, quadrivalent, contains preservative
189
+ "161", # Influenza, injectable,quadrivalent, preservative free, pediatric
190
+ "166", # influenza, intradermal, quadrivalent, preservative free, injectable
191
+ "168", # Seasonal trivalent influenza vaccine, adjuvanted, preservative free
192
+ "171", # Influenza, injectable, Madin Darby Canine Kidney, preservative free, quadrivalent
193
+ "185", # Seasonal, quadrivalent, recombinant, injectable influenza vaccine, preservative free
194
+ "186", # Influenza, injectable, Madin Darby Canine Kidney, quadrivalent with preservative
195
+ "197", # influenza, high-dose seasonal, quadrivalent, .7mL dose, preservative free
196
+ "205", # influenza, seasonal vaccine, quadrivalent, adjuvanted, .5mL dose, preservative free
197
+ }
198
+
199
+
200
+ class InfluenzaVirusLaivImmunization(ValueSet):
201
+ """
202
+ **Clinical Focus:** The purpose of this value set is to represent live attenuated influenza vaccine.
203
+
204
+ **Data Element Scope:** This value set may use a model element related to Immunization.
205
+
206
+ **Inclusion Criteria:** Includes concepts that represent a live attenuated influenza vaccine (quadrivalent and trivalent).
207
+
208
+ **Exclusion Criteria:** Excludes concepts that represent the recombinant or inactivated influenza vaccine.
209
+
210
+ ** Used in:** CMS117v10
211
+ """
212
+
213
+ VALUE_SET_NAME = "Influenza Virus LAIV Immunization"
214
+ OID = "2.16.840.1.113883.3.464.1003.110.12.1087"
215
+ DEFINITION_VERSION = "20210224"
216
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
217
+
218
+ CVX = {
219
+ "111", # influenza virus vaccine, live, attenuated, for intranasal use
220
+ "149", # influenza, live, intranasal, quadrivalent
221
+ }
222
+
223
+
224
+ class Measles_MumpsAndRubellaMmrVaccine(ValueSet):
225
+ """
226
+ **Clinical Focus:** The purpose of this value set is to represent concepts for immunizations with measles, mumps and rubella (MMR) vaccines.
227
+
228
+ **Data Element Scope:** This value set may use a model element related to Immunization.
229
+
230
+ **Inclusion Criteria:** Includes concepts that represent a measles, mumps and rubella (MMR) vaccine.
231
+
232
+ **Exclusion Criteria:** No exclusions.
233
+
234
+ ** Used in:** CMS117v10
235
+ """
236
+
237
+ VALUE_SET_NAME = "Measles, Mumps and Rubella (MMR) Vaccine"
238
+ OID = "2.16.840.1.113883.3.464.1003.196.12.1224"
239
+ DEFINITION_VERSION = "20170504"
240
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
241
+
242
+ CVX = {
243
+ "03", # measles, mumps and rubella virus vaccine
244
+ "94", # measles, mumps, rubella, and varicella virus vaccine
245
+ }
246
+
247
+
248
+ class PneumococcalConjugateVaccine(ValueSet):
249
+ """
250
+ **Clinical Focus:** The purpose of this value set is to represent concepts for immunizations with pneumococcal conjugate vaccines.
251
+
252
+ **Data Element Scope:** This value set may use a model element related to Immunization.
253
+
254
+ **Inclusion Criteria:** Includes concepts that represent a pneumococcal conjugate vaccine.
255
+
256
+ **Exclusion Criteria:** No exclusions.
257
+
258
+ ** Used in:** CMS117v10
259
+ """
260
+
261
+ VALUE_SET_NAME = "Pneumococcal Conjugate Vaccine"
262
+ OID = "2.16.840.1.113883.3.464.1003.196.12.1221"
263
+ DEFINITION_VERSION = "20170504"
264
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
265
+
266
+ CVX = {
267
+ "133", # pneumococcal conjugate vaccine, 13 valent
268
+ "152", # Pneumococcal Conjugate, unspecified formulation
269
+ }
270
+
271
+
272
+ class RotavirusVaccine3DoseSchedule(ValueSet):
273
+ """
274
+ **Clinical Focus:** The purpose of this value set is to represent concepts for immunizations with 3-dose rotavirus vaccines.
275
+
276
+ **Data Element Scope:** This value set may use a model element related to Immunization.
277
+
278
+ **Inclusion Criteria:** Includes concepts that represent a 3-dose rotavirus vaccine.
279
+
280
+ **Exclusion Criteria:** No exclusions.
281
+
282
+ ** Used in:** CMS117v10
283
+ """
284
+
285
+ VALUE_SET_NAME = "Rotavirus Vaccine (3 dose schedule)"
286
+ OID = "2.16.840.1.113883.3.464.1003.196.12.1223"
287
+ DEFINITION_VERSION = "20170504"
288
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
289
+
290
+ CVX = {
291
+ "116", # rotavirus, live, pentavalent vaccine
292
+ "122", # rotavirus vaccine, unspecified formulation
293
+ }
294
+
295
+
296
+ class VaricellaZosterVaccineVzv(ValueSet):
297
+ """
298
+ **Clinical Focus:** The purpose of this value set is to represent concepts for immunizations with varicella zoster vaccines.
299
+
300
+ **Data Element Scope:** This value set may use a model element related to Immunization.
301
+
302
+ **Inclusion Criteria:** Includes concepts that represent a varicella zoster vaccine.
303
+
304
+ **Exclusion Criteria:** No exclusions.
305
+
306
+ ** Used in:** CMS117v10
307
+ """
308
+
309
+ VALUE_SET_NAME = "Varicella Zoster Vaccine (VZV)"
310
+ OID = "2.16.840.1.113883.3.464.1003.196.12.1170"
311
+ DEFINITION_VERSION = "20170504"
312
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
313
+
314
+ CVX = {
315
+ "21", # varicella virus vaccine
316
+ "94", # measles, mumps, rubella, and varicella virus vaccine
317
+ }
318
+
319
+
320
+ class PneumococcalPolysaccharide23Vaccine(ValueSet):
321
+ """
322
+ **Clinical Focus:** The purpose of this value set is to represent concepts for immunizations with pneumococcal polysaccharide vaccines.
323
+
324
+ **Data Element Scope:** This value set may use a model element related to Immunization.
325
+
326
+ **Inclusion Criteria:** Includes concepts that represent a pneumococcal polysaccharide 23-valent vaccine.
327
+
328
+ **Exclusion Criteria:** Excludes concepts that represent the pneumococcal conjugate 7-valent and 13-valent vaccines.
329
+
330
+ ** Used in:** CMS127v10
331
+ """
332
+
333
+ VALUE_SET_NAME = "Pneumococcal Polysaccharide 23 Vaccine"
334
+ OID = "2.16.840.1.113883.3.464.1003.110.12.1089"
335
+ DEFINITION_VERSION = "20210224"
336
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
337
+
338
+ CVX = {
339
+ "33", # pneumococcal polysaccharide vaccine, 23 valent
340
+ "109", # pneumococcal vaccine, unspecified formulation
341
+ }
@@ -0,0 +1,307 @@
1
+ from ..value_set import ValueSet
2
+
3
+
4
+ class Ethnicity(ValueSet):
5
+ """
6
+ **Clinical Focus:**
7
+
8
+ **Data Element Scope:**
9
+
10
+ **Inclusion Criteria:**
11
+
12
+ **Exclusion Criteria:**
13
+
14
+ ** Used in:** CMS135v10, CMS90v11, CMS249v4, CMS159v10, CMS349v4, CMS69v10, CMS142v10, CMS134v10, CMS177v10, CMS165v10, CMS143v10, CMS146v10, CMS157v10, CMS124v10, CMS2v11, CMS50v10, CMS22v10, CMS68v11, CMS139v10, CMS129v11, CMS154v10, CMS161v10, CMS56v10, CMS74v11, CMS645v5, CMS138v10, CMS75v10, CMS137v10, CMS136v11, CMS128v10, CMS122v10, CMS153v10, CMS144v10, CMS66v10, CMS130v10, CMS646v2, CMS155v10, CMS127v10, CMS771v3, CMS117v10, CMS131v10, CMS149v10, CMS347v5, CMS133v10, CMS156v10, CMS147v11, CMS125v10, CMS145v10
15
+ """
16
+
17
+ VALUE_SET_NAME = "Ethnicity"
18
+ OID = "2.16.840.1.114222.4.11.837"
19
+ DEFINITION_VERSION = "20121025"
20
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
21
+
22
+ CDCREC = {
23
+ "2135-2", # Hispanic or Latino
24
+ "2186-5", # Not Hispanic or Latino
25
+ }
26
+
27
+
28
+ class OncAdministrativeSex(ValueSet):
29
+ """
30
+ **Clinical Focus:** Gender identity restricted to only Male and Female used in administrative situations requiring a restriction to these two categories.
31
+
32
+ **Data Element Scope:** Gender
33
+
34
+ **Inclusion Criteria:** Male and Female only.
35
+
36
+ **Exclusion Criteria:** Any gender identity that is not male or female.
37
+
38
+ ** Used in:** CMS135v10, CMS90v11, CMS249v4, CMS159v10, CMS349v4, CMS69v10, CMS142v10, CMS134v10, CMS177v10, CMS165v10, CMS143v10, CMS146v10, CMS157v10, CMS124v10, CMS2v11, CMS50v10, CMS22v10, CMS68v11, CMS139v10, CMS129v11, CMS154v10, CMS161v10, CMS56v10, CMS74v11, CMS645v5, CMS138v10, CMS75v10, CMS137v10, CMS136v11, CMS128v10, CMS122v10, CMS153v10, CMS144v10, CMS66v10, CMS130v10, CMS646v2, CMS155v10, CMS127v10, CMS771v3, CMS117v10, CMS131v10, CMS149v10, CMS347v5, CMS133v10, CMS156v10, CMS147v11, CMS125v10, CMS145v10
39
+ """
40
+
41
+ VALUE_SET_NAME = "ONC Administrative Sex"
42
+ OID = "2.16.840.1.113762.1.4.1"
43
+ DEFINITION_VERSION = "20150331"
44
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
45
+
46
+ ADMINISTRATIVEGENDER = {
47
+ "F", # Female
48
+ "M", # Male
49
+ }
50
+
51
+
52
+ class Payer(ValueSet):
53
+ """
54
+ **Clinical Focus:** Categories of types of health care payor entities as defined by the US Public Health Data Consortium SOP code system
55
+
56
+ **Data Element Scope:** @code in CCDA r2.1 template Planned Coverage [act: identifier urn:oid:2.16.840.1.113883.10.20.22.4.129 (open)] DYNAMIC
57
+
58
+ **Inclusion Criteria:** All codes in the code system
59
+
60
+ **Exclusion Criteria:** none
61
+
62
+ ** Used in:** CMS135v10, CMS90v11, CMS249v4, CMS159v10, CMS349v4, CMS69v10, CMS142v10, CMS134v10, CMS177v10, CMS165v10, CMS143v10, CMS146v10, CMS157v10, CMS124v10, CMS2v11, CMS50v10, CMS22v10, CMS68v11, CMS139v10, CMS129v11, CMS154v10, CMS161v10, CMS56v10, CMS74v11, CMS645v5, CMS138v10, CMS75v10, CMS137v10, CMS136v11, CMS128v10, CMS122v10, CMS153v10, CMS144v10, CMS66v10, CMS130v10, CMS646v2, CMS155v10, CMS127v10, CMS771v3, CMS117v10, CMS131v10, CMS149v10, CMS347v5, CMS133v10, CMS156v10, CMS147v11, CMS125v10, CMS145v10
63
+ """
64
+
65
+ VALUE_SET_NAME = "Payer"
66
+ OID = "2.16.840.1.114222.4.11.3591"
67
+ DEFINITION_VERSION = "20180718"
68
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
69
+
70
+ SOP = {
71
+ "1", # MEDICARE
72
+ "2", # MEDICAID
73
+ "3", # OTHER GOVERNMENT (Federal/State/Local) (excluding Department of Corrections)
74
+ "4", # DEPARTMENTS OF CORRECTIONS
75
+ "5", # PRIVATE HEALTH INSURANCE
76
+ "6", # BLUE CROSS/BLUE SHIELD
77
+ "7", # MANAGED CARE, UNSPECIFIED (to be used only if one can't distinguish public from private)
78
+ "8", # NO PAYMENT from an Organization/Agency/Program/Private Payer Listed
79
+ "9", # MISCELLANEOUS/OTHER
80
+ "11", # Medicare Managed Care (Includes Medicare Advantage Plans)
81
+ "12", # Medicare (Non-managed Care)
82
+ "13", # Medicare Hospice
83
+ "14", # Dual Eligibility Medicare/Medicaid Organization
84
+ "19", # Medicare Other
85
+ "21", # Medicaid (Managed Care)
86
+ "22", # Medicaid (Non-managed Care Plan)
87
+ "23", # Medicaid/SCHIP
88
+ "25", # Medicaid - Out of State
89
+ "26", # Medicaid - Long Term Care
90
+ "29", # Medicaid Other
91
+ "31", # Department of Defense
92
+ "32", # Department of Veterans Affairs
93
+ "33", # Indian Health Service or Tribe
94
+ "34", # HRSA Program
95
+ "35", # Black Lung
96
+ "36", # State Government
97
+ "37", # Local Government
98
+ "38", # Other Government (Federal, State, Local not specified)
99
+ "39", # Other Federal
100
+ "41", # Corrections Federal
101
+ "42", # Corrections State
102
+ "43", # Corrections Local
103
+ "44", # Corrections Unknown Level
104
+ "51", # Managed Care (Private)
105
+ "52", # Private Health Insurance - Indemnity
106
+ "53", # Managed Care (private) or private health insurance (indemnity), not otherwise specified
107
+ "54", # Organized Delivery System
108
+ "55", # Small Employer Purchasing Group
109
+ "56", # Specialized Stand-Alone Plan
110
+ "59", # Other Private Insurance
111
+ "61", # BC Managed Care
112
+ "62", # BC Insurance Indemnity
113
+ "71", # HMO
114
+ "72", # PPO
115
+ "73", # POS
116
+ "79", # Other Managed Care
117
+ "81", # Self-pay (Includes applicants for insurance and Medicaid applicants)
118
+ "82", # No Charge
119
+ "83", # Refusal to Pay/Bad Debt
120
+ "84", # Hill Burton Free Care
121
+ "85", # Research/Donor
122
+ "89", # No Payment, Other
123
+ "91", # Foreign National
124
+ "92", # Other (Non-government)
125
+ "93", # Disability Insurance
126
+ "94", # Long-term Care Insurance
127
+ "95", # Worker's Compensation
128
+ "96", # Auto Insurance (includes no fault)
129
+ "97", # Legal Liability / Liability Insurance
130
+ "98", # Other specified but not otherwise classifiable (includes Hospice - Unspecified plan)
131
+ "99", # No Typology Code available for payment source
132
+ "111", # Medicare HMO
133
+ "112", # Medicare PPO
134
+ "113", # Medicare POS
135
+ "119", # Medicare Managed Care Other
136
+ "121", # Medicare FFS
137
+ "122", # Medicare Drug Benefit
138
+ "123", # Medicare Medical Savings Account (MSA)
139
+ "129", # Medicare Non-managed Care Other
140
+ "191", # Medicare Pharmacy Benefit Manager
141
+ "211", # Medicaid HMO
142
+ "212", # Medicaid PPO
143
+ "213", # Medicaid PCCM (Primary Care Case Management)
144
+ "219", # Medicaid Managed Care Other
145
+ "291", # Medicaid Pharmacy Benefit Manager
146
+ "299", # Medicaid - Dental
147
+ "311", # TRICARE (CHAMPUS)
148
+ "312", # Military Treatment Facility
149
+ "313", # Dental --Stand Alone
150
+ "321", # Veteran care-Care provided to Veterans
151
+ "322", # Non-veteran care
152
+ "331", # Indian Health Service - Regular
153
+ "332", # Indian Health Service - Contract
154
+ "333", # Indian Health Service - Managed Care
155
+ "334", # Indian Tribe - Sponsored Coverage
156
+ "341", # Title V (MCH Block Grant)
157
+ "342", # Migrant Health Program
158
+ "343", # Ryan White Act
159
+ "349", # Other
160
+ "361", # State SCHIP program (codes for individual states)
161
+ "362", # Specific state programs (list/ local code)
162
+ "369", # State, not otherwise specified (other state)
163
+ "371", # Local - Managed care
164
+ "372", # FFS/Indemnity
165
+ "379", # Local, not otherwise specified (other local, county)
166
+ "381", # Federal, State, Local not specified managed care
167
+ "382", # Federal, State, Local not specified - FFS
168
+ "389", # Federal, State, Local not specified - Other
169
+ "391", # Federal Employee Health Plan - Use when known
170
+ "511", # Commercial Managed Care - HMO
171
+ "512", # Commercial Managed Care - PPO
172
+ "513", # Commercial Managed Care - POS
173
+ "514", # Exclusive Provider Organization
174
+ "515", # Gatekeeper PPO (GPPO)
175
+ "516", # Commercial Managed Care - Pharmacy Benefit Manager
176
+ "517", # Commercial Managed Care - Dental
177
+ "519", # Managed Care, Other (non HMO)
178
+ "521", # Commercial Indemnity
179
+ "522", # Self-insured (ERISA) Administrative Services Only (ASO) plan
180
+ "523", # Medicare supplemental policy (as second payer)
181
+ "524", # Indemnity Insurance - Dental
182
+ "529", # Private health insurance--other commercial Indemnity
183
+ "561", # Dental
184
+ "562", # Vision
185
+ "611", # BC Managed Care - HMO
186
+ "612", # BC Managed Care - PPO
187
+ "613", # BC Managed Care - POS
188
+ "614", # BC Managed Care - Dental
189
+ "619", # BC Managed Care - Other
190
+ "621", # BC Indemnity
191
+ "622", # BC Self-insured (ERISA) Administrative Services Only (ASO)Plan
192
+ "623", # BC Medicare Supplemental Plan
193
+ "629", # BC Indemnity - Dental
194
+ "821", # Charity
195
+ "822", # Professional Courtesy
196
+ "823", # Research/Clinical Trial
197
+ "951", # Worker's Comp HMO
198
+ "953", # Worker's Comp Fee-for-Service
199
+ "954", # Worker's Comp Other Managed Care
200
+ "959", # Worker's Comp, Other unspecified
201
+ "3111", # TRICARE Prime--HMO
202
+ "3112", # TRICARE Extra--PPO
203
+ "3113", # TRICARE Standard - Fee For Service
204
+ "3114", # TRICARE For Life--Medicare Supplement
205
+ "3115", # TRICARE Reserve Select
206
+ "3116", # Uniformed Services Family Health Plan (USFHP) -- HMO
207
+ "3119", # Department of Defense - (other)
208
+ "3121", # Enrolled Prime--HMO
209
+ "3122", # Non-enrolled Space Available
210
+ "3123", # TRICARE For Life (TFL)
211
+ "3211", # Direct Care-Care provided in VA facilities
212
+ "3212", # Indirect Care-Care provided outside VA facilities
213
+ "3221", # Civilian Health and Medical Program for the VA (CHAMPVA)
214
+ "3222", # Spina Bifida Health Care Program (SB)
215
+ "3223", # Children of Women Vietnam Veterans (CWVV)
216
+ "3229", # Other non-veteran care
217
+ "3711", # HMO
218
+ "3712", # PPO
219
+ "3713", # POS
220
+ "3811", # Federal, State, Local not specified - HMO
221
+ "3812", # Federal, State, Local not specified - PPO
222
+ "3813", # Federal, State, Local not specified - POS
223
+ "3819", # Federal, State, Local not specified - not specified managed care
224
+ "9999", # Unavailable / No Payer Specified / Blank
225
+ "32121", # Fee Basis
226
+ "32122", # Foreign Fee/Foreign Medical Program (FMP)
227
+ "32123", # Contract Nursing Home/Community Nursing Home
228
+ "32124", # State Veterans Home
229
+ "32125", # Sharing Agreements
230
+ "32126", # Other Federal Agency
231
+ "32127", # Dental Care
232
+ "32128", # Vision Care
233
+ }
234
+
235
+
236
+ class Race(ValueSet):
237
+ """
238
+ **Clinical Focus:**
239
+
240
+ **Data Element Scope:**
241
+
242
+ **Inclusion Criteria:**
243
+
244
+ **Exclusion Criteria:**
245
+
246
+ ** Used in:** CMS135v10, CMS90v11, CMS249v4, CMS159v10, CMS349v4, CMS69v10, CMS142v10, CMS134v10, CMS177v10, CMS165v10, CMS143v10, CMS146v10, CMS157v10, CMS124v10, CMS2v11, CMS50v10, CMS22v10, CMS68v11, CMS139v10, CMS129v11, CMS154v10, CMS161v10, CMS56v10, CMS74v11, CMS645v5, CMS138v10, CMS75v10, CMS137v10, CMS136v11, CMS128v10, CMS122v10, CMS153v10, CMS144v10, CMS66v10, CMS130v10, CMS646v2, CMS155v10, CMS127v10, CMS771v3, CMS117v10, CMS131v10, CMS149v10, CMS347v5, CMS133v10, CMS156v10, CMS147v11, CMS125v10, CMS145v10
247
+ """
248
+
249
+ VALUE_SET_NAME = "Race"
250
+ OID = "2.16.840.1.114222.4.11.836"
251
+ DEFINITION_VERSION = "20121025"
252
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
253
+
254
+ CDCREC = {
255
+ "1002-5", # American Indian or Alaska Native
256
+ "2028-9", # Asian
257
+ "2054-5", # Black or African American
258
+ "2076-8", # Native Hawaiian or Other Pacific Islander
259
+ "2106-3", # White
260
+ "2131-1", # Other Race
261
+ }
262
+
263
+
264
+ class Female(ValueSet):
265
+ """
266
+ **Clinical Focus:** Concepts that represent Female when assessing quality measures
267
+
268
+ **Data Element Scope:** Gender
269
+
270
+ **Inclusion Criteria:** Appropriate female gender concepts
271
+
272
+ **Exclusion Criteria:** Concepts representing Male gender
273
+
274
+ ** Used in:** CMS124v10, CMS153v10, CMS125v10, CMS249v4
275
+ """
276
+
277
+ VALUE_SET_NAME = "Female"
278
+ OID = "2.16.840.1.113883.3.560.100.2"
279
+ DEFINITION_VERSION = "20160331"
280
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
281
+
282
+ ADMINISTRATIVEGENDER = {
283
+ "F", # Female
284
+ }
285
+
286
+
287
+ class White(ValueSet):
288
+ """
289
+ **Clinical Focus:** The purpose of this value set is to represent concepts for the patient characteristic of white race.
290
+
291
+ **Data Element Scope:** This value set may use a model element related to Race.
292
+
293
+ **Inclusion Criteria:** Includes concepts that represent a patient characteristic of white race.
294
+
295
+ **Exclusion Criteria:** Excludes concepts that represent non-white race.
296
+
297
+ ** Used in:** CMS249v4
298
+ """
299
+
300
+ VALUE_SET_NAME = "White"
301
+ OID = "2.16.840.1.113883.3.464.1003.123.12.1007"
302
+ DEFINITION_VERSION = "20180321"
303
+ EXPANSION_VERSION = "eCQM Update 2021-05-06"
304
+
305
+ CDCREC = {
306
+ "2106-3", # White
307
+ }