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

(GraphQL) Get pending declarations list

Owned by Serhii Boldin (SoE eHealth)
Last updated: Feb 13, 2023
4 min read

Purpose

This WS allows to get list of pending declarations by search parameters in Admin panel.

 

Key points

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

  2. Only authenticated and authorized NHS employee with appropriate scope can get get list of pending declarations.

  3. Only pending declarations (in status ‘pending_verification’) are returned as a result.

 

Specification

Link

API paragraph not found

Посилання на Apiary або Swagger

Resource

API paragraph not found

Посилання на ресурс, наприклад: /api/persons/create

Scope

declaration:read

Scope для доступу

Components

 

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

 

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

 

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

 

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

 

Метод є синхронним чи асинхронним?

Public/Private/Internal

Internal

Потрібно зазначити тип методу за ступенем доступності

 

"Reads and enables pagination through a set of `Declaration`." pendingDeclarations( "A condition to be used in determining which values should be returned by the collection." filter: PendingDeclarationFilter "The method to use when ordering collection items." orderBy: DeclarationOrderBy "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 ): DeclarationConnection!
"" Fields to filter Pending Declarations. """ input PendingDeclarationFilter { "Values to show whether person rejected to have taxId" reason: PendingDeclarationReason } """ List of values to filter reason in Pending Declarations`. """ enum PendingDeclarationReason { "Sort declaration by no tax id in ascending order." NO_TAX_ID } """ List of fields to filter both ask and desc side `Declaration`. """ enum DeclarationOrderBy { "Sort declaration by inserted_at in ascending order." INSERTED_AT_ASC "Sort declaration by inserted_at in descending order." INSERTED_AT_DESC "Sort declaration by reason in ascending order." REASON_ASC "Sort declaration by reason in ascending order." REASON_DESC "Sort declaration by start date in ascending order." START_DATE_ASC "Sort declaration by start date in descending order." START_DATE_DESC "Sort declaration by status in ascending order." STATUS_ASC "Sort declaration by status in descending order." STATUS_DESC } """ A connection to a list of `Declaration` values. """ type DeclarationConnection { "Information to aid in pagination." pageInfo: PageInfo! "A list of nodes." nodes: [Declaration] "A list of edges." edges: [DeclarationEdge] } """ Reads and enables pagination through a set of `Declaration`. """ type DeclarationEdge { "The item at the end of the edge." node: Declaration! "A cursor for use in pagination." cursor: String! } """ Declaration combines data about Patient, Employee, LegalEntity and Division. In order to obtain details user must have a scope `declaration:read`. """ type Declaration implements Node { "The ID of an object" id: ID! "Primary key identifier from the database" databaseId: UUID! "unique human redable number of declaration" declarationNumber: String! "The date when declaration takes effect" startDate: Date! "The date wher declaration ends." endDate: Date! "The date when declaration is signed by doctor." signedAt: DateTime! "Status ah yhe declaration, is set automatically." status: DeclarationStatus! "type of declaration, as for now it's only one type =`family_doctor`" scope: String "The reason of declining the declaration, is set automatically on declining declaration." reason: String "Free text for declining declaration, is filled by the person who declined declaration." reasonDescription: String "Legal entity information, where declaration was signed." legalEntity: LegalEntity! "Patient information." person: Person! "Division in legal entity where medical services are provided." division: Division! "Doctor information, who signed declaration." employee: Employee! "Documents which were attahced to declarations." declarationAttachedDocuments: [DeclarationAttachedDocument] } """ List of declaration statuses. """ enum DeclarationStatus { "Status `Active` for declaration." ACTIVE "Status `CLOSED` for declaration." CLOSED "Status `PENDING_VERIFICATION` for declaration." PENDING_VERIFICATION "Status `REJECTED` for declaration." REJECTED "Status `TERMINATED` for declaration." TERMINATED } """ Structure of documents attached to the declaration. """ type DeclarationAttachedDocument { "The type of document." type: String! "Link for uploading scan copies of the documnet, is generated by e-Health." url: String! }

 

Logic

  1. Get data from ops DB:

    1. declarations with status = ‘pending_verification’

      1. with reason search param

  2. Render a response according to specification.

 

Authorization

  • 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 = 'declaration:read')

    • return 403 (“Your scope does not allow to access this resource. Missing allowances: declaration:read”) in case of invalid scope(s)

 

Request data validation

Validate legal entity

  • Extract client_id from token.

  • Check client scopes in order to perform this action (scope = 'declaration:read')

    • in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: declaration:read”)

  • Check client type (type = NHS)

    • In case of error - return 403 ('You don't have permission to access this resource')

Search params

  • reason

 

Processing

API paraagraph not found

 

Response structure

API paraagraph not found

 

Post-processing processes

API paraagraph not found

 

HTTP status codes

API paraagraph not found

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