Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

...

Purpose*

API paragraph not found

...

Purpose

This method is used to return the data of patient diagnostic reports to employees who have a signed declaration with this patient or work in the LE where this diagnostic report was created.

Specification

Page Properties

Link	https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/diagnostic-report/get-diagnostic-report-by-search-params
Resource	/api/patients/{{patient_id}}/diagnostic_reports
Scope	diagnostic_report:read
Components	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionDiagnostic Report Data Package
Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Async

Logic*

...

Public/Private/Internal

Public

Filters

Filter	Type	Description	Example
page	Number	Page number	`2`
page_size	Number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	`50`
code	String		`12345`
encounter_id	String		`09dc3ed7-2169-45d8-8fa3-d918c6839bf9`
context_episode_id	String		`09dc3ed7-2169-45d8-8fa3-d918c6839bf9`
origin_episode_id	String		`09dc3ed7-2169-45d8-8fa3-d918c6839bf9`
issued_from	String		`1990-01-01`
issued_to	String		`2000-01-01`
based_on	String		`09dc3ed7-2169-45d8-8fa3-d918c6839bf9`
managing_organization_id	String		`09dc3ed7-2169-45d8-8fa3-d918c6839bf9`

Request structure

...

See on Apiary

Authorize

...

Request to process the request using a token in the headers
Verify the validity of access token
Return 401 in case validation fails
Verify token
...

Headers*

...

is not expired
- in case error return 401
Check user scopes in order to perform this action (scope = 'diagnostic_report:read')
1. Return 403 in case invalid scope(s)

Headers

Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM{{access_token}}
API-key:{{secret}}

Request data validation

...

API paragraph not found

...

Access to the resource is also managed by ABAC module.

Processing

API paragraph not found

Response structure

...

See on Apiary

Example:

Expand

title	Response example

Code Block

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
      "based_on (Reference_response, optional)": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "service_request"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "paper_referral": {
        "requisition": "1111-2222-3333-4444",
        "requester_legal_entity_name": "Some clinic",
        "requester_legal_entity_edrpou": "12345678",
        "requester_employee_name": "John",
        "service_request_date": "2018-10-08",
        "note": "Some notes"
      },
      "status": "final",
      "code": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "service"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "category": [
        {
          "coding": [
            {
              "system": "eHealth/diagnostic_report_categories",
              "code": "diagnostic_procedure"
            }
          ]
        }
      ],
      "effective_period": {
        "start": "2018-08-02T10:45:16.000Z",
        "end": "2018-08-02T11:00:00.000Z"
      },
      "issued": "2018-10-08T09:46:37.694Z",
      "conclusion": "At risk of osteoporotic fracture",
      "conclusion_code": {
        "coding": [
          {
            "system": "eHealth/ICD10_AM/condition_codes",
            "code": "H04.2"
          }
        ]
      },
      "recorded_by (Reference_response, required)": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "Опанасенко Олексій Володимирович"
      },
      "inserted_at": "2018-08-02T10:55:00.000Z",
      "updated_at": "2018-08-02T10:55:00.000Z",
      "encounter": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "origin_episode (Reference_response, optional)": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "division": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "division"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "Перше відділення обласної лікарня №1"
      },
      "managing_organization (Reference_response, optional)": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "patient"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "Київська обласна лікарня №1"
      },
      "results_interpreter": {
        "reference": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "employee"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          },
          "display_value": "Опанасенко Олексій Володимирович"
        }
      },
      "primary_source": true,
      "explanatory_letter": "Звіт був відмінений у зв'язку з помилкою при виборі пацієнта",
      "cancellation_reason": {
        "coding": [
          {
            "system": "eHealth/cancellation_reasons",
            "code": "misspelling"
          }
        ],
        "text": ""
      }
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

Post-processing processes

...

API paragraph not found

HTTP status codes

...

Page Properties
HTTP status code
Message
What caused the error
200

401
Unauthorized

403
Invalid scopes

Versions Compared

Old Version 7

New Version Current

Key

Required parameters are marked with "*"

Purpose*

Purpose

Specification

Logic*

Filters

Request structure

See on Apiary

Authorize

Request to process the request using a token in the headers
Verify the validity of access token
Return 401 in case validation fails
Verify token
...

Headers*

Headers

Request data validation

Access to the resource is also managed by ABAC module.

Processing

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

Page Properties
HTTP status code
Message
What caused the error
200

401
Unauthorized

403
Invalid scopes

Page Comparison

Versions Compared

Old Version 7

New Version Current

Key

Required parameters are marked with "*"

Purpose*

Purpose

Specification

Logic*

Filters

Request structure

See on Apiary

Authorize

Request to process the request using a token in the headersVerify the validity of access tokenReturn 401 in case validation failsVerify token ...

Headers*

Headers

Request data validation

Access to the resource is also managed by ABAC module.

Processing

Response structure

Post-processing processes

API paragraph not found

HTTP status codes

Page PropertiesHTTP status codeMessageWhat caused the error 200 401 Unauthorized 403Invalid scopes

Request to process the request using a token in the headers
Verify the validity of access token
Return 401 in case validation fails
Verify token
...

Page Properties
HTTP status code
Message
What caused the error
200

401
Unauthorized

403
Invalid scopes