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

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 7 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 requisition [API-007-001-001-0221]

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-0221

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-requisition/get-care-plans-by-requisition

Resource

{{host}}/api/patients/care_plans

Scope

care_plan:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This WS must be used to discover Care plans by requisition number. If nothing found by requisition number - it will return empty list

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

Logic

This service must be used to discover Care plans by requisition number. If nothing found by requisition number - it will return empty list.

Service logic

Service returns all Care plans with specified requisition number filtered by status if submitted:

  1. Get all care plan by requisition from care_plans collection (MongoDB)

  2. If submitted, filter list above by status

  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

requisition

 

String

requisition number

0123-4567-89AB-CEIK

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)

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"
          }
        ]
      },
      "identity": {
        "last_name": "Іванов",
        "first_name": "І.",
        "second_name": "І.",
        "gender": "MALE",
        "age": 35
      }
    }
  ]
}HTTP status codes

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

Специфічні

6

 

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

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