@htilabs/platform-common-models 0.15.0 → 0.18.0

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.
Files changed (76) hide show
  1. package/dist/agency-BHv54o79.d.ts +484 -0
  2. package/dist/agency-Ca4pCOOf.d.ts +342 -0
  3. package/dist/agency-DYCv839V.d.cts +342 -0
  4. package/dist/agency-Djp57S71.d.cts +484 -0
  5. package/dist/constants/index.cjs +952 -0
  6. package/dist/constants/index.cjs.map +1 -1
  7. package/dist/constants/index.d.cts +3 -1
  8. package/dist/constants/index.d.ts +3 -1
  9. package/dist/constants/index.js +920 -0
  10. package/dist/constants/index.js.map +1 -1
  11. package/dist/{cvcEntry-DaDrEuTa.d.cts → cvcEntry-0BIB9sen.d.cts} +44 -44
  12. package/dist/{cvcEntry-DaDrEuTa.d.ts → cvcEntry-0BIB9sen.d.ts} +44 -44
  13. package/dist/cvcs/index.cjs +182 -77
  14. package/dist/cvcs/index.cjs.map +1 -1
  15. package/dist/cvcs/index.d.cts +187 -78
  16. package/dist/cvcs/index.d.ts +187 -78
  17. package/dist/cvcs/index.js +182 -77
  18. package/dist/cvcs/index.js.map +1 -1
  19. package/dist/enums/index.cjs +3 -1
  20. package/dist/enums/index.cjs.map +1 -1
  21. package/dist/enums/index.d.cts +7 -5
  22. package/dist/enums/index.d.ts +7 -5
  23. package/dist/enums/index.js +3 -1
  24. package/dist/enums/index.js.map +1 -1
  25. package/dist/{index-C0J3f169.d.ts → index-CDoqrfc1.d.ts} +1 -1
  26. package/dist/{index-EPjPjR0z.d.cts → index-Zu_mOJRn.d.cts} +1 -1
  27. package/dist/index.cjs +1704 -1073
  28. package/dist/index.cjs.map +1 -1
  29. package/dist/index.d.cts +6 -4
  30. package/dist/index.d.ts +6 -4
  31. package/dist/index.js +1650 -1072
  32. package/dist/index.js.map +1 -1
  33. package/dist/models/index.d.cts +2 -2
  34. package/dist/models/index.d.ts +2 -2
  35. package/dist/org-type-BYQb9Qzq.d.ts +366 -0
  36. package/dist/org-type-D_FG4KdN.d.cts +366 -0
  37. package/dist/{platform-auth-CrF5U_JH.d.cts → platform-auth-CvAYFVhK.d.cts} +39 -0
  38. package/dist/{platform-auth-CrF5U_JH.d.ts → platform-auth-CvAYFVhK.d.ts} +39 -0
  39. package/dist/schemas/index.cjs +977 -2
  40. package/dist/schemas/index.cjs.map +1 -1
  41. package/dist/schemas/index.d.cts +38 -35
  42. package/dist/schemas/index.d.ts +38 -35
  43. package/dist/schemas/index.js +962 -1
  44. package/dist/schemas/index.js.map +1 -1
  45. package/dist/types/index.d.cts +2 -2
  46. package/dist/types/index.d.ts +2 -2
  47. package/dist/validation/index.cjs +894 -2
  48. package/dist/validation/index.cjs.map +1 -1
  49. package/dist/validation/index.d.cts +5 -1
  50. package/dist/validation/index.d.ts +5 -1
  51. package/dist/validation/index.js +884 -1
  52. package/dist/validation/index.js.map +1 -1
  53. package/package.json +26 -27
  54. package/src/__tests__/__snapshots__/cvc-sot.snap +5 -5
  55. package/src/__tests__/core-functions-canon.test.ts +53 -0
  56. package/src/__tests__/core-information-scope-invariant.test.ts +94 -4
  57. package/src/__tests__/cvc-sot-snapshot.test.ts +13 -10
  58. package/src/__tests__/cvc-status-parser.test.ts +1 -1
  59. package/src/__tests__/cvc-structural.test.ts +3 -3
  60. package/src/__tests__/org-type-contract.test.ts +1353 -0
  61. package/src/__tests__/referral-entity-category-canon.test.ts +255 -81
  62. package/src/constants/ic.ts +45 -0
  63. package/src/constants/index.ts +1 -0
  64. package/src/constants/org-type.ts +703 -0
  65. package/src/cvcs/{coreFunctions.v1.0.0.json → coreFunctions.v1.1.0.json} +11 -2
  66. package/src/cvcs/index.ts +3 -3
  67. package/src/cvcs/{referralEntityCategory.v1.1.0.json → referralEntityCategory.v1.2.0.json} +111 -59
  68. package/src/cvcs/{roiScope.v1.0.0.json → roiScope.v1.2.0.json} +51 -7
  69. package/src/generated/cvc-enums.ts +7 -5
  70. package/src/index.ts +23 -0
  71. package/src/schemas/agency.ts +481 -0
  72. package/src/schemas/index.ts +24 -0
  73. package/src/validation/agency.ts +119 -0
  74. package/src/validation/index.ts +1 -0
  75. package/dist/team-C4LJ5Tex.d.cts +0 -333
  76. package/dist/team-C4LJ5Tex.d.ts +0 -333
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "domain": "core_functions",
3
3
  "name": "Core Functions",
4
- "version": "1.0.0",
5
- "_status": "DRAFTED — NEEDS REVIEW: canonical Notion CVC-133 (core - functions), verified v1.0, ported verbatim from the Notion codebook. Canonical numbering (133), NOT provisional. Per-entry lifecycle Status (v1 / future / not-started) is carried in each definition.",
4
+ "version": "1.1.0",
5
+ "_status": "DRAFTED — NEEDS REVIEW: canonical Notion CVC-133 (core - functions), verified v1.0, ported verbatim from the Notion codebook. Canonical numbering (133), NOT provisional. Per-entry lifecycle Status (v1 / future / not-started) is carried in each definition. VERSION 1.1.0 (additive; ADR-CVC-0.8.13 Addendum 2026-10-05): APPENDS `note_open_departed_author` at 133-078 (added 2026-10-05 while building the Narrative notes Spec v2, rule 10; canon's own logic_notes mark the row as awaiting steward review (Crysta); canon `data/cvcs/core_functions.yaml` L68-93 @ prototype 9ef79748, unchanged at fed744f3, and the codebook_all.csv export). Default Off for Account Admin (MEM-ADM) only; bounds are not carried by this entry schema. Every 1.0.0 code and key is unchanged. Canon carries 112 functions; this SOT carries 78 — the other 34 canon rows are a separate absorb, not taken here.",
6
6
  "_source": "Notion CVC-133 core - functions (collection://3211ef14-abcd-8024-867d-000be4b35a79)",
7
7
  "levels": {
8
8
  "0": "Unknown or Missing",
@@ -741,6 +741,15 @@
741
741
  "parentCode": null,
742
742
  "childCodes": [],
743
743
  "definition": "Create, invite, deactivate, and manage user accounts within a member account or platform context. [Status: Defined; existing PAVE function. Platform: PLATFORM. User-relevant: no. Admin-relevant: yes. Category: Identity & access administration, Platform administration (HTI-only).]"
744
+ },
745
+ {
746
+ "code": "133-078-000-000-000-000-000",
747
+ "key": "note_open_departed_author",
748
+ "title": "Open a deactivated author's private notes",
749
+ "selectable": true,
750
+ "parentCode": null,
751
+ "childCodes": [],
752
+ "definition": "Move a deactivated author's \"Private to me\" notes to \"Our account only\", so the account can read notes whose author no longer has an account. The admin cannot read a note before opening it and cannot move it any further. [Status: Defined; new function. Platform: PAVE, THREAD. User-relevant: no. Admin-relevant: yes. Category: Account administration (member admin).]"
744
753
  }
745
754
  ]
746
755
  }
package/src/cvcs/index.ts CHANGED
@@ -66,7 +66,7 @@ import employmentStatusSot from "./employmentStatus.v1.0.0.json" with { type: "j
66
66
  // (tier · anchors · anchorDefault · shareUnit · safetyDefault) are overlaid from
67
67
  // prototype canon by scripts/gen-location-type.py; re-run, don't hand-edit them.
68
68
  import locationTypeSot from "./locationType.v1.0.0.json" with { type: "json" };
69
- import referralEntityCategorySot from "./referralEntityCategory.v1.1.0.json" with { type: "json" };
69
+ import referralEntityCategorySot from "./referralEntityCategory.v1.2.0.json" with { type: "json" };
70
70
  import incomeBenefitsSourcesSot from "./incomeBenefitsSources.v1.1.0.json" with { type: "json" };
71
71
  import enrollmentApplicationStatusSot from "./enrollmentApplicationStatus.v1.0.0.json" with { type: "json" };
72
72
  import administeringJurisdictionSot from "./administeringJurisdiction.v1.0.0.json" with { type: "json" };
@@ -162,10 +162,10 @@ import immigrationLegalStatusChangeTypeSot from "./immigrationLegalStatusChangeT
162
162
  import programEnrollmentChangeTypeSot from "./programEnrollmentChangeType.v1.0.0.json" with { type: "json" };
163
163
  import romanticRelationshipChangeTypeSot from "./romanticRelationshipChangeType.v1.0.0.json" with { type: "json" };
164
164
  import riskCategorySot from "./riskCategory.v1.0.0.json" with { type: "json" };
165
- import coreFunctionsSot from "./coreFunctions.v1.0.0.json" with { type: "json" };
165
+ import coreFunctionsSot from "./coreFunctions.v1.1.0.json" with { type: "json" };
166
166
  import needsAssessmentChangeTypeSot from "./needsAssessmentChangeType.v1.0.0.json" with { type: "json" };
167
167
  import coreInformationScopeSot from "./coreInformationScope.v1.1.0.json" with { type: "json" };
168
- import roiScopeSot from "./roiScope.v1.0.0.json" with { type: "json" };
168
+ import roiScopeSot from "./roiScope.v1.2.0.json" with { type: "json" };
169
169
  import roiStatusSot from "./roiStatus.v1.0.0.json" with { type: "json" };
170
170
  import coreReferralOutcomeSot from "./coreReferralOutcome.v1.0.0.json" with { type: "json" };
171
171
  import coreIndicatorsSot from "./coreIndicators.v1.1.0.json" with { type: "json" };
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "domain": "referral_entity_category",
3
3
  "name": "Core Referral Entity Category",
4
- "version": "1.1.0",
5
- "_status": "CANONICAL — Notion CVC-48 `core-referral_entity_category` (IC-58), status Active (full audit 2026-08-20, CVC48_IC58_REFERRAL_ENTITY_CATEGORY_AUDIT; `Date of last audit` 2026-09-01). Re-mirrored from prototype canon yaml v1.3 @ 9a10f480 and the live Notion codebook (46 rows, compared row by row 2026-10-05). SUPERSEDES referralEntityCategory v1.0.0 (platform-common <= 0.13.0), which predated the audit. ADDITIVE: no v1.0.0 key is removed and no v1.0.0 positional code changes. ADDED (3): `adult_protective_services` (02-03-06-00), `school_academic_institution` (02-05-01-00), `legal_services_provider` (02-06-04-00). SELECTABLE follows canon on two rows: `education` is now a non-selectable heading (its leaf is `school_academic_institution`, which carries the HMIS R1 School rollup — ruled 2026-08-20) and `law_enforcement` is now selectable (canon Level 2 Required; its five children are optional depth). A stored `education` is still a valid key. `title` and `definition` are canon's, verbatim (yaml `name` / `definition`; the live Notion wording where the two differ: the Adult Protective Services label, the quotation marks in the Victim service provider definition, and the wording of the residual Community-based provider definition); the Level-0 rows keep the package's house missingness titles. `justice_protective_systems` no longer carries the package-authored definition v1.0.0 gave it: canon's heading (02-03-00-00) has none. Every canon-backed row carries canon's 4-segment code as `canonicalCode`; the package's own positional codes are unchanged and are NOT canon's. NOT CARRIED, pending a decision: `02-02-01-00` Hotline — canon's Level-2 parent of National hotline / Local/other hotline; carrying it needs a decision between renumbering 048-006-001/-002 (breaks the frozen-ordinal rule) and appending it at 048-006-003 as a sibling of its own canon children. Until it is carried, `national_hotline` and `local_other_hotline` sit directly under the `hotlines` heading (as in v1.0.0) and this package has no key for a generic Hotline. Also NOT carried: canon `hmis_r1_code` / `hmis_r1_mapping`, `required`, `enum_constant`, `voca_ovc_pmt_bucket`, `pave_2025_mapping`, `logic_notes`, `mappings_notes` (v1.0.0 carried none of them). Generated by scripts/gen-referral-entity-category.py — do not hand-edit.",
6
- "_source": "htilabstech/prototype/data/cvcs/core_referral_entity_category.yaml @ 9a10f480 (Notion CVC-48, yaml v1.3; read from origin/main) + Notion codebook collection://3181ef14-abcd-8081-95b5-000bc30a73bd (wording of 3 cells, compared 2026-10-05)",
4
+ "version": "1.2.0",
5
+ "_status": "CANONICAL — Notion CVC-48 `core-referral_entity_category` (IC-58), status Active (full audit 2026-08-20, CVC48_IC58_REFERRAL_ENTITY_CATEGORY_AUDIT; `Date of last audit` 2026-09-01). Re-mirrored from prototype canon yaml v1.3 @ f1321e47 and the live Notion codebook (46 rows, compared row by row 2026-10-05). SUPERSEDES referralEntityCategory v1.0.0 (platform-common <= 0.13.0), which predated the audit. ADDITIVE: no v1.0.0 key is removed and no v1.0.0 positional code changes. ADDED (4): `adult_protective_services` (02-03-06-00), `school_academic_institution` (02-05-01-00), `legal_services_provider` (02-06-04-00), and since 0.18.0 `hotline` (02-02-01-00, canon's selectable Level-2 parent of the two hotline children) at the next free ordinal 048-006-003 with `national_hotline` / `local_other_hotline` RE-PARENTED under it — their codes are unchanged (a positional code is identity, `parentCode` is hierarchy). SELECTABLE follows canon on two rows: `education` is now a non-selectable heading (its leaf is `school_academic_institution`, which carries the HMIS R1 School rollup — ruled 2026-08-20) and `law_enforcement` is now selectable (canon Level 2 Required; its five children are optional depth). A stored `education` is still a valid key. `title` and `definition` are canon's, verbatim (yaml `name` / `definition`; the live Notion wording where the two differ: the Adult Protective Services label, the quotation marks in the Victim service provider definition, and the wording of the residual Community-based provider definition); the Level-0 rows keep the package's house missingness titles. `justice_protective_systems` no longer carries the package-authored definition v1.0.0 gave it: canon's heading (02-03-00-00) has none. Every canon-backed row carries canon's 4-segment code as `canonicalCode`; the package's own positional codes are unchanged and are NOT canon's. NOT carried: canon `hmis_r1_code` / `hmis_r1_mapping`, `required`, `voca_ovc_pmt_bucket`, `pave_2025_mapping`, `logic_notes`, `mappings_notes` (v1.0.0 carried none of them). CARRIED since 0.18.0: canon `enum_constant` as `enumConstant` on every canon-backed row (the Sean-spec constant the org registry / `agencies.typeId` spell the type with). Generated by scripts/gen-referral-entity-category.py — do not hand-edit.",
6
+ "_source": "htilabstech/prototype/data/cvcs/core_referral_entity_category.yaml @ f1321e47 (Notion CVC-48, yaml v1.3; read from origin/main) + Notion codebook collection://3181ef14-abcd-8081-95b5-000bc30a73bd (wording of 3 cells, compared 2026-10-05)",
7
7
  "_supersedes": {
8
8
  "version": "1.0.0",
9
9
  "keyMap": {
@@ -57,13 +57,7 @@
57
57
  "law_enforcement": "v1.0.0 `law_enforcement` was a non-selectable heading. Canon makes Law enforcement / Police a selectable leaf with five optional children."
58
58
  }
59
59
  },
60
- "_notCarried": [
61
- {
62
- "canonicalCode": "02-02-01-00",
63
- "name": "Hotline",
64
- "reason": "canon's Level-2 parent of National hotline / Local/other hotline; carrying it needs a decision between renumbering 048-006-001/-002 (breaks the frozen-ordinal rule) and appending it at 048-006-003 as a sibling of its own canon children"
65
- }
66
- ],
60
+ "_notCarried": [],
67
61
  "levels": {
68
62
  "0": "Unknown or Missing",
69
63
  "1": "Category",
@@ -92,7 +86,8 @@
92
86
  "parentCode": "048-000-000-000-000-000-000",
93
87
  "childCodes": [],
94
88
  "definition": "Referral entity category unknown.",
95
- "canonicalCode": "00-00-01-00"
89
+ "canonicalCode": "00-00-01-00",
90
+ "enumConstant": "EMPTY_RESPONSE_UNKNOWN"
96
91
  },
97
92
  {
98
93
  "code": "048-000-000-000-000-000-002",
@@ -102,7 +97,8 @@
102
97
  "parentCode": "048-000-000-000-000-000-000",
103
98
  "childCodes": [],
104
99
  "definition": "Referral entity category withheld or redacted.",
105
- "canonicalCode": "00-00-02-00"
100
+ "canonicalCode": "00-00-02-00",
101
+ "enumConstant": "EMPTY_RESPONSE_ANONYMOUS"
106
102
  },
107
103
  {
108
104
  "code": "048-000-000-000-000-000-003",
@@ -112,7 +108,8 @@
112
108
  "parentCode": "048-000-000-000-000-000-000",
113
109
  "childCodes": [],
114
110
  "definition": "Referral entity category not collected or no signal captured.",
115
- "canonicalCode": "00-00-03-00"
111
+ "canonicalCode": "00-00-03-00",
112
+ "enumConstant": "EMPTY_RESPONSE_NOTCOLLECTED"
116
113
  },
117
114
  {
118
115
  "code": "048-001-000-000-000-000-000",
@@ -122,7 +119,8 @@
122
119
  "parentCode": null,
123
120
  "childCodes": [],
124
121
  "definition": "Client initiated contact or presented for services without a third-party referrer.",
125
- "canonicalCode": "01-00-01-00"
122
+ "canonicalCode": "01-00-01-00",
123
+ "enumConstant": "INDIVIDUAL_PERSON_SELFREFERRED"
126
124
  },
127
125
  {
128
126
  "code": "048-002-000-000-000-000-000",
@@ -132,7 +130,8 @@
132
130
  "parentCode": null,
133
131
  "childCodes": [],
134
132
  "definition": "A caregiver, family member, or close personal support person initiated the referral.",
135
- "canonicalCode": "01-00-02-00"
133
+ "canonicalCode": "01-00-02-00",
134
+ "enumConstant": "INDIVIDUAL_PERSON_FAMILYGUARDIANFRIEND"
136
135
  },
137
136
  {
138
137
  "code": "048-003-000-000-000-000-000",
@@ -142,7 +141,8 @@
142
141
  "parentCode": null,
143
142
  "childCodes": [],
144
143
  "definition": "Another current or former client initiated or encouraged the referral.",
145
- "canonicalCode": "01-00-03-00"
144
+ "canonicalCode": "01-00-03-00",
145
+ "enumConstant": "INDIVIDUAL_PERSON_PEER"
146
146
  },
147
147
  {
148
148
  "code": "048-004-000-000-000-000-000",
@@ -152,7 +152,8 @@
152
152
  "parentCode": null,
153
153
  "childCodes": [],
154
154
  "definition": "A non-family individual initiated the referral (e.g., neighbor, community member, clergy).",
155
- "canonicalCode": "01-00-04-00"
155
+ "canonicalCode": "01-00-04-00",
156
+ "enumConstant": "INDIVIDUAL_PERSON_OTHER"
156
157
  },
157
158
  {
158
159
  "code": "048-005-000-000-000-000-000",
@@ -166,7 +167,8 @@
166
167
  "048-005-003-000-000-000-000"
167
168
  ],
168
169
  "definition": "Primary function is outreach engagement, emergency shelter, or residential shelter/housing programs.",
169
- "canonicalCode": "02-01-00-00"
170
+ "canonicalCode": "02-01-00-00",
171
+ "enumConstant": "ORGANIZATION_HOUSING"
170
172
  },
171
173
  {
172
174
  "code": "048-005-001-000-000-000-000",
@@ -176,7 +178,8 @@
176
178
  "parentCode": "048-005-000-000-000-000-000",
177
179
  "childCodes": [],
178
180
  "definition": "Street/community outreach program that engaged the client prior to enrollment.",
179
- "canonicalCode": "02-01-01-00"
181
+ "canonicalCode": "02-01-01-00",
182
+ "enumConstant": "ORGANIZATION_HOUSING_OUTREACHPROJECT"
180
183
  },
181
184
  {
182
185
  "code": "048-005-002-000-000-000-000",
@@ -186,7 +189,8 @@
186
189
  "parentCode": "048-005-000-000-000-000-000",
187
190
  "childCodes": [],
188
191
  "definition": "Emergency/crisis shelter or short-term temporary housing program.",
189
- "canonicalCode": "02-01-02-00"
192
+ "canonicalCode": "02-01-02-00",
193
+ "enumConstant": "ORGANIZATION_HOUSING_TEMPORARYSHELTER"
190
194
  },
191
195
  {
192
196
  "code": "048-005-003-000-000-000-000",
@@ -196,7 +200,8 @@
196
200
  "parentCode": "048-005-000-000-000-000-000",
197
201
  "childCodes": [],
198
202
  "definition": "Longer-term residential or transitional living program.",
199
- "canonicalCode": "02-01-03-00"
203
+ "canonicalCode": "02-01-03-00",
204
+ "enumConstant": "ORGANIZATION_HOUSING_RESIDENTIALPROJECT"
200
205
  },
201
206
  {
202
207
  "code": "048-006-000-000-000-000-000",
@@ -205,31 +210,47 @@
205
210
  "selectable": false,
206
211
  "parentCode": null,
207
212
  "childCodes": [
208
- "048-006-001-000-000-000-000",
209
- "048-006-002-000-000-000-000"
213
+ "048-006-003-000-000-000-000"
210
214
  ],
211
215
  "definition": "Crisis lines or call centers that connect a person to services.",
212
- "canonicalCode": "02-02-00-00"
216
+ "canonicalCode": "02-02-00-00",
217
+ "enumConstant": "ORGANIZATION_CALLCENTERS"
213
218
  },
214
219
  {
215
220
  "code": "048-006-001-000-000-000-000",
216
221
  "key": "national_hotline",
217
222
  "title": "National hotline",
218
223
  "selectable": true,
219
- "parentCode": "048-006-000-000-000-000-000",
224
+ "parentCode": "048-006-003-000-000-000-000",
220
225
  "childCodes": [],
221
226
  "definition": "National-level hotline network.",
222
- "canonicalCode": "02-02-01-01"
227
+ "canonicalCode": "02-02-01-01",
228
+ "enumConstant": "ORGANIZATION_CALLCENTERS_HOTLINE_NATIONAL"
223
229
  },
224
230
  {
225
231
  "code": "048-006-002-000-000-000-000",
226
232
  "key": "local_other_hotline",
227
233
  "title": "Local/other hotline",
228
234
  "selectable": true,
229
- "parentCode": "048-006-000-000-000-000-000",
235
+ "parentCode": "048-006-003-000-000-000-000",
230
236
  "childCodes": [],
231
237
  "definition": "Local/regional hotline or non-national hotline.",
232
- "canonicalCode": "02-02-01-02"
238
+ "canonicalCode": "02-02-01-02",
239
+ "enumConstant": "ORGANIZATION_CALLCENTERS_HOTLINE_LOCAL"
240
+ },
241
+ {
242
+ "code": "048-006-003-000-000-000-000",
243
+ "key": "hotline",
244
+ "title": "Hotline",
245
+ "selectable": true,
246
+ "parentCode": "048-006-000-000-000-000-000",
247
+ "childCodes": [
248
+ "048-006-001-000-000-000-000",
249
+ "048-006-002-000-000-000-000"
250
+ ],
251
+ "definition": "Crisis hotline or call center that connected the client to services.",
252
+ "canonicalCode": "02-02-01-00",
253
+ "enumConstant": "ORGANIZATION_CALLCENTERS_HOTLINE"
233
254
  },
234
255
  {
235
256
  "code": "048-007-000-000-000-000-000",
@@ -246,7 +267,8 @@
246
267
  "048-007-006-000-000-000-000"
247
268
  ],
248
269
  "definition": null,
249
- "canonicalCode": "02-03-00-00"
270
+ "canonicalCode": "02-03-00-00",
271
+ "enumConstant": "ORGANIZATION_JUSTICE"
250
272
  },
251
273
  {
252
274
  "code": "048-007-001-000-000-000-000",
@@ -256,7 +278,8 @@
256
278
  "parentCode": "048-007-000-000-000-000-000",
257
279
  "childCodes": [],
258
280
  "definition": "Government child protection agency responsible for investigating child abuse/neglect and ensuring child safety.",
259
- "canonicalCode": "02-03-01-00"
281
+ "canonicalCode": "02-03-01-00",
282
+ "enumConstant": "ORGANIZATION_JUSTICE_CHILDWELFARE"
260
283
  },
261
284
  {
262
285
  "code": "048-007-002-000-000-000-000",
@@ -266,7 +289,8 @@
266
289
  "parentCode": "048-007-000-000-000-000-000",
267
290
  "childCodes": [],
268
291
  "definition": "Juvenile probation/detention/court-related juvenile justice system initiated the referral.",
269
- "canonicalCode": "02-03-02-00"
292
+ "canonicalCode": "02-03-02-00",
293
+ "enumConstant": "ORGANIZATION_JUSTICE_JUVENILE"
270
294
  },
271
295
  {
272
296
  "code": "048-007-003-000-000-000-000",
@@ -282,7 +306,8 @@
282
306
  "048-007-003-005-000-000-000"
283
307
  ],
284
308
  "definition": "Law enforcement agency initiated the referral (local/state/federal).",
285
- "canonicalCode": "02-03-03-00"
309
+ "canonicalCode": "02-03-03-00",
310
+ "enumConstant": "ORGANIZATION_JUSTICE_LAWENFORCEMENT"
286
311
  },
287
312
  {
288
313
  "code": "048-007-003-001-000-000-000",
@@ -292,7 +317,8 @@
292
317
  "parentCode": "048-007-003-000-000-000-000",
293
318
  "childCodes": [],
294
319
  "definition": "City/county police or sheriff.",
295
- "canonicalCode": "02-03-03-01"
320
+ "canonicalCode": "02-03-03-01",
321
+ "enumConstant": "ORGANIZATION_JUSTICE_LAWENFORCEMENT_LOCAL"
296
322
  },
297
323
  {
298
324
  "code": "048-007-003-002-000-000-000",
@@ -302,7 +328,8 @@
302
328
  "parentCode": "048-007-003-000-000-000-000",
303
329
  "childCodes": [],
304
330
  "definition": "State-level law enforcement agency (e.g., state police/highway patrol/state bureau of investigation) acting in an official capacity.",
305
- "canonicalCode": "02-03-03-02"
331
+ "canonicalCode": "02-03-03-02",
332
+ "enumConstant": "ORGANIZATION_JUSTICE_LAWENFORCEMENT_STATE"
306
333
  },
307
334
  {
308
335
  "code": "048-007-003-003-000-000-000",
@@ -312,7 +339,8 @@
312
339
  "parentCode": "048-007-003-000-000-000-000",
313
340
  "childCodes": [],
314
341
  "definition": "Federal law enforcement agency (e.g., FBI, DHS/ICE).",
315
- "canonicalCode": "02-03-03-03"
342
+ "canonicalCode": "02-03-03-03",
343
+ "enumConstant": "ORGANIZATION_JUSTICE_LAWENFORCEMENT_FEDERAL"
316
344
  },
317
345
  {
318
346
  "code": "048-007-003-004-000-000-000",
@@ -322,7 +350,8 @@
322
350
  "parentCode": "048-007-003-000-000-000-000",
323
351
  "childCodes": [],
324
352
  "definition": "Tribal police.",
325
- "canonicalCode": "02-03-03-04"
353
+ "canonicalCode": "02-03-03-04",
354
+ "enumConstant": "ORGANIZATION_JUSTICE_LAWENFORCEMENT_TRIBAL"
326
355
  },
327
356
  {
328
357
  "code": "048-007-003-005-000-000-000",
@@ -332,7 +361,8 @@
332
361
  "parentCode": "048-007-003-000-000-000-000",
333
362
  "childCodes": [],
334
363
  "definition": "Other law enforcement entity, or law enforcement type is unknown.",
335
- "canonicalCode": "02-03-03-05"
364
+ "canonicalCode": "02-03-03-05",
365
+ "enumConstant": "ORGANIZATION_JUSTICE_LAWENFORCEMENT_OTHER"
336
366
  },
337
367
  {
338
368
  "code": "048-007-004-000-000-000-000",
@@ -342,7 +372,8 @@
342
372
  "parentCode": "048-007-000-000-000-000-000",
343
373
  "childCodes": [],
344
374
  "definition": "Court or prosecution entity (not law enforcement).",
345
- "canonicalCode": "02-03-04-00"
375
+ "canonicalCode": "02-03-04-00",
376
+ "enumConstant": "ORGANIZATION_JUSTICE_COURTS"
346
377
  },
347
378
  {
348
379
  "code": "048-007-005-000-000-000-000",
@@ -352,7 +383,8 @@
352
383
  "parentCode": "048-007-000-000-000-000-000",
353
384
  "childCodes": [],
354
385
  "definition": "Corrections, probation, parole, or community supervision entity (not law enforcement).",
355
- "canonicalCode": "02-03-05-00"
386
+ "canonicalCode": "02-03-05-00",
387
+ "enumConstant": "ORGANIZATION_JUSTICE_CORRECTIONS"
356
388
  },
357
389
  {
358
390
  "code": "048-007-006-000-000-000-000",
@@ -362,7 +394,8 @@
362
394
  "parentCode": "048-007-000-000-000-000-000",
363
395
  "childCodes": [],
364
396
  "definition": "Government adult protection agency responsible for investigating abuse, neglect, self-neglect, or exploitation of vulnerable or older adults and ensuring their safety. Adult analog of Child Welfare / CPS.",
365
- "canonicalCode": "02-03-06-00"
397
+ "canonicalCode": "02-03-06-00",
398
+ "enumConstant": "ORGANIZATION_JUSTICE_ADULTPROTECTIVE"
366
399
  },
367
400
  {
368
401
  "code": "048-008-000-000-000-000-000",
@@ -375,7 +408,8 @@
375
408
  "048-008-002-000-000-000-000"
376
409
  ],
377
410
  "definition": "Hospitals and healthcare providers (including mental health inpatient facilities).",
378
- "canonicalCode": "02-04-00-00"
411
+ "canonicalCode": "02-04-00-00",
412
+ "enumConstant": "ORGANIZATION_HEALTH"
379
413
  },
380
414
  {
381
415
  "code": "048-008-001-000-000-000-000",
@@ -385,7 +419,8 @@
385
419
  "parentCode": "048-008-000-000-000-000-000",
386
420
  "childCodes": [],
387
421
  "definition": "Inpatient psychiatric hospital or psychiatric facility.",
388
- "canonicalCode": "02-04-01-00"
422
+ "canonicalCode": "02-04-01-00",
423
+ "enumConstant": "ORGANIZATION_HEALTH_PSYCHIATRIC"
389
424
  },
390
425
  {
391
426
  "code": "048-008-002-000-000-000-000",
@@ -395,7 +430,8 @@
395
430
  "parentCode": "048-008-000-000-000-000-000",
396
431
  "childCodes": [],
397
432
  "definition": "Any non-inpatient healthcare provider (clinic, hospital, outpatient provider, behavioral health clinic, SANE program, substance abuse clinic, etc.).",
398
- "canonicalCode": "02-04-02-00"
433
+ "canonicalCode": "02-04-02-00",
434
+ "enumConstant": "ORGANIZATION_HEALTH_HEALTHCARE"
399
435
  },
400
436
  {
401
437
  "code": "048-009-000-000-000-000-000",
@@ -407,7 +443,8 @@
407
443
  "048-009-001-000-000-000-000"
408
444
  ],
409
445
  "definition": "Parent category for education-related institutions.",
410
- "canonicalCode": "02-05-00-00"
446
+ "canonicalCode": "02-05-00-00",
447
+ "enumConstant": "ORGANIZATION_EDUCATION"
411
448
  },
412
449
  {
413
450
  "code": "048-009-001-000-000-000-000",
@@ -417,7 +454,8 @@
417
454
  "parentCode": "048-009-000-000-000-000-000",
418
455
  "childCodes": [],
419
456
  "definition": "School system or educational institution.",
420
- "canonicalCode": "02-05-01-00"
457
+ "canonicalCode": "02-05-01-00",
458
+ "enumConstant": "ORGANIZATION_EDUCATION_SCHOOL"
421
459
  },
422
460
  {
423
461
  "code": "048-010-000-000-000-000-000",
@@ -432,7 +470,8 @@
432
470
  "048-010-004-000-000-000-000"
433
471
  ],
434
472
  "definition": "Parent category for victim service providers and community-based service providers.",
435
- "canonicalCode": "02-06-00-00"
473
+ "canonicalCode": "02-06-00-00",
474
+ "enumConstant": "ORGANIZATION_COMMUNITY"
436
475
  },
437
476
  {
438
477
  "code": "048-010-001-000-000-000-000",
@@ -442,7 +481,8 @@
442
481
  "parentCode": "048-010-000-000-000-000-000",
443
482
  "childCodes": [],
444
483
  "definition": "A child-centered multidisciplinary center coordinating investigation and services (forensic interview, coordination, referrals, sometimes medical or therapy) for child victims.",
445
- "canonicalCode": "02-06-01-00"
484
+ "canonicalCode": "02-06-01-00",
485
+ "enumConstant": "ORGANIZATION_COMMUNITY_CHILDADVOCACYCENTER"
446
486
  },
447
487
  {
448
488
  "code": "048-010-002-000-000-000-000",
@@ -452,7 +492,8 @@
452
492
  "parentCode": "048-010-000-000-000-000-000",
453
493
  "childCodes": [],
454
494
  "definition": "Organization whose primary mission is to provide services to victims/survivors of crime (VOCA-aligned breadth: rape crisis centers, DV/dating-violence/stalking programs, anti-trafficking programs, child victim centers, homicide-survivor organizations, and similar). Whether the organization is specifically a DV/SA victim service provider — the fact HMIS 2.01 needs (Comparable Database) — is a separate per-organization attribute, self-attested by the organization at onboarding (Platform survey / Agency Hub “My agency info”), not part of this category.",
455
- "canonicalCode": "02-06-02-00"
495
+ "canonicalCode": "02-06-02-00",
496
+ "enumConstant": "ORGANIZATION_COMMUNITY_VICTIMSERVICEPROVIDER"
456
497
  },
457
498
  {
458
499
  "code": "048-010-003-000-000-000-000",
@@ -462,7 +503,8 @@
462
503
  "parentCode": "048-010-000-000-000-000-000",
463
504
  "childCodes": [],
464
505
  "definition": "The residual community-based provider (“other community-based service provider”): a non-VSP offering practical support services, navigation, or stabilization resources that is not primarily a VSP, a legal services provider, a housing/shelter project, a government justice agency, a healthcare provider, a school, a hotline, or a public benefits office. (Ex: youth drop-in center; food pantry; reentry program.)",
465
- "canonicalCode": "02-06-03-00"
506
+ "canonicalCode": "02-06-03-00",
507
+ "enumConstant": "ORGANIZATION_COMMUNITY_COMMUNITYSERVICEPROVIDER"
466
508
  },
467
509
  {
468
510
  "code": "048-010-004-000-000-000-000",
@@ -472,7 +514,8 @@
472
514
  "parentCode": "048-010-000-000-000-000-000",
473
515
  "childCodes": [],
474
516
  "definition": "Civil legal aid organization, immigration attorneys, victim-rights law clinic, or similar provider of legal help to the client. Distinct from Courts or prosecution (the justice-system entity itself): this is getting a lawyer's help, not being referred into proceedings.",
475
- "canonicalCode": "02-06-04-00"
517
+ "canonicalCode": "02-06-04-00",
518
+ "enumConstant": "ORGANIZATION_COMMUNITY_LEGALSERVICES"
476
519
  },
477
520
  {
478
521
  "code": "048-011-000-000-000-000-000",
@@ -485,7 +528,8 @@
485
528
  "048-011-002-000-000-000-000"
486
529
  ],
487
530
  "definition": "Parent category for coordination and governance bodies (e.g., MDTs, coalitions).",
488
- "canonicalCode": "02-07-00-00"
531
+ "canonicalCode": "02-07-00-00",
532
+ "enumConstant": "ORGANIZATION_GOVERNANCE"
489
533
  },
490
534
  {
491
535
  "code": "048-011-001-000-000-000-000",
@@ -495,7 +539,8 @@
495
539
  "parentCode": "048-011-000-000-000-000-000",
496
540
  "childCodes": [],
497
541
  "definition": "A case-level team: professionals from multiple agencies (law enforcement, child welfare, medical, advocacy) who review and coordinate individual cases together; referrals arise out of case review. (E.g., a county trafficking MDT or a CAC-based team.)",
498
- "canonicalCode": "02-07-01-00"
542
+ "canonicalCode": "02-07-01-00",
543
+ "enumConstant": "ORGANIZATION_GOVERNANCE_MDT"
499
544
  },
500
545
  {
501
546
  "code": "048-011-002-000-000-000-000",
@@ -505,7 +550,8 @@
505
550
  "parentCode": "048-011-000-000-000-000-000",
506
551
  "childCodes": [],
507
552
  "definition": "A state or regional membership body of organizations coordinating at the system level — training, standards, policy, funding — not individual cases; referrals from a coalition are typically warm handoffs to a member organization.",
508
- "canonicalCode": "02-07-02-00"
553
+ "canonicalCode": "02-07-02-00",
554
+ "enumConstant": "ORGANIZATION_GOVERNANCE_COALITION"
509
555
  },
510
556
  {
511
557
  "code": "048-012-000-000-000-000-000",
@@ -517,7 +563,8 @@
517
563
  "048-012-001-000-000-000-000"
518
564
  ],
519
565
  "definition": "Parent category for internal referrals within the same umbrella agency.",
520
- "canonicalCode": "02-08-00-00"
566
+ "canonicalCode": "02-08-00-00",
567
+ "enumConstant": "ORGANIZATION_INTERNAL"
521
568
  },
522
569
  {
523
570
  "code": "048-012-001-000-000-000-000",
@@ -527,7 +574,8 @@
527
574
  "parentCode": "048-012-000-000-000-000-000",
528
575
  "childCodes": [],
529
576
  "definition": "Client was referred from another program or unit within the same umbrella agency.",
530
- "canonicalCode": "02-08-01-00"
577
+ "canonicalCode": "02-08-01-00",
578
+ "enumConstant": "ORGANIZATION_INTERNAL_OWNAGENCY"
531
579
  },
532
580
  {
533
581
  "code": "048-013-000-000-000-000-000",
@@ -541,7 +589,8 @@
541
589
  "048-013-003-000-000-000-000"
542
590
  ],
543
591
  "definition": "Parent category for other organizations not captured by the primary sectors.",
544
- "canonicalCode": "02-09-00-00"
592
+ "canonicalCode": "02-09-00-00",
593
+ "enumConstant": "ORGANIZATION_OTHER"
545
594
  },
546
595
  {
547
596
  "code": "048-013-001-000-000-000-000",
@@ -551,7 +600,8 @@
551
600
  "parentCode": "048-013-000-000-000-000-000",
552
601
  "childCodes": [],
553
602
  "definition": "Employer, HR, or employee assistance program initiated the referral.",
554
- "canonicalCode": "02-09-01-00"
603
+ "canonicalCode": "02-09-01-00",
604
+ "enumConstant": "ORGANIZATION_OTHER_EMPLOYER"
555
605
  },
556
606
  {
557
607
  "code": "048-013-002-000-000-000-000",
@@ -561,7 +611,8 @@
561
611
  "parentCode": "048-013-000-000-000-000-000",
562
612
  "childCodes": [],
563
613
  "definition": "Government office administering public benefits or eligibility and enrollment (e.g., SNAP, TANF, Medicaid, SSA).",
564
- "canonicalCode": "02-09-02-00"
614
+ "canonicalCode": "02-09-02-00",
615
+ "enumConstant": "ORGANIZATION_OTHER_PUBLICASSISTANCE"
565
616
  },
566
617
  {
567
618
  "code": "048-013-003-000-000-000-000",
@@ -571,7 +622,8 @@
571
622
  "parentCode": "048-013-000-000-000-000-000",
572
623
  "childCodes": [],
573
624
  "definition": "Other organization not otherwise captured by the listed categories.",
574
- "canonicalCode": "02-09-03-00"
625
+ "canonicalCode": "02-09-03-00",
626
+ "enumConstant": "ORGANIZATION_OTHER_UNSPECIFIED"
575
627
  }
576
628
  ]
577
629
  }
@@ -1,9 +1,51 @@
1
1
  {
2
2
  "domain": "roi_scope",
3
3
  "name": "ROI Scope",
4
- "version": "1.1.0",
5
- "_status": "DRAFT — TEMPORARY: net-new value-CVC not yet in Notion; provisional 900+ numbering. 0.8.13: COMPLETED against the canonical 27-item source. 0.8.12 shipped 15 of the canonical 27; the missing 12 are added here. Nothing PAVE shipped was invented — this was purely a gap. Canonical source: `HTI_SHARE_SCOPE_GROUPS` in HTI-LEADS-PAVE-Thread-prototype.html @ HEAD a596eb9 (7 groups x items = 27): identifying (5) + risk (4) + contact (3) + notes (3) + health_accommodation (6) + immigration_legal_status (5) + system (1). The GROUP axis (identifying / risk / contact / notes / health_accommodation / immigration_legal_status / system) is a separate presentation concern and is deliberately NOT modelled as hierarchy rows here — this CVC is the flat item vocabulary that an ROI authorizes. PENDING canonical Notion authoring + steward ratification.",
6
- "_source": "htilabstech/prototype@a596eb9 HTI-LEADS-PAVE-Thread-prototype.html HTI_SHARE_SCOPE_GROUPS",
4
+ "version": "1.2.0",
5
+ "_status": "DRAFT — TEMPORARY: net-new value-CVC not yet in Notion; provisional 900+ numbering. 0.8.13: COMPLETED against the canonical 27-item source. 0.8.12 shipped 15 of the canonical 27; the missing 12 are added here. Nothing PAVE shipped was invented — this was purely a gap. Canonical source: `HTI_SHARE_SCOPE_GROUPS` in HTI-LEADS-PAVE-Thread-prototype.html @ HEAD a596eb9 (7 groups x items = 27): identifying (5) + risk (4) + contact (3) + notes (3) + health_accommodation (6) + immigration_legal_status (5) + system (1). The GROUP axis (identifying / risk / contact / notes / health_accommodation / immigration_legal_status / system) is a separate presentation concern and is deliberately NOT modelled as hierarchy rows here — this CVC is the flat item vocabulary that an ROI authorizes. PENDING canonical Notion authoring + steward ratification. VERSION 1.2.0 supersedes 1.1.0 (co-bwc): `screen_notes` (983-012) and `background` (983-014) are RETIRED TOMBSTONES, matching CVC-236 `core_information_scope` v1.1.0 (retired 2026-10-05, Narrative notes, signed Spec v2 rule 5). Each keeps its published code (never reused), is `selectable: false` + `retired: true`, and includes nothing: a stored ROI that names one resolves to \"retired\", not \"unknown\". Not additive, hence the version (ADR-CVC-0.8.13 Addendum 2026-10-05; see `_supersedes`). This flat vocabulary is LEGACY: new units (e.g. `session_summary`, 236-005-004) are minted in CVC-236 only and are not mirrored here.",
6
+ "_source": "htilabstech/prototype@a596eb9 HTI-LEADS-PAVE-Thread-prototype.html HTI_SHARE_SCOPE_GROUPS; v1.2.0 retirements: htilabstech/prototype/data/cvcs/core_information_scope.yaml @ 9ef79748 retired_units (L467)",
7
+ "_supersedes": {
8
+ "version": "1.1.0",
9
+ "keyMap": {
10
+ "missingness_root": "missingness_root",
11
+ "unknown": "unknown",
12
+ "anonymous": "anonymous",
13
+ "data_not_collected": "data_not_collected",
14
+ "names": "names",
15
+ "dob": "dob",
16
+ "addresses": "addresses",
17
+ "additional_ids": "additional_ids",
18
+ "demographics": "demographics",
19
+ "screen_indicators": "screen_indicators",
20
+ "victimization": "victimization",
21
+ "ida_full": "ida_full",
22
+ "ida_consid": "ida_consid",
23
+ "contact_info": "contact_info",
24
+ "service_history": "service_history",
25
+ "screen_notes": "screen_notes",
26
+ "case_notes": "case_notes",
27
+ "background": "background",
28
+ "system_info": "system_info",
29
+ "contact_history": "contact_history",
30
+ "accommodation_needs": "accommodation_needs",
31
+ "disability_subtypes": "disability_subtypes",
32
+ "mental_health_status": "mental_health_status",
33
+ "substance_use_status": "substance_use_status",
34
+ "chronic_health_status": "chronic_health_status",
35
+ "hiv_status": "hiv_status",
36
+ "immigration_status": "immigration_status",
37
+ "uscis_alien_number": "uscis_alien_number",
38
+ "federal_protection_applications": "federal_protection_applications",
39
+ "tvap_enrollment": "tvap_enrollment",
40
+ "le_report_status": "le_report_status"
41
+ },
42
+ "retiredCodes": [],
43
+ "notes": {
44
+ "summary": "Every v1.1.0 key is still an entry in v1.2.0, at its v1.1.0 code, so `keyMap` is the identity and `retiredCodes` is empty: no code was withdrawn. Non-additive because 2 published items are now RETIRED tombstones (notes below), matching CVC-236 `core_information_scope` v1.1.0, which retired the same two keys; nothing was added. Before this version the package gave two answers to \"is screen_notes offerable\" (co-bwc). The file was named `roiScope.v1.0.0.json` while declaring version 1.1.0 (the 0.8.13 completion); the published version superseded here is the declared 1.1.0.",
45
+ "screen_notes": "v1.1.0 `screen_notes` was a selectable item. Retired 2026-10-05 (Narrative notes, signed Spec v2 rule 5): The Initial Screen's notes box is an instrument note and belongs to the Initial Screen. It stays at 983-012 as a tombstone (`selectable: false`, `retired: true`) with NO successor key, and includes nothing — a stored ROI that names it narrows, never widens. CVC-236 v1.1.0 retired the same key (canon `data/cvcs/core_information_scope.yaml` `retired_units` L467 @ prototype 9ef79748); canon records that only demo data named it (Crysta 2026-10-04).",
46
+ "background": "v1.1.0 `background` was a selectable item. Retired 2026-10-05 (Narrative notes, signed Spec v2 rule 5): Nothing ever captured it. It stays at 983-014 as a tombstone (`selectable: false`, `retired: true`) with NO successor key, and includes nothing — a stored ROI that names it narrows, never widens. CVC-236 v1.1.0 retired the same key (canon `data/cvcs/core_information_scope.yaml` `retired_units` L467 @ prototype 9ef79748); canon records that only demo data named it (Crysta 2026-10-04)."
47
+ }
48
+ },
7
49
  "levels": {
8
50
  "0": "Unknown or Missing",
9
51
  "1": "ROI scope item"
@@ -152,10 +194,11 @@
152
194
  "code": "983-012-000-000-000-000-000",
153
195
  "key": "screen_notes",
154
196
  "title": "Screen notes",
155
- "selectable": true,
197
+ "selectable": false,
156
198
  "parentCode": null,
157
199
  "childCodes": [],
158
- "definition": "Narrative notes captured during screening. Narrative-notes scope group."
200
+ "definition": "RETIRED 2026-10-05 (Narrative notes, signed Spec v2 rule 5), matching its CVC-236 `core_information_scope` v1.1.0 twin. The Initial Screen's notes box is an instrument note and belongs to the Initial Screen. No longer offered in an ROI; a stored code resolves here so a reader can tell retired from unknown, and includes nothing.",
201
+ "retired": true
159
202
  },
160
203
  {
161
204
  "code": "983-013-000-000-000-000-000",
@@ -170,10 +213,11 @@
170
213
  "code": "983-014-000-000-000-000-000",
171
214
  "key": "background",
172
215
  "title": "Background information",
173
- "selectable": true,
216
+ "selectable": false,
174
217
  "parentCode": null,
175
218
  "childCodes": [],
176
- "definition": "Background/narrative context about the subject. Narrative-notes scope group."
219
+ "definition": "RETIRED 2026-10-05 (Narrative notes, signed Spec v2 rule 5), matching its CVC-236 `core_information_scope` v1.1.0 twin. Nothing ever captured it. No longer offered in an ROI; a stored code resolves here so a reader can tell retired from unknown, and includes nothing.",
220
+ "retired": true
177
221
  },
178
222
  {
179
223
  "code": "983-015-000-000-000-000-000",