Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 5
Next »
Purpose
This WS allows searching for a medication program participant.
Key points
This is a graphQl method used in the Administration panel only.
Only authenticated and authorized NHS employee with an appropriate scope can search a Program medication.
Specification
Logic
Get list of all program medications filtered by search parameters.
Render list with program medication data according to schema.
Preconditions
API paragraph not found
Global and configurable parameters
API paragraph not found
API paragraph not found
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
Dictionaries
API paragraph not found
GraphQl Specification
programMedications
"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]
}
"""
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
Verify that token is not expired
Check user scopes in order to perform this action (scope = 'program_medication:read')
API paragraph not found
Request data validation
Validate legal entity
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