Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

1 Properties of a REST API method document
2 Purpose
3 Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
- 9.1 Validate user
- 9.2 Validate contract request id and status
- 9.3 Validate request
10 Processing
11 Response structure examples
12 HTTP status codes
13 Post-processing processes
- 13.1 Add status to event manager
14 Technical modules where the method is used

Properties of a REST API method document

Document type	Метод REST API
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-005-002-002-0044
Microservices (namespace)	IL
Component	Contracts
Component ID	COM-005-002
Link на API-специфікацію
Resource	{{host}}api/contract_requests/{{id}}/actions/assign
Scope	contract_request:update
Protocol type	REST
Request type	PATCH
Sync/Async	Sync
Public/Private	Private

Purpose

This WS is designed to appoints an executor (employee), who should Update Contract Request from NHS side.

Logic

This WS is designed for NHS employees. Before rewieving contract request it must be assign to NHS employee who will be responsible for this request. To assign employee contract it must be in status NEW, IN_PROCESS. After assigner was updated, contract request status will be changed to IN_PROCESS.
This query is also use to update existing assigner in Contract request.

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1	id		String	Contract request identifier. Required	d290f1ee-6c54-4b01-90e6-d701748f0851
2

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

{
	"query": "mutation AssignContractRequestMutation($input: AssignContractRequestInput!) {contractRequest: assignContractRequest(input: $input) {contractRequest {id __typename}__typename}}",
	"variables": {
		"input": {
			"employeeId": "RW1wbG95ZWU6NTE4YmEwYmEtNGYyMC00YjU0LWJhMDYtZTQzYmMxZjM3OWNl",
			"id": "Q2FwaXRhdGlvbkNvbnRyYWN0UmVxdWVzdDo4ODIxYzdhYi04ODg3LTRmYjItOGRiZC02ZThmZmQxOGJlYzU="
		}
	}
}

Headers

	Key	Value	Mandatory	Description	Example

	Key	Value	Mandatory	Description	Example
1	Content-Type	application/json	M	Тип контенту	Content-Type:application/json
2	Authorization	Bearer c2778f3064753ea70de870a53795f5c9	M	Перевірка користувача	Authorization:Bearer c2778f3064753ea70de870a53795f5c99
3

Request data validation

Validate user

extract user_id from token

extract client_id from token

Check if user is active
1. in case error return “User is not active”
check nhs_legal_entity is active
1. in case error return “Client is not active”
Check user role = "NHS ADMIN SIGNER"
1. in case error return "You don't have permission to access this resource"

Validate contract request id and status

Validate contract request ID exist
1. in case of error return “Contract Request not found”
Check contract_request.status in ('NEW', 'IN_PROCESS')
1. in case error return “Incorrect status of contract_request to modify it"

Validate request

Fetch prm.employees by $employee_id. Validate:
1. employees.legal_entity_id=$client_id
  1. in case of error return “Invalid legal entity id”
2. employees.status=APPROVED
  1. in case of error return “Invalid employee status”
3. check employee.party→ party_users→ users_roles→ roles exist role with name = 'NHS ADMIN SIGNER'
  1. in case of error return “Employee doesn't have required role”

Processing

Update contract_requests.assignee_id (IL) - set $employee_id from request
Update contract_requests.status to ‘IN_PROCESS’
Update updated_at = now()
Update updated_by = $user_id

Response structure examples

Description of the REST API response structure, example

Examples:

{
  "data": {
    "contractRequest": {
      "__typename": "AssignContractRequestPayload",
      "contractRequest": {
        "__typename": "CapitationContractRequest",
        "id": "Q2FwaXRhdGlvbkNvbnRyYWN0UmVxdWVzdDo4ODIxYzdhYi04ODg3LTRmYjItOGRiZC02ZThmZmQxOGJlYzU"
      }
    }
  },
  "extensions": {
    "requestId": "80032d98-3441-4169-b245-acbd35eb5335#13"
  }
}

{
    "data": {
        "contractRequest": null
    },
    "errors": [
        {
            "extensions": {
                "code": "FORBIDDEN"
            },
            "locations": [
                {
                    "column": 78,
                    "line": 1
                }
            ],
            "message": "Employee doesn't have required role",
            "path": [
                "contractRequest"
            ]
        }
    ],
    "extensions": {
        "requestId": "931c0790-ddfe-45e5-960a-eb6ba9f24e19#41"
    }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		200	Response
3		401	Access denied	Invalid token
4		401	Unauthorized		Помилка підтвердження
5		403	Your scope does not allow to access this resource. Missing allowances: {{scope}}	Scope is missing
6	1000	404	Composition not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок
7	Специфічні
8		422	Only for active MPI record can be created medication request!

Post-processing processes

Add status to event manager

After status was changed (status = IN_PROCESS) - add new record to event_manager

field	value

field	value
event_type	StatusChangeEvent
entity_type	ReimbursementContractRequest
entity_type	CapitationContractRequest
entity_id	$.id
properties.status.new_value	$.status
event_time	$.updated_at
changed_by	$.updated_by

Technical modules where the method is used

List of pages describing technical modules where the method is used

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

[DRAFT] Private. Assign Contract Request by NHS Employee [API-005-002-002-0044]