Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties


Specification

DONE

Apiary

DONE

JSON Schema request

ABSENT

JSON Schema response
SPECS



Purpose

This WS is designed to return Program_medications list by filters.

APIary

Get Program medications list    

Specification

Apiary                                           

Input parameters (filters)

WS Logic

Authorize

  1. Verify the validity of access token
    1. In case error - generate 401 response
  2. Check user scope (scope = 'program_medication:write') in order to perform this action
    1. In case error - generate 403 response

Parameters available to filter

  • id (optional)
  • medical_program_id (optional)
  • medical_program_name (optional, as `LIKE *`)
  • innm_id (optional)
  • innm_name (optional, as `LIKE *`)
  • medication_id (optional)
  • medication_name (optional, as `LIKE *`)

Logic WS

  • Verify the validity of access token
  • Check user scopes in order to perform this action (scope = 'program_medications:read')
  • Search Program_medications by filters and show:

    When filter by innm (name or id)  we show only medication where this innm in medication.dosage has is_active_substance=true.

    Fields to show 

    id (program_medications_id)

    medical_program_name

    medication_name
    form
    manufacturer 
    reimbursement_amount
    innm_name

    When filter by innm we show only medication where this innm in medication.dosage has is_active_substance=true.

    Prepare & return response data structure

  • Fill response WS data structure 
  • Validate response using JSON schemas (!!! TBD)Return 422 with list of validation errors in case validation fails (422 EView)