1 Purpose
2 Specification
3 Logic
4 Input parameters
5 Request structure
6 Authorize
7 Headers
8 Request data validation
- 8.1 Validate transition
9 Processing
- 9.1 Update Declaration status
10 Response structure
11 Post-processing processes
12 HTTP status codes
13 Backward compatibility

Purpose

This method is used by NHS_admin to verify declarations that have been created with offline authorization. Declaration status will be changed to active

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/declarations/verify-declaration
Resource	/api/declarations/{{id}}/actions/approve
Scope	declaration:approve
Components	Declarations
Microservices	API paragraph not found
Protocol type	REST
Request type	PATCH
Sync/Async	Sync
Public/Private/Internal	Public

Logic

API paragraph not found

Input parameters

Input parameter	Values	Type	Description	Example

Input parameter	Values	Type	Description	Example
id		String	Required	d290f1ee-6c54-4b01-90e6-d701748f0851

Request structure

API paragraph not found

Authorize

Verify the validity of access token
Check user scope declaration:approve in order to perform this action
1. In case error - return 401 error.

Headers

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

Validate transition

Validate transitionю Allowed transitions:

pending_verification → active

pending_verification → closed

Check is_active = true

If not passed, Return Error 403 message "Invalid transition"

Processing

Update Declaration status

$declaration.status = active

$declaration.updated_by = user_id

$declaration.updated_at = timestamp

Response structure

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {}
}

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200	Response
401	Invalid access token Error	2. Invalid scope
403	Invalid transition

Backward compatibility

API paragraph not found

E-Health

Verify declaration

Purpose

Specification

Logic

Input parameters

Request structure

Authorize

Headers

Request data validation

Validate transition

Processing

Update Declaration status

Response structure

Post-processing processes

HTTP status codes

Backward compatibility