Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Specification


Apiary

get-program-medications-list

JSON Schema response

SPECS

Purpose

This WS is designed to return Program_medications list by 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_dosage_id (optional)

  • innm_dosage_name (optional, as `LIKE *`)

  • medication_id (optional)

  • medication_name (optional, as `LIKE *`)

  • is_active

When filter by innm_dosage (name or id)  we show only medication brands where this innm_dosage in medication{type=brand}.dosage has is_primary=true.

Fields to show 

id (program_medication_id)

medical_program_name

medication_name

form

manufacturer 

reimbursement_amount

innm_dosage_name

is_active