RC_Search Program medication (Admin CDB)

1 Purpose
2 Key points
3 Specification
4 Authorization
5 Validate legal entity
6 Search params
7 Service logic

Purpose

This WS allows to search for a medication program participant

Key points

This is a graphQl method used in Administration panel only
Only authenticated and authorized NHS employee with appropriate scope can search a Program medication.

Specification

  "Reads and enables pagination through a set of `ProgramMedication`."
  programMedications(
    "A condition to be used in determining which values should be returned by the collection."
    filter: ProgramMedicationFilter
    "The method to use when ordering collection items."
    orderBy: ProgramMedicationOrderBy
    "Read all values in the set after (below) this cursor."
    after: String
    "Read all values in the set before (above) this cursor."
    before: String
    "Only read the first _n_ values of the set."
    first: Int
    "Only read the last _n_ values of the set."
    last: Int
  ): ProgramMedicationConnection!

"""
Fields to filter reimbursement program medication in the system.
"""
input ProgramMedicationFilter {
  "Primary key identifier from the database."
  databaseId: UUID
  "Medical program filter."
  medicalProgram: MedicalProgramFilter
  "is_active status."
  isActive: Boolean
  "Medication request allowed status"
  medicationRequestAllowed: Boolean
  "Medication filter"
  medication: MedicationFilter
  "Registry number filter"
  registryNumber: String
}

"""
A connection to a list of `ProgramMedication` items.
"""
type ProgramMedicationConnection {
  "Information to aid in pagination."
  pageInfo: PageInfo!
  "A list of nodes."
  nodes: [ProgramMedication]
  "A list of edges."
  edges: [ProgramMedicationEdge]
}

Authorization

Verify the validity of access token
- in case of error - return 401 (“Invalid access token”) in case of validation fails
Verify that token is not expired
- in case of error - return 401 (“Invalid access token”)
Check user scopes in order to perform this action (scope = 'program_medication:read')
- return 403 (“Your scope does not allow to access this resource. Missing allowances: program_medication:read”) in case of invalid scope(s)

Validate legal entity

Extract client_id from token.
Check client scopes in order to perform this action (scope = 'program_medication:read')
- in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: program_medication:read”)

Search params

databaseId. UUID, Primary key identifier from the database.
medicalProgram. Medical program filter
isActive. Boolean
medicationRequestAllowed. Boolean, Medication request allowed status
medication. Medication filter
registryNumber. String, registry number filter

Service logic

Get list of all program medications filtered by search params
Render list with program medication data according to schema.