specification-refresh-nov24

data-to-insight · Nov 8, 2024 · 0855a2b · 0855a2b
1 parent 609c200
commit 0855a2b
Show file tree

Hide file tree

Showing 58 changed files with 2,629 additions and 2,278 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Change log
 SSD Data Item Changes:
-The complete change history for SSD data items in reverse chronological order, with pending|expected changes showing first.Agreed data item-level changes are assigned an identifier. A sub-set of the change details for the most recent change (if any) also appears within each objects metadata block(YAML).The current change log contains only sample data until we deploy the first pilot release.Note: Object-level change tracking is not yet available/in progress; feedback/suggestions welcomed.Last updated: 07/06/2024 12:44
+The complete change history for SSD data items in reverse chronological order, with pending|expected changes showing first.Agreed data item-level changes are assigned an identifier. A sub-set of the change details for the most recent change (if any) also appears within each objects metadata block(YAML).The current change log contains only sample data until we deploy the first pilot release.Note: Object-level change tracking is not yet available/in progress; feedback/suggestions welcomed.Last updated: 08/11/2024 15:00
 
 | item_ref   | old_item_ref   | release_datetime   | change_id   | change_object_name   | change_impact_title   | change_status   | change_type   | change_source   | change_impact_notes           |
 |:-----------|:---------------|:-------------------|:------------|:---------------------|:----------------------|:----------------|:--------------|:----------------|:------------------------------|

diff --git a/data/objects/ssd_address.yml b/data/objects/ssd_address.yml
@@ -53,8 +53,15 @@ nodes:
     cms_table:
     - liquid_logic:ssd_address
     - mosaic:ssd_address
-    guidance: 'Address (combined dictionary/json type containing: room, floor, flat,
-      building, house num, street, locality, town, county, uprn, easting, northing)'
+    guidance: 'Persons address Combined dictionary/ json type containing the following,
+      AS addr_address_json
+
+      ---------------------------------------
+
+      -- SSD standard - all keys in structure regardless of data presence
+
+      { ROOM: "", FLOOR: "", FLAT: "", BUILDING: "", HOUSE: "", STREET: "", TOWN:
+      "", UPRN: "", EASTING: "", NORTHING: "" }'
   - name: addr_person_id
     description: Person Unique ID
     item_ref: ADDR002A

diff --git a/data/objects/ssd_assessment_factors.yml b/data/objects/ssd_assessment_factors.yml
@@ -59,13 +59,18 @@ nodes:
     cms_table:
     - liquid_logic:ssd_assessment_factors
     - mosaic:ssd_assessment_factors
-    guidance: "Record of the factors as understood at the end of the Assessment.\n\
-      Code set\n1A/1B/1C - Alcohol misuse by the child/ parent(s) or carer(s)/ another\
-      \ person living in the household.\n2A/2B/2C - Drug misuse by the child/ parent(s)\
-      \ or carer(s)/ another person living in the household.\n3A/3B/3C - Concerns\
-      \ about the child/ parent(s) or carer(s)/ another person living in the household\
-      \ being the subject of domestic violence.\n4A/4B/4C - Concerns about Mental\
-      \ Health of the child/ parent(s) or carer(s)/ another person living in the household.\n\
+    guidance: "Record of the factors as understood at the end of the Assessment. Combined\
+      \ dictionary/ json type containing the following AS cinf_assessment_factors_json\n\
+      ---------------------------------------\n-- SSD standard - all keys in structure\
+      \ regardless of data presence\n-- Opt1: Current implementation as JSON ARRAY\
+      \ [ ] [\n\"1A\", \"2B\", \"3A\", ...] -- Opt2: Forward planned implementation\
+      \ as JSON {\n\"1A\": \"Yes\", \"2B\": \"No\", \"3A\": \"Yes\", ...} Code set\n\
+      1A/1B/1C - Alcohol misuse by the child/ parent(s) or carer(s)/ another person\
+      \ living in the household.\n2A/2B/2C - Drug misuse by the child/ parent(s) or\
+      \ carer(s)/ another person living in the household.\n3A/3B/3C - Concerns about\
+      \ the child/ parent(s) or carer(s)/ another person living in the household being\
+      \ the subject of domestic violence.\n4A/4B/4C - Concerns about Mental Health\
+      \ of the child/ parent(s) or carer(s)/ another person living in the household.\n\
       5A/5B/5C - Concerns about Learning Disability of the Child/ parent(s) or carer(s)/\
       \ another person living in the household.\n6A/6B/6C - Concerns about Physical\
       \ Disability/ illness of the Child/ parent(s) or carer(s)/ another person living\

diff --git a/data/objects/ssd_care_leavers.yml b/data/objects/ssd_care_leavers.yml
@@ -69,27 +69,26 @@ nodes:
     cms_table:
     - liquid_logic:ssd_care_leavers
     - mosaic:ssd_care_leavers
-    guidance: "The current Care Leaver Eligibility Status of the Child/ Young Person.\n\
-      Code set\nRelevant\nFormer Relevant\nEligible\nQualifying\nNo Current Eligibility\
-      \ A relevant child is:\n\u2022 a young person aged 16 or 17\n\u2022 is no longer\
-      \ looked-after\n\u2022 before last ceasing to be looked-after, was an \u2018\
-      eligible child\u2019 (see definition below)\nOR\n\u2022 a young person aged\
-      \ 16 or 17\n\u2022 not subject to a care order\n\u2022 detained, or in hospital\
-      \ on their 16th birthday\n\u2022 immediately before being detained or admitted\
-      \ to hospital had been looked-after for at least 13 weeks which began after\
-      \ they reached age 14.\nA former relevant child is one who is:\n\u2022 aged\
-      \ 18 or above,\nAND EITHER\n\u2022 has been a relevant child and would be one\
-      \ if he were under 18, OR\n\u2022 immediately before he ceased to be looked-after\
-      \ at age 18, was an eligible child.\nThe definition of eligible children is\
-      \ given below- relevant and former relevant children will have been an eligible\
-      \ child in the past. An eligible child is:\n\u2022 a young person aged 16 or\
-      \ 17\n\u2022 who is looked-after\n\u2022 and has been looked-after for at least\
-      \ 13 weeks which began after they reached the age of 14\nand ended after they\
-      \ reached the age of 16.\nA qualifying Care Leaver is:\n\u2022 aged between\
-      \ 16 and 25\n\u2022 who was looked after by children\u2019s services on, or\
-      \ after, their 16th birthday and no longer looked after\n\u2022 and spent less\
-      \ than 13 weeks in care since 14th birthday, i.e. do not fulfill criteria for\
-      \ eligible or relevant child"
+    guidance: "The current Care Leaver Eligibility Status of the Child/ Young Person.\
+      \ Code set Relevant Former Relevant Eligible Qualifying No Current Eligibility\
+      \ A relevant child is: \u2022 a young person aged 16 or 17 \u2022 is no longer\
+      \ looked-after \u2022 before last ceasing to be looked-after, was an \u2018\
+      eligible child\u2019 (see definition below) OR \u2022 a young person aged 16\
+      \ or 17 \u2022 not subject to a care order \u2022 detained, or in hospital on\
+      \ their 16th birthday \u2022 immediately before being detained or admitted to\
+      \ hospital had been looked-after for at least 13 weeks which began after they\
+      \ reached age 14. A former relevant child is one who is: \u2022 aged 18 or above,\
+      \ AND EITHER \u2022 has been a relevant child and would be one if he were under\
+      \ 18, OR \u2022 immediately before he ceased to be looked-after at age 18, was\
+      \ an eligible child. The definition of eligible children is given below- relevant\
+      \ and former relevant children will have been an eligible child in the past.\
+      \ An eligible child is: \u2022 a young person aged 16 or 17 \u2022 who is looked-after\
+      \ \u2022 and has been looked-after for at least 13 weeks which began after they\
+      \ reached the age of 14 and ended after they reached the age of 16. A qualifying\
+      \ Care Leaver is: \u2022 aged between 16 and 25 \u2022 who was looked after\
+      \ by children\u2019s services on, or after, their 16th birthday and no longer\
+      \ looked after \u2022 and spent less than 13 weeks in care since 14th birthday,\
+      \ i.e. do not fulfill criteria for eligible or relevant child"
   - name: clea_care_leaver_in_touch
     description: In Touch Category
     item_ref: CLEA004A
@@ -108,10 +107,10 @@ nodes:
     cms_table:
     - liquid_logic:ssd_care_leavers
     - mosaic:ssd_care_leavers
-    guidance: "Is the local authority in touch with this young person?\nCode set\n\
-      YES - Yes - in touch\nNO - No \u2013 not in touch\nDIED - Died after leaving\
-      \ care\nREFU - Young person refuses contact\nNREQ - Young person no longer requires\
-      \ children\u2019s social care services\nRHOM - Young person returned to live\
+    guidance: "Is the local authority in touch with this young person? Code set YES\
+      \ - Yes - in touch NO - No \u2013 not in touch DIED - Died after leaving care\
+      \ REFU - Young person refuses contact NREQ - Young person no longer requires\
+      \ children\u2019s social care services RHOM - Young person returned to live\
       \ with parents or someone with parental responsibility for a continuous period\
       \ of 6 months or more"
   - name: clea_care_leaver_latest_contact
@@ -156,29 +155,29 @@ nodes:
     guidance: "The type of accommodation that the young person is living in on or\
       \ around their 17th, 18th, 19th, 20th or 21st birthday, or the accommodation\
       \ the young person is living in at the time of their latest contact during the\
-      \ year if they are aged 22-to-25-years-old.\nCode set\nB - With parent(s) or\
-      \ relative(s)\nC - Community home or other form of residential care such as\
-      \ an National Health Service (NHS) establishment\nD - Semi-independent, transitional\
-      \ accommodation (like a supported hostel, trainer flats); self-contained accommodation\
-      \ with specialist personal assistance support (for example, for young people\
-      \ with disabilities, pregnant young women and single parents); and self-contained\
-      \ accommodation with floating support\nE - Supported lodgings (accommodation,\
+      \ year if they are aged 22-to-25-years-old. Code set B - With parent(s) or relative(s)\
+      \ C - Community home or other form of residential care such as an National Health\
+      \ Service (NHS) establishment D - Semi-independent, transitional accommodation\
+      \ (like a supported hostel, trainer flats); self-contained accommodation with\
+      \ specialist personal assistance support (for example, for young people with\
+      \ disabilities, pregnant young women and single parents); and self-contained\
+      \ accommodation with floating support E - Supported lodgings (accommodation,\
       \ usually in a family home, where adult(s) in the \u201Chost family\u201D provide\
-      \ formal advice and support)\nG - Gone abroad\nH - Deported\nK - Ordinary lodgings,\
-      \ without formal support\nR - Residence not known\nS - No fixed abode / homeless\n\
-      T - Foyers and similar supported accommodation which combines the accommodation\
-      \ with opportunities for education, training or employment\nU - Independent\
-      \ living, for example independent tenancy of flat, house or bedsit, including\
-      \ local authority or housing association tenancy, or accommodation provided\
-      \ by a college or university. Includes flat sharing\nV - Emergency accommodation\
-      \ (like a night shelter, direct access or emergency hostel)\nW - Bed and breakfast\n\
-      X - In custody\nY - Other accommodation\nZ - With former foster carer(s) - where\
-      \ the young person has been fostered and on turning 18 continues to remain with\
-      \ the same carer(s) who had fostered them immediately prior to their reaching\
-      \ legal adulthood, and where the plan for their care involves their remaining\
-      \ with this former foster family for the future. This code should not be used\
-      \ for 17-year-old care leavers. If the foster carer is also a relative this\
-      \ code should be used rather than \u2018B - with parents or relatives\u2019."
+      \ formal advice and support) G - Gone abroad H - Deported K - Ordinary lodgings,\
+      \ without formal support R - Residence not known S - No fixed abode / homeless\
+      \ T - Foyers and similar supported accommodation which combines the accommodation\
+      \ with opportunities for education, training or employment U - Independent living,\
+      \ for example independent tenancy of flat, house or bedsit, including local\
+      \ authority or housing association tenancy, or accommodation provided by a college\
+      \ or university. Includes flat sharing V - Emergency accommodation (like a night\
+      \ shelter, direct access or emergency hostel) W - Bed and breakfast X - In custody\
+      \ Y - Other accommodation Z - With former foster carer(s) - where the young\
+      \ person has been fostered and on turning 18 continues to remain with the same\
+      \ carer(s) who had fostered them immediately prior to their reaching legal adulthood,\
+      \ and where the plan for their care involves their remaining with this former\
+      \ foster family for the future. This code should not be used for 17-year-old\
+      \ care leavers. If the foster carer is also a relative this code should be used\
+      \ rather than \u2018B - with parents or relatives\u2019."
   - name: clea_care_leaver_accom_suitable
     description: Suitability of Accommodation
     item_ref: CLEA007A
@@ -201,7 +200,7 @@ nodes:
       \ as suitable if it provides safe, secure and affordable provision for young\
       \ people. Accommodation that clearly exposes the person to risk of harm or social\
       \ exclusion by reason of its location or other factors should be coded as \u2018\
-      unsuitable\u2019.\nCode set\n1 - Accommodation is considered suitable\n2 - Accommodation\
+      unsuitable\u2019. Code set 1 - Accommodation is considered suitable\n2 - Accommodation\
       \ is considered unsuitable"
   - name: clea_care_leaver_activity
     description: Activity Status
@@ -226,39 +225,20 @@ nodes:
       status on or around their birthday if the LA was in touch with them, or if the
       LA was not in touch with them but was certain of their activity on their birthday.
       For care leavers aged 22 to 25 years, this will be their main activity status
-      at their last contact with the LA.
-
-      Code set
-
-      F1 - Young person engaged full time in higher education (for example studies
-      beyond A level)
-
-      P1 - Young person engaged part time in higher education (for example studies
-      beyond A level)
-
-      F2 - Young person engaged full time in education other than higher education
-
-      P2 - Young person engaged part time in education other than higher education
-
-      F4 - Young person engaged full time in an apprenticeship
-
-      P4 - Young person engaged part time in an apprenticeship
-
-      F5 - Young person engaged full time in training or employment (not apprenticeship)
-
-      P5 - Young person engaged part time in training or employment (not apprenticeship)
-
-      G4 - Young person not in education, employment or training because of illness
-      or disability
-
-      G5 - Young person not in education, employment or training: other circumstances
-
-      G6 - Young person not in education, employment or training due to pregnancy
-      or parenting
-
-      F3 - (superseded by F4/F5) Young person engaged full time in training or employment
-
-      P3 - (superseded by F4/F5) Young person engaged part time in training or employment'
+      at their last contact with the LA. Code set F1 - Young person engaged full time
+      in higher education (for example studies beyond A level) P1 - Young person engaged
+      part time in higher education (for example studies beyond A level) F2 - Young
+      person engaged full time in education other than higher education P2 - Young
+      person engaged part time in education other than higher education F4 - Young
+      person engaged full time in an apprenticeship P4 - Young person engaged part
+      time in an apprenticeship F5 - Young person engaged full time in training or
+      employment (not apprenticeship) P5 - Young person engaged part time in training
+      or employment (not apprenticeship) G4 - Young person not in education, employment
+      or training because of illness or disability G5 - Young person not in education,
+      employment or training: other circumstances G6 - Young person not in education,
+      employment or training due to pregnancy or parenting F3 - (superseded by F4/F5)
+      Young person engaged full time in training or employment P3 - (superseded by
+      F4/F5) Young person engaged part time in training or employment'
   - name: clea_pathway_plan_review_date
     description: Latest Pathway Plan Review Date
     item_ref: CLEA009A

diff --git a/data/objects/ssd_cin_assessments.yml b/data/objects/ssd_cin_assessments.yml
@@ -160,35 +160,17 @@ nodes:
     - liquid_logic:ssd_cin_assessments
     - mosaic:ssd_cin_assessments
     guidance: 'Outcome of the single assessment. Combined dictionary/ json type containing
-      the following, where there is a value recorded:
+      the following AS cina_assessment_outcome_json
 
-      - NFA_FLAG
+      ---------------------------------------
 
-      - NFA_S47_END_FLAG
+      -- SSD standard - all keys in structure regardless of data presence
 
-      - STRATEGY_DISCUSSION_FLAG
-
-      - CLA_REQUEST_FLAG
-
-      - PRIVATE_FOSTERING_FLAG
-
-      - LEGAL_ACTION_FLAG
-
-      - PROV_OF_SERVICES_FLAG
-
-      - PROV_OF_SB_CARE_FLAG
-
-      - SPECIALIST_ASSESSMENT_FLAG
-
-      - REFERRAL_TO_OTHER_AGENCY_FLAG
-
-      - OTHER_ACTIONS_FLAG
-
-      - OTHER_OUTCOMES_EXIST_FLAG
-
-      - TOTAL_NO_OF_OUTCOMES
-
-      - COMMENTS'
+      { NFA_FLAG: "", NFA_S47_END_FLAG: "", STRATEGY_DISCUSSION_FLAG: "", CLA_REQUEST_FLAG:
+      "", PRIVATE_FOSTERING_FLAG: "", LEGAL_ACTION_FLAG: "", PROV_OF_SERVICES_FLAG:
+      "", PROV_OF_SB_CARE_FLAG: "", SPECIALIST_ASSESSMENT_FLAG: "", REFERRAL_TO_OTHER_AGENCY_FLAG:
+      "", OTHER_ACTIONS_FLAG: "", OTHER_OUTCOMES_EXIST_FLAG: "", TOTAL_NO_OF_OUTCOMES:
+      , COMMENTS: "" }'
   - name: cina_assessment_outcome_nfa
     description: Assessment NFA
     item_ref: CINA009A

diff --git a/data/objects/ssd_cin_episodes.yml b/data/objects/ssd_cin_episodes.yml
@@ -94,7 +94,7 @@ nodes:
     - liquid_logic:ssd_cin_episodes
     - mosaic:ssd_cin_episodes
     guidance: "CIN Primary Need Code. This code indicates the main reason why a child\
-      \ started to receive services.\nThe categories are designed only to identify\
+      \ started to receive services. The categories are designed only to identify\
       \ what kind of pressures are placed on social services. They have no diagnostic\
       \ value with regard to the children themselves and must not be used to determine\
       \ what type of service the child should receive.\nIf there is difficulty choosing\
@@ -184,34 +184,17 @@ nodes:
     - liquid_logic:ssd_cin_episodes
     - mosaic:ssd_cin_episodes
     guidance: 'Outcome of the Referral. This indicates the outcome of the initial
-      Referral, not the CIN Episode.
+      Referral, not the CIN Episode. Combined dictionary/ json type containing the
+      following AS cine_referral_outcome_json
 
-      Combined dictionary/ json type containing the following, where there is a value
-      recorded:
+      ---------------------------------------
 
-      - SINGLE_ASSESSMENT_FLAG
+      -- SSD standard - all keys in structure regardless of data presence
 
-      - NFA_FLAG
-
-      - STRATEGY_DISCUSSION_FLAG
-
-      - CLA_REQUEST_FLAG
-
-      - NON_AGENCY_ADOPTION_FLAG
-
-      - PRIVATE_FOSTERING_FLAG
-
-      - CP_TRANSFER_IN_FLAG
-
-      - CP_CONFERENCE_FLAG
-
-      - CARE_LEAVER_FLAG
-
-      - OTHER_OUTCOMES_EXIST_FLAG
-
-      - NUMBER_OF_OUTCOMES
-
-      - COMMENTS'
+      { SINGLE_ASSESSMENT_FLAG: "", NFA_FLAG: "", STRATEGY_DISCUSSION_FLAG: "", CLA_REQUEST_FLAG:
+      "", NON_AGENCY_ADOPTION_FLAG: "", PRIVATE_FOSTERING_FLAG: "", CP_TRANSFER_IN_FLAG:
+      "", CP_CONFERENCE_FLAG: "", CARE_LEAVER_FLAG: "", OTHER_OUTCOMES_EXIST_FLAG:
+      "" }'
   - name: cine_referral_nfa
     description: CIN Referral NFA Flag
     item_ref: CINE011A