1 Purpose
2 Specification
3 Preconditions
4 Logic
5 Input parameters
6 Request structure
7 Authorize
8 Headers
9 Request data validation
10 Processing
11 Response structure
12 Post-processing processes
13 HTTP status codes

Purpose

This WS is designed to create program service.

Specification

Schema:

"""
Fields to filter program services in the system.
"""
input ProgramServiceFilter {
  "Primary key identifier from the database."
  databaseId: UUID
  "Medical program filter."
  medicalProgram: MedicalProgramFilter
  "Flag whether `ProgramService` is active or not?"
  isActive: Boolean
  "Service request allowed status"
  requestAllowed: Boolean
  "Service filter"
  service: ServiceFilter
  "Service Group filter"
  serviceGroup: ServiceGroupFilter
}

"""
Methods to use when ordering `ProgramService`.
"""
enum ProgramServiceOrderBy {
  "Sort by consumerPrice in ascending order"
  CONSUMER_PRICE_ASC
  "Sort by consumerPrice in descending order"
  CONSUMER_PRICE_DESC
  "Sort by inserted_at in ascending order."
  INSERTED_AT_ASC
  "Sort by inserted_at in descending order."
  INSERTED_AT_DESC
}

"""
A connection to a list of `ProgramService` items.
"""
type ProgramServiceConnection {
  "Information to aid in pagination."
  pageInfo: PageInfo!
  "A list of nodes."
  nodes: [ProgramService]
  "A list of edges."
  edges: [ProgramServiceEdge]
}

"""
An edge in a connection of `ProgramService`.
"""
type ProgramServiceEdge {
  "The item at the end of the edge."
  node: ProgramService!
  "A cursor for use in pagination."
  cursor: String!
}

"""
Input for `CreateProgramService` mutation.
User must have scope **program_service:write** to perform this action.
"""
input CreateProgramServiceInput {
  "Id of service"
  serviceId: ID
  "Id of service group"
  serviceGroupId: ID
  "Service program Identifier"
  medicalProgramId: ID!
  "Whether requesting medications allowed for the `ProgramService` or not?"
  requestAllowed: Boolean!
  "Consumer price for service or service group"
  consumerPrice: Float!
  "Description of un-automated conditions which should be checked for program member vs patient qualification"
  description: String
}

"""
Return type for `CreateProgramService` mutation.
"""
type CreateProgramServicePayload {
  "Created `ProgramService`."
  programService: ProgramService
}

"""
Input for `updateProgramService` mutation.
User must have a scope **program_service:write**
"""
input UpdateProgramServiceInput {
  "The ID of an object."
  id: ID!
  "Whether requesting medications allowed for the `ProgramService` or not?"
  requestAllowed: Boolean
  "Description of un-automated conditions which should be checked for program member vs patient qualification"
  description: String
}

"""
Return type for `updateProgramService` mutation.
"""
type UpdateProgramServicePayload {
  "Updated `ProgramService`."
  programService: ProgramService
}

"""
Input for `deactivateProgramService` mutation.
User must have a scope **program_service:write*
"""
input DeactivateProgramServiceInput {
  "The ID of an object"
  id: ID!
}

"""
Return type for `deactivateProgramService` mutation.
"""
type DeactivateProgramServicePayload {
  "Deactivated `ProgramService`."
  programService: ProgramService
}

"""
Program Service connects service, serviceGroup and medical program.
In order to obtain details user must have a scope **program_service:read**
"""
type ProgramService implements Node {
  "The ID of an object."
  id: ID!
  "Primary key identifier from the database."
  databaseId: UUID!
  "MedicalProgram."
  medicalProgram: MedicalProgram!
  "Service"
  service: Service
  "Service group"
  serviceGroup: ServiceGroup
  "Consumer price for service or service group"
  consumerPrice: Float
  "Description of un-automated conditions which should be checked for program member vs patient qualification"
  description: String
  "Whether `ProgramService` is active or not?"
  isActive: Boolean!
  "Whether requesting services allowed for the `ProgramService` or not?"
  requestAllowed: Boolean!
  "Date and time when record was inserted"
  insertedAt: DateTime!
  "Date and time when record was updated"
  updatedAt: DateTime!
}

Link	-	Посилання на Apiary або Swagger
Resource	/graphql	Посилання на ресурс, наприклад: /api/persons/create
Scope	program_service:write	Scope для доступу
Components	Program Services	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	API paragraph not found	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	GraphQL	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	POST	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	API paragraph not found	Метод є синхронним чи асинхронним?
Public/Private/Internal	Private	Потрібно зазначити тип методу за ступенем доступності

Preconditions

Before this the program and service should be created by NHS

Logic

This WS is designed for NHS employees.
The query is use to create program service.

Input parameters

Input parameter	Values	Type	Description	Example

Input parameter	Values	Type	Description	Example
medicalProgramId		String	Medical program identifier	d290f1ee-6c54-4b01-90e6-d701748f0851
serviceId		String	Service identifier	d290f1ee-6c54-4b01-90e6-d701748f0851
serviceGroupId		String	Service group identifier	d290f1ee-6c54-4b01-90e6-d701748f0851
description		String	Description of program service
requestAllowed	true/false	Boolean	Is service request allowed
consumerPrice		number	Price	10

Request structure

Example:

{
	"operationName": "CreateProgramServiceMutation",
	"variables": {
		"input": {
			"medicalProgramId": "TWVkaWNhbFByb2dyYW06NTZjNDJmY2MtM2M4ZC00ZjljLTgwNzEtNWJjYjBjYTY3NGI0",
			"consumerPrice": 10,
			"requestAllowed": false,
			"serviceId": "U2VydmljZTowNmUwYmYwMy05OWYzLTQwZWYtYjkwYi03N2Y2ZWI3MTkzN2I=",
			"description": "Тестовий аналіз крові"
		}
	},
	"query": "mutation CreateProgramServiceMutation($input: CreateProgramServiceInput!) { createProgramService(input: $input) { programService { id __typename } __typename } } "
}

Authorize

Verify the validity of access token
1. in case of error return 401 error “Access denied”
Check user scope program_service:write in order to perform this action
1. in case of error generate 403 error “Your scope does not allow to access this resource. Missing allowances: program_service:write”

Headers

Наприклад:

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

Validate Service:
1. $.service_id exists in PRM.services
  1. In case of error - return error (message: "Service is not found")
2. Check whether `Service` is_active = 'true' by $.service_id.
  1. In case of error - return error (message: "Service is not active")
3. Check whether `Service` request_allowed = 'true' by $.service_id.
  1. if invalid - return error (message: "Service is not request to allowed")
Validate Service group:
1. $.service_group_id exists in PRM.service_group
  1. In case of error - return error (message: "Service group is not found")
2. Check whether `Service group` is_active = 'true' by $.service_group_id.
  1. if invalid - return error (message: "Service group is not active")
3. Check whether `Service group` request_allowed = 'true' by $.service_group_id.
  1. if invalid - return error (message: "Service group is not request to allowed")
Validate Medical program:
1. $.medical_program_id exists in PRM.medical_programs
  1. In case of error - return error (message: "Medical program is not found")
2. Check whether `Medical_programs` is_active = 'true' by $.medical_program_id
  1. if invalid - return error (message: "Medical program is not active")
3. Check whether `Medical_programs` request_allowed = 'true' by $.medical_program_id
  1. if invalid - return error (message: "Medical program is not request to allowed")

Validate uniqueness Service/Service group within Medical Program

Service(or Service group) with field $.requestAllowed = TRUE must be unique in active program. In case of duplication the error must be shown.

Check uniqueness by $.service_id($.service_group_id, $.requestAllowed = TRUE and $.medical_program_id( where $.is_active = TRUE)
1. if invalid - return error (message: "Service(Service group) is already a participant of the program")

Validate one of two( service and service group) must be in medical program

User can add only one of service or group to the program at once.

If $.service_id and $.service_group_id are present
1. return error (message: "ProgramService cannot belong to Service and ServiceGroup simultaneously")

Validate Service Group

Check Service group don't have active subgroup:
1. if invalid - return error (message: "ServiceGroup should not have active subgroups")
If add service group to program, check that all services which include in this service group must be in medical program
1. if invalid - return error (message: "Only ServiceGroup which services are already present in medical program can take part in medical program")

Validate price

consumer_price>=0
Only Service have consumer_price
Check by $.service_id, and $.medical_program_id
1. if invalid - return error (message: "ProgramService for a Service should have a consumer price"
Check by $.service_group_id, $consumer_price and $.medical_program_id
1. if invalid - return error (message: "ProgramService for a ServiceGroup should not have a consumer price"

Processing

Response structure

Examples:

{
    "data": {
        "createProgramService": {
            "__typename": "CreateProgramServicePayload",
            "programService": {
                "__typename": "ProgramService",
                "id": "UHJvZ3JhbVNlcnZpY2U6YjVkZWEzOTktM2U2ZS00YWQzLTgyOTktOTBhZmEwNTBjZjE5"
            }
        }
    },
    "extensions": {
        "requestId": "28b9c0d7-9e94-4099-a646-46d219f1a25a#661"
    }
}

Post-processing processes

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200	Response
401	Access denied	Invalid token
403	Your scope does not allow to access this resource. Missing allowances: {{scope}}	Scope is missing

E-Health

Create Program Service