Merge branch 'main' into HIA-697

Author: chiaramapellimt

openapi.yml

@@ -96,11 +96,6 @@ paths:
                 type: object
                 properties:
                   data:
-                    type: object
-                    properties:
-                      prisonerOffenderSearch:
-                        $ref: "#/components/schemas/Person"
-                      probationOffenderSearch:
                         $ref: "#/components/schemas/Person"
         "404":
           description: Failed to find a person with the provided HMPPS ID.
@@ -815,6 +810,40 @@ paths:
                 NoQueryParametersBadRequestError:
                   $ref: "#/components/examples/InternalServerError"
 
+  /v1/persons/{HmppsId}/protected-characteristics:
+    get:
+      summary: Returns protected characteristics of a person.
+      parameters:
+        - $ref: "#/components/parameters/HmppsId"
+      responses:
+        "200":
+          description: Successfully found licenses for a person with the provided HMPPS ID.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    $ref: "#/components/schemas/PersonProtectedCharacteristics"
+        "404":
+          description: Failed to find licenses for a person with the provided HMPPS ID.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+              examples:
+                PersonNotFoundError:
+                  $ref: "#/components/examples/PersonNotFoundError"
+        "500":
+          description: An upstream service was not responding, so we cannot verify the accuracy of any data we did get.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+              examples:
+                NoQueryParametersBadRequestError:
+                  $ref: "#/components/examples/InternalServerError"
+
   /{TBC}/v1/persons/{Id}/accommodations:
     get:
       summary: FUTURE ENDPOINT - Returns accommodation and referral information associated with a person.
@@ -1257,6 +1286,27 @@ components:
       properties:
         name:
           type: string
+    Disability:
+      type: object
+      properties:
+        notes:
+          type: string
+          nullable: true
+          example: Walking issue
+        startDate:
+          type: string
+          format: date-time
+          nullable: true
+          example: 2013-04-11
+        endDate:
+          type: string
+          format: date-time
+          nullable: true
+          example: 2023-04-11
+        disabilityType:
+          $ref: "#/components/schemas/KeyValue"
+        condition:
+          $ref: "#/components/schemas/KeyValue"
     Error:
       type: object
       properties:
@@ -1408,6 +1458,17 @@ components:
           nullable: true
         offenceRule:
           nullable: true
+    KeyValue:
+      type: object
+      properties:
+        code:
+          type: string
+          nullable: true
+          example: Code
+        description:
+          type: string
+          nullable: true
+          example: Description
     LatestSentenceKeyDatesAndAdjustments:
       type: object
       properties:
@@ -1468,7 +1529,6 @@ components:
           format: date
           example: 2023-03-01
           description: tariffEarlyRemovalSchemeEligibilityDate.
-
     Licence:
       type: object
       properties:
@@ -1731,6 +1791,56 @@ components:
           items:
             $ref: "#/components/schemas/Licence"
           description: list of licences
+    PersonProtectedCharacteristics:
+      type: object
+      properties:
+        age:
+          type: number
+          nullable: false
+          example: 35
+          description: Age of the person
+        gender:
+          type: string
+          nullable: true
+          example: Female
+          description: Gender of the person
+        sexualOrientation:
+          type: string
+          nullable: true
+          example: Unknown
+          description: Sexual orientation of the person
+        ethnicity:
+          type: string
+          nullable: true
+          example: "White: Eng./Welsh/Scot./N.Irish/British"
+          description: Ethnicity of the person
+        nationality:
+          type: string
+          nullable: true
+          example: "Egyptian"
+          description: Nationality of the person
+        religion:
+          type: string
+          nullable: true
+          example: "Church of England (Anglican)"
+          description: Religion of the person
+        maritalStatus:
+          type: string
+          nullable: true
+          example: "Widowed"
+          description: Marital status of the person
+        disabilities:
+          type: array
+          minItems: 0
+          items:
+            $ref: "#/components/schemas/Disability"
+        reasonableAdjustments:
+          type: array
+          minItems: 0
+          items:
+            $ref: "#/components/schemas/ReasonableAdjustment"
+
+
     Punishment:
       type: object
       properties:
@@ -1924,6 +2034,34 @@ components:
           enum: [ ARD, CRD, NPD, PRRD ]
           example: ARD
           description: Indicates which type of non-DTO release date is the effective release date. One of 'ARD', 'CRD', 'NPD' or 'PRRD'.
+    ReasonableAdjustment:
+      type: object
+      properties:
+        treatmentCode:
+          type: string
+          nullable: true
+          example: "WHEELCHR_ACC"
+          description: MTreatment Code
+        commentText:
+          type: string
+          nullable: true
+          example: "abcd"
+          description: Comment Text
+        startDate:
+          type: string
+          format: date-time
+          nullable: true
+          example: 2013-04-11
+        endDate:
+          type: string
+          format: date-time
+          nullable: true
+          example: 2023-04-11
+        treatmentDescription:
+          type: string
+          nullable: true
+          example: "Wheelchair accessibility"
+          description: Treatment Description
     ReleaseDate:
       type: object
       properties:
@@ -2112,8 +2250,6 @@ components:
           $ref: "#/components/schemas/RiskOfSeriousRecidivism"
         sexualPredictor:
           $ref: "#/components/schemas/SexualPredictor"
-
-
     GroupReconviction:
       type: object
       properties:
@@ -2214,7 +2350,6 @@ components:
           $ref: "#/components/schemas/OtherRisks"
         summary:
           $ref: "#/components/schemas/Summary"
-
     RiskToSelf:
       type: object
       properties:
@@ -2228,7 +2363,6 @@ components:
           $ref: "#/components/schemas/Risk"
         vulnerability:
           $ref: "#/components/schemas/Risk"
-
     Risk:
       type: object
       properties:
@@ -2255,7 +2389,6 @@ components:
           type: string
           example: "Risk of self harm concerns due to ..."
           description: Supporting comments for any current concerns
-
     OtherRisks:
       type: object
       properties:
@@ -2279,7 +2412,6 @@ components:
           example: "YES"
           enum: [ YES, NO, DK, NA ]
           description: Risk to other prisoners
-
     Summary:
       type: object
       properties:
@@ -2358,7 +2490,6 @@ components:
               type: string
               example: LOW
               enum: [ VERY_HIGH, HIGH, MEDIUM, LOW ]
-
     Needs:
       type: object
       properties:
@@ -2382,7 +2513,6 @@ components:
           minItems: 0
           items:
             $ref: "#/components/schemas/Need"
-
     Need:
       type: object
       properties:

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/person/ProtectedCharacteristicsController.kt

@@ -0,0 +1,34 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.controllers.v1.person
+
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PathVariable
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.exception.EntityNotFoundException
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.decodeUrlCharacters
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.PersonProtectedCharacteristics
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApiError
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetProtectedCharacteristicsService
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.internal.AuditService
+
+@RestController
+@RequestMapping("/v1/persons")
+class ProtectedCharacteristicsController(
+  @Autowired val getProtectedCharacteristicsService: GetProtectedCharacteristicsService,
+  @Autowired val auditService: AuditService,
+) {
+  @GetMapping("{encodedHmppsId}/protected-characteristics")
+  fun getPersonAddresses(
+    @PathVariable encodedHmppsId: String,
+  ): Map<String, PersonProtectedCharacteristics?> {
+    val hmppsId = encodedHmppsId.decodeUrlCharacters()
+    val response = getProtectedCharacteristicsService.execute(hmppsId)
+
+    if (response.hasError(UpstreamApiError.Type.ENTITY_NOT_FOUND)) {
+      throw EntityNotFoundException("Could not find person with id: $hmppsId")
+    }
+    auditService.createEvent("GET_PERSON_PROTECTED_CHARACTERISTICS", mapOf("hmppsId" to hmppsId))
+    return mapOf("data" to response.data)
+  }
+}

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/NomisGateway.kt

@@ -10,6 +10,7 @@ import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Address
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Alert
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.ImageMetadata
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Offence
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.ReasonableAdjustment
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.RiskCategory
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Sentence
@@ -23,6 +24,8 @@ import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisImageD
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisInmateDetail
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisOffenceHistoryDetail
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisOffenderSentence
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisReasonableAdjustments
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisReferenceCode
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisSentence
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisSentenceSummary
 
@@ -255,6 +258,53 @@ class NomisGateway(
     }
   }
 
+  fun getReasonableAdjustments(booking: String): Response<List<ReasonableAdjustment>> {
+    val treatmentCodes = getReferenceDomains("HEALTH_TREAT").data
+    val codes = treatmentCodes.map { "type=${it.code}" }.toList()
+    val params = codes.joinToString(separator = "&", prefix = "?")
+    val result =
+      webClient.request<NomisReasonableAdjustments>(
+        HttpMethod.GET,
+        "/api/bookings/$booking/reasonable-adjustments$params",
+        authenticationHeaderForCategories(),
+        UpstreamApi.NOMIS,
+      )
+
+    return when (result) {
+      is WebClientWrapperResponse.Success -> {
+        Response(data = result.data.reasonableAdjustments.map { it.toReasonableAdjustment() })
+      }
+      is WebClientWrapperResponse.Error -> {
+        Response(
+          data = emptyList(),
+          errors = result.errors,
+        )
+      }
+    }
+  }
+
+  fun getReferenceDomains(domain: String): Response<List<NomisReferenceCode>> {
+    val result =
+      webClient.requestList<NomisReferenceCode>(
+        HttpMethod.GET,
+        "/api/reference-domains/domains/$domain/codes",
+        authenticationHeaderForCategories(),
+        UpstreamApi.NOMIS,
+      )
+
+    return when (result) {
+      is WebClientWrapperResponse.Success -> {
+        Response(data = result.data)
+      }
+      is WebClientWrapperResponse.Error -> {
+        Response(
+          data = emptyList(),
+          errors = result.errors,
+        )
+      }
+    }
+  }
+
   private fun authenticationHeader(): Map<String, String> {
     val token = hmppsAuthGateway.getClientToken("NOMIS")
 

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/PrisonerOffenderSearchGateway.kt

@@ -10,6 +10,7 @@ import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Person
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.prisoneroffendersearch.POSGlobalSearch
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.prisoneroffendersearch.POSPrisoner
 
 @Component
 class PrisonerOffenderSearchGateway(
@@ -54,6 +55,29 @@ class PrisonerOffenderSearchGateway(
     }
   }
 
+  fun getPrisonOffender(nomsNumber: String): Response<POSPrisoner?> {
+    val result =
+      webClient.request<POSPrisoner>(
+        HttpMethod.GET,
+        "/prisoner/$nomsNumber",
+        authenticationHeader(),
+        UpstreamApi.PRISONER_OFFENDER_SEARCH,
+      )
+
+    return when (result) {
+      is WebClientWrapperResponse.Success -> {
+        Response(data = result.data)
+      }
+
+      is WebClientWrapperResponse.Error -> {
+        Response(
+          data = null,
+          errors = result.errors,
+        )
+      }
+    }
+  }
+
   private fun authenticationHeader(): Map<String, String> {
     val token = hmppsAuthGateway.getClientToken("Prisoner Offender Search")