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

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] Get Care Plans by search params [API-007-001-001-0220]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-007-001-001-0220

Microservices (namespace)

ME

Component

Care plan

Component ID

COM-007-001

Link на API-специфікацію

https://medicaleventsmisapi.docs.apiary.io/#reference/care-plan/get-care-plans-by-search-params/get-care-plans-by-search-params

Resource

{{host}}/api/patients/{{patient_id}}/care_plans

Scope

care_plan:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This WS is designed to return records about Care plans filtered by submitted parameters withtin specified patient. List should be returned without activities.

Процеси роботи з планом лікування (care plan) | Отримання інформації плану лікування

Logic

Returns care plan list filtered by submitted parameters within specified patient.

Service logic

Service returns all Care plans related to the patient filtered by submitted parameters:

  1. Get all care plans by patient_id from care_plans collection (MongoDB)

  2. Filter list above by submitted search parameters

  3. Render a response according to specification with found Care plan entities. Care plans should be rendered without their activities.

Configuration parameters

N/A

Dictionaries

PROVIDING_CONDITION

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 

String

MPI identifier of the patient

7c3da506-804d-4550-8993-bf17f9ee0402

2

 

 

 

 

 

Request structure

See on API-specification

 Example

Headers

Headers

Request data validation

Authorize

  1. Verify the validity of access token

    1. Return (401, 'unauthorized') in case of validation fails

  2. Verify that token is not expired

    1. in case of error - return (401, 'unauthorized')

  3. Check user scopes in order to perform this action (scope = 'care_plan:read')

    1. Return (403, 'invalid scopes') in case of invalid scope(s)

Request to process the request using a token in the headers

Access to the resource is also managed by ABAC rules (EN)

Validate Patient

  1. Get Patient identifier from the URL

  2. Check it exists in DB

    1. Return 404 ('not found') in case of error

Processing

N/A

Response structure examples

See on API-specification

 Example
{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
      "based_on": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "care_plan"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "requisition": "0123-4567-89AB-CEIK",
      "part_of": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "care_plan"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "period": {
        "start": "2018-08-02T10:45:16.000Z",
        "end": "2018-08-02T11:00:00.000Z"
      },
      "intent": "order",
      "encounter": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "author": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "subject": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "patient"
              }
            ]
          },
          "value": "7c3da506-804d-4550-8993-bf17f9ee0403"
        }
      },
      "status": "active",
      "terms_of_service": {
        "coding": [
          {
            "system": "PROVIDING_CONDITION",
            "code": "INPATIENT"
          }
        ]
      }
    }
  ]
}

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

200

 Response

 

3

401

unauthorized

 Invalid access token

4

403

invalid scopes

Invalid scope(s)

5

404

not found

 

6

Специфічні

7

 

Post-processing processes

N/A

Technical modules where the method is used

Название

ID ТМ

Статус

/wiki/spaces/ESOZ/pages/17378181218

TM0112

/wiki/spaces/YK/pages/17837688354

  • No labels

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