generated from ministryofjustice/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PI-1612: Add probation concepts documentation and classify services
- Loading branch information
Showing
6 changed files
with
150 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| title: Probation System Concepts | ||
| source_url: 'https://github.com/ministryofjustice/hmpps-probation-integration-services/blob/main/doc/tech-docs/source/concepts.html.md.erb' | ||
| weight: 40 | ||
| --- | ||
|
|
||
| # System Concepts | ||
|
|
||
| Probation integration services support interactions between new HMPPS digital services and older probation systems involved in managing a probation case, namely Delius and OASys. To access case information managed in one of the older systems we provide read-only APIs over the Delius and OASys data. APIs are intended for use by one client, are tailored to the needs of that client and built in collaboration with the client team. Where possible the API is shaped and data named in terms of the client needs, which helps build a shared understanding of the data provided and indicates the limits of how it should be used. The data models and concepts of the Delius and OASys services do, however, have a significant influence on what can be provided and how it is presented. | ||
|
|
||
| ## Common Concepts | ||
|
|
||
| ### Person | ||
|
|
||
| A person who is engaged with the probation service due to being accused or convicted of a crime. | ||
|
|
||
| ## Delius Concepts | ||
|
|
||
| Probation concepts modelled in the Delius application | ||
|
|
||
| ### Event | ||
|
|
||
| The representation of the specific engagement between the probation service and a person. The Delius event associates a person with specific offences and any court appearances, disposals, requirements, licence conditions, NSIs and contacts associated with that offence. The event is also used to link other information such as risk assessments to the case. | ||
|
|
||
| ### Disposal | ||
|
|
||
| The outcome of a court case which includes and any community orders and custodial sentences. The disposal is linked to any licence conditions, requirements and unpaid work supervised by the probation service. | ||
|
|
||
| ### Contact | ||
|
|
||
| A structure capturing an important action or activity related to the supervision. Contacts are used to log many different things and grouped together they provide a full history of a persons engagement with the probation service. Contacts are of a specific type, which indicates the activity being logged, and can have associated outcome and notes to help probation practitioners understand the context. | ||
|
|
||
| Contacts can be marked with an alert flag, which indicates that the responsible probation practitioner should be informed immediately that the contact has been created. | ||
|
|
||
| The Delius 'Contact List' gives a consolidated view of all contacts. Examples of activities logged as contacts are probation processes, transfers of responsibility, risk assessments, details of interventions, appointments, custody information and case administration. Contacts cover many other areas in addition to these and are a primary method of recording information in Delius. | ||
|
|
||
| ### Documents | ||
|
|
||
| Documents related to the probation case, such as court reports and case management documents. | ||
|
|
||
| ### Addresses | ||
|
|
||
| Important addresses related to a person, such as where they are currently living. | ||
|
|
||
| ### Non-Statutory Intervention (NSI) | ||
|
|
||
| A Delius-specific concept that allows the system to model a component of the probation supervision. An NSI may have a status, time span, outcome and can be linked to contacts which enables grouping of related information in Delius. NSIs are used extensively in the Delius application to model probation processes. | ||
|
|
||
| ### Community Offender Manager (COM) | ||
|
|
||
| The practitioner currently responsible for managing a particular case when the person is in the community. | ||
|
|
||
| ### Prison Offender Manager (POM) | ||
|
|
||
| The practitioner currently responsible for managing a particular case whilst the person is in custody. | ||
|
|
||
| ### Responsible Officer | ||
|
|
||
| The practitioner, one of either the Prison Offender Manager or Community Offender Manager, who is currently responsible for managing the case. | ||
|
|
||
| ### Key Dates | ||
|
|
||
| Important dates related to a person, such as date of release from prison and the end of supervision. | ||
|
|
||
| ## OASys Concepts | ||
|
|
||
| Probation concepts as modelled in the OASys application | ||
|
|
||
| ### Assessment | ||
|
|
||
| An assessment of a person's risk to themselves and others. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| --- | ||
| title: Integration Services | ||
| source_url: 'https://github.com/ministryofjustice/hmpps-probation-integration-services/blob/main/doc/tech-docs/source/services.html.md.erb' | ||
| weight: 20 | ||
| --- | ||
|
|
||
| # Integration Services | ||
|
|
||
| ## Accommodation Services | ||
|
|
||
| * [Approved Premises And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/approved-premises-and-delius) | ||
| * [Approved Premises And OASys](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/approved-premises-and-oasys) | ||
| * [CAS3 And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/cas3-and-delius) | ||
|
|
||
| ## Probation in Court | ||
| * [Court Case And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/court-case-and-delius) | ||
| * [Effective Proposal Framework And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/effective-proposal-framework-and-delius) | ||
| * [Pre-Sentence Reports To Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/pre-sentence-reports-to-delius) | ||
|
|
||
| ## Leaving Prison / Entering Probation | ||
| * [Create And Vary A Licence And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/create-and-vary-a-licence-and-delius) | ||
| * [Manage POM Cases And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/manage-pom-cases-and-delius) | ||
| * [Resettlement Passport And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/resettlement-passport-and-delius) | ||
| * [Prison Education And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/prison-education-and-delius) | ||
| * [HDC Licences And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/hdc-licences-and-delius) | ||
|
|
||
| ## Custody Information | ||
| * [Custody Key Dates And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/custody-key-dates-and-delius) | ||
| * [Prison Case Notes To Probation](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/prison-case-notes-to-probation) | ||
| * [Prison Custody Status To Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/prison-custody-status-to-delius) | ||
| * [DPS And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/dps-and-delius) | ||
|
|
||
|
|
||
| ## Public Protection | ||
| * [Make Recall Decisions And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/make-recall-decisions-and-delius) | ||
|
|
||
| ## Crime Prevention | ||
| * [Pathfinder And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/pathfinder-and-delius) | ||
| * [SOC And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/soc-and-delius) | ||
|
|
||
| ## Interventions | ||
| * [Refer And Monitor And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/refer-and-monitor-and-delius) | ||
|
|
||
| ## Risk Assessments | ||
| * [Risk Assessment Scores To Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/risk-assessment-scores-to-delius) | ||
| * [OPD And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/opd-and-delius) | ||
| * [ARNS And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/arns-and-delius) | ||
|
|
||
| ## Sentence Planning | ||
| * [Sentence Plan And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/sentence-plan-and-delius) | ||
| * [Sentence Plan And Oasys](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/sentence-plan-and-oasys) | ||
|
|
||
| ## Workforce Management | ||
| * [Tier To Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/tier-to-delius) | ||
| * [Unpaid Work And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/unpaid-work-and-delius) | ||
| * [Workforce Allocations To Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/workforce-allocations-to-delius) | ||
|
|
||
| ## Reference Data Management | ||
| * [Manage Offences And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/manage-offences-and-delius) | ||
|
|
||
| ## HMPPS Technical Environment | ||
| * [Person Search Index From Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/person-search-index-from-delius) | ||
| * [Domain Events And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/domain-events-and-delius) | ||
| * [Offender Events And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/offender-events-and-delius) | ||
| * [HMPPS Auth And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/hmpps-auth-and-delius) | ||
|
|
||
| ## External Integration | ||
| * [External API And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/external-api-and-delius) | ||
|
|
||
|
|
||
| ## New/Unclassified Services | ||
|
|
||
| <li style="display: none">^ add new projects here</li> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters