...
This service is designed to obtain a list of capitation or reimbursement contract_requests by NHS employee (private API) or by MSP (public API).Contract_type should be declared in the URL.
Specification
Logic
API paragraph not foundContract_type should be declared in the URL.
Input parameters
Input parameter | Values | Type | Description | Example |
|---|
contract_type | CAPITATION REIMBURSEMENT | String | Required | |
...
Filter | Values | Type | Description | Example |
|---|
id | | String | id of contract request | b075f148-7f93-4fc2-b2ec-2d81b19a9b7b
|
contractor_legal_entity_id | | String | id of legal entity which created contract request | b075f148-7f93-4fc2-b2ec-2d81b19a9b7b
|
contractor_owner_id | | String | id of legal entity owner | b075f148-7f93-4fc2-b2ec-2d81b19a9b7b
|
nhs_signer_id | | String | id of nhs employee | b075f148-7f93-4fc2-b2ec-2d81b19a9b7b
|
issue_city | | String | contract request place | КИЇВ
|
edrpou | | String | legal entity edrpou | 12345678
|
status | NEW IN_PROCESS APPROVED DECLINED TERMINATED PENDING_NHS_SIGN
NHS_SIGNED SIGNED
| Enum | current status on contract request | NEW
|
contract_number | | String | human readable number of contract request | 0000-9EAX-XT7X-3115
|
medical_program_id | | String | id of a program that is a subject of contract | b075f148-7f93-4fc2-b2ec-2d81b19a9b7b
|
page | | Number | Page number | 2 |
page_size | | Number | A limit on the number of objects to be returned. Maximum: 500 | 50 |
Dictionaries
API paragraph not found
...
API paragraph not found
Authorize
...
if TOKENS_TYPES_PERSONAL
if TOKENS_TYPES_NHS
...
API paragraph not found
Response structure
See on Apiary
Example:
| Expand |
|---|
|
| Code Block |
|---|
{
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
},
"data": [
{
"id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
"contract_type": "CAPITATION",
"contractor_legal_entity_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"contractor_owner_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"contractor_base": "на підставі закону про Медичне обслуговування населення",
"status": "NEW",
"status_reason": "Не відповідає попереднім домовленостям",
"nhs_signer_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"nhs_legal_entity_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"nhs_signer_base": "на підставі наказу",
"issue_city": "Київ",
"nhs_contract_price": 50000,
"nhs_payment_method": "prepayment",
"contract_number": "0000-9EAX-XT7X-3115",
"contract_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"parent_contract_id": "22e416c4-5747-41cd-9f73-c3a85cdee885",
"start_date": "2017-04-20",
"end_date": "2017-04-20"
}
],
"paging": {
"page_number": 2,
"page_size": 50,
"total_entries": 1000,
"total_pages": 23
}
}
|
|
| Expand |
|---|
|
| Code Block |
|---|
{
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
},
"data": [
{
"id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
"contract_type": "REIMBURSEMENT",
"contractor_legal_entity_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"contractor_owner_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"contractor_base": "на підставі закону про Медичне обслуговування населення",
"status": "NEW",
"status_reason": "Не відповідає попереднім домовленостям",
"nhs_signer_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"nhs_legal_entity_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"nhs_signer_base": "на підставі наказу",
"issue_city": "Київ",
"nhs_payment_method": "prepayment",
"contract_number": "0000-9EAX-XT7X-3115",
"contract_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
"parent_contract_id": "22e416c4-5747-41cd-9f73-c3a85cdee885",
"start_date": "2017-04-20",
"end_date": "2017-04-20",
"medical_programs": [
"3914a240-63db-404e-b730-09222bfeb2d0"
]
}
],
"paging": {
"page_number": 2,
"page_size": 50,
"total_entries": 1000,
"total_pages": 23
}
}
|
|
If no contract request is found return 200 and empty array
Post-processing processes
API paragraph not found
HTTP status codes
HTTP status code | Message | What caused the error |
|---|
200 | Response | |
401 | | |
403 | | |
...