Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

Required parameters are marked with "*"

...

Purpose

...

This WS allows to generate Printout form by $contract_id. Printout form is generated only for contract requests in status 'PENDING_NHS_SIGN'. Also, it is available for contract requests s in statuses 'NHS_SIGNED' and  'SIGNED'  through Get Contract request details

Specification

...

Page Properties

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-contracts/contract-request/public.-get-contract-request-printout-content

Resource

/api/contract_requests/{{contract_type}}/{{id}}/printout_content

Scope

contract_request:read

Components

Contracts

Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private/Internal

Public

Logic

...

This method is designed to get printout content by contract request id. In order to sign contract it's need to invoke Get Contract Request Details and Get Contract Request Printout Content and sign whole data.

...

Input parameter

Values

Type

Description

Example

id

String

contract request identifier

d290f1ee-6c54-4b01-90e6-d701748f0851

...

API paragraph not found

Authorize

...

Request to process the request using a token in the headers

Headers

...

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

...

Validate request

Request mapping:

...

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

    1. Return 403 in case invalid scope(s) -"Your scope does not allow to access this resource. Missing allowances: contract_requests:read"

Validate employee

extract user_id from token

...

  • Validate contract request id. Check contract_requests.id = $.id

    • in case error return 404 ("Contract request with id=$id doesn't exist")

Processing

...

Generate Printout form 

  1. Validate contract request status

    1. If contract_request in statuses 'PENDING_NHS_SIGN' - generate printout form.

      1. set nhs_signed_date=now()::date

        1. In case of error (status in 'NEW', 'IN_PROCESS', 'APPROVED', 'DECLINED', 'TERMINATED', 'NHS_SIGNED' ,'SIGNED') return 409 Error ('Incorrect status of contract_request to generate printout form')

    2. In case status was changed either to  'NHS_SIGNED' or 'SIGNED', printout form could be taken through Get Contract request details

  2. if contract_type=REIMBURSEMENT - Choose correct print out form, for different medical programs in contract request. Use config file to determine correct template form. 

medical program name

MAN template 

MAN template for contract update

"Доступні ліки"

Dostupni_liky

Dostupni_liky appendix

"Інсуліни"

Insulin

Insulin appendix

"Нецукровий діабет"

Netsukrovyy_diabet

Netsukrovyy_diabet appendix

Invoke MAN to render printout form.

Response structure

...

See on Apiary

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "printout_content": "Contract request content"
  }
}

Post-processing processes*

...

HTTP status codes

HTTP status code

Message

What caused the error

 200

 

 

...