Purpose

This WS allows to get single medication program participant.

Key points

1. This is a graphQl method used in Administration panel only

2. Only authenticated and authorized NHS employee with an appropriate scope can get a Program medication.

Specification

Logic

1. Get program medication by id.

2. Render detailed program medication data according to schema.

Preconditions

API paragraph not found

Global and configurable parameters

API paragraph not found

Input parameters

API paragraph not found

Filters

API paragraph not found

Dictionaries

API paragraph not found

GraphQl Specification

"Reads a single `programMedication` using its globally unique ID."
  programMedication(id: ID!): ProgramMedication
 


"""
Program Medication linkes medication and medical program.
In order to obtain details user must have a scope **program_medication:read**
"""
type ProgramMedication implements Node {
  "The ID of an object."
  id: ID!
  "Primary key identifier from the database."
  databaseId: UUID!
  "MedicalProgram."
  medicalProgram: MedicalProgram!
  "Medication"
  medication: Medication!
  "Reimbursement information."
  reimbursement: Reimbursement!
  "Factory gate price for package of medications"
  wholesalePrice: Float
  "Consumer price for package of medications"
  consumerPrice: Float
  "Reimbuersement amount for recommended daily dosage of medication"
  reimbursementDailyDosage: Float
  "The estimatied amount which patient should pay for package of medications after reimbursement"
  estimatedPaymentAmount: Float
  "Start date of action for this entry"
  startDate: Date
  "End date for this entry"
  endDate: Date
  "General registry identifier"
  registryNumber: String
  "Whether `ProgramMedication` is active or not?"
  isActive: Boolean!
  "Whether requesting medications allowed for the `ProgramMedication` or not?"
  medicationRequestAllowed: Boolean!
  "Date and time when record was inserted"
  insertedAt: DateTime!
  "Date and time when record was updated"
  updatedAt: DateTime!
}

Authorize

• 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).

Headers

API paragraph not found

Request data validation

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”).

Validate params

1. Validate program medication id exists in DB

   1. in case of error - return 404 ('not_found').

Processing

API paragraph not found

Response structure

API paragraph not found

Post-processing processes

API paragraph not found

HTTP status codes

Backward compatibility

API paragraph not found