ЕСОЗ - публічна документація

Search Program medication

Owned by Dmytro Kulibaba (Unlicensed)
Last updated: Oct 02, 2024 by Oleksandr Zhuk (SoE eHealth)
3 min read

Purpose

This WS allows searching for a medication program participant.

Key points

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

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

Specification

Link

graphQl method

Resource

graphQl method

Scope

program_medication:read

Components

API paragraph not found

Microservices

API paragraph not found

Protocol type

API paragraph not found

Request type

API paragraph not found

Sync/Async

API paragraph not found

Logic

  1. Get list of all program medications filtered by search parameters.

  2. Render list with program medication data according to schema.

Filters

  • 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

  • medicationType. Medication type filter

GraphQl 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] }

 

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

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

 401

 Invalid access token

 

 403

 Your scope does not allow to access this resource. Missing allowances: program_medication:read

 

ЕСОЗ - публічна документація