Versions Compared

Version Old Version 3 New Version 4
Changes made by

Anzhela Kovalenko (SoE eHealth)

Mariana Veremeieva (UA SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

...

Scope

Document type

Метод REST API

Document title

[DRAFT] [NEW] Get Episode details in Composition context [API-007-011-001-0481]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-007-011-001-0481

Microservices (namespace)

ME

Component

Compositions_ME

Component ID

COM-007-011

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

https://ehealthmisapi1ehealthmedicalevents991v11.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configurationevents/composition/get-clientepisode-details-in-composition-context

Resource

{{host}}//api.ehealth.gov.ua/api/patients/patient_id/encounter_package

compositions/id/episodes/episode_id

Scope

composition:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

Purpose

This method allows to get single Episode of Care by its identifier using Composition context. It is designed to provide access to resources mentioned in Composition in case user has active Approval to such Composition.

...

 

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 M

String ($uuid) (path)

Unique patient identifier

 7075e0e2-6b57-47fd-aff7-324806efa7e5

2

 

 

 

 

composition_id

 M

String ($uuid) (path)

Composition object ID

 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

3

pisode_id

M

String ($uuid) (path)

Episode identifier

3a0dcfd7-5348-4511-b46d-b2dc4b94ca98

Request structure

See on API-specification

Expand
titleExample
Code Block
...
  • Verify the validity of access token
    • in case of error - return 401 “Invalid access token” in case of validation fails
  • Verify that token is not expired
    • in case of error - return 401 “Invalid access token”
  • Check user and client scopes in order to perform this action (scope = 'composition:read')
    • return 403 “Your scope does not allow to access this resource. Missing allowances: composition:read” in case of invalid scope(s)
  • Access to the resource is also managed by /wiki/spaces/emal/pages/18119196701 ABAC module
Validate Patient
  • Get Patient identifier from the URL
  • Check it exists in DB
    • Return 404 ('not found') in case of error
...
Response structure examples
See on API-specification 
 Expand
titleExample
 Code Block
{
  "data": {
    "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
    "inserted_at": "2018-08-02T10:45:16.000Z",
    "updated_at": "2018-08-02T10:45:16.000Z",
    "type": {
      "system": "eHealth/episode_types",
      "code": "primary_care"
    },
    "status": "active",
    "name": "Діабет 2018",
    "current_diagnoses": [
      {
        "condition": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "condition"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          },
          "display_value": "null"
        },
        "code": {
          "coding": [
            {
              "system": "eHealth/ICPC2/conditions",
              "code": "A20"
            }
          ]
        },
        "role": {
          "coding": [
            {
              "system": "eHealth/diagnosis_roles",
              "code": "CC"
            }
          ]
        },
        "rank": 1
      }
    ],
    "diagnoses_history": [
      {
        "date": "2018-08-02T10:45:16.000Z",
        "evidence": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "encounter"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          },
          "display_value": "null"
        },
        "diagnoses": [
          {
            "condition": {
              "identifier": {
                "type": {
                  "coding": [
                    {
                      "system": "eHealth/resources",
                      "code": "condition"
                    }
                  ]
                },
                "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
              },
              "display_value": "null"
            },
            "code": {
              "coding": [
                {
                  "system": "eHealth/ICPC2/conditions",
                  "code": "A20"
                }
              ]
            },
            "role": {
              "coding": [
                {
                  "system": "eHealth/diagnosis_roles",
                  "code": "CC"
                }
              ]
            },
            "rank": 1
          },
          {
            "condition": {
              "identifier": {
                "type": {
                  "coding": [
                    {
                      "system": "eHealth/resources",
                      "code": "condition"
                    }
                  ]
                },
                "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
              },
              "display_value": "null"
            },
            "code": {
              "coding": [
                {
                  "system": "eHealth/ICPC2/conditions",
                  "code": "A20"
                }
              ]
            },
            "role": {
              "coding": [
                {
                  "system": "eHealth/diagnosis_roles",
                  "code": "CC"
                }
              ]
            },
            "rank": 1
          }
        ],
        "is_active": "true"
      }
    ],
    "status_history": [
      {
        "status": "active",
        "status reason": {
          "coding": [
            {
              "system": "eHealth/episode_closing_reasons",
              "code": "cured"
            }
          ]
        },
        "inserted_at": "2018-08-02T10:45:16.000Z"
      }
    ],
    "managing_organization": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "legal_entity"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "Медікал Солюшнc"
    },
    "period": {
      "start": "2018-08-02T10:45:16.000Z",
      "end": "2018-08-03T11:00:00.000Z"
    },
    "care_manager": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "closing_summary": "Носові шляхи вільні, горло рожеве, температура в нормі",
    "status_reason": {
      "coding": [
        {
          "system": "eHealth/episode_closing_reasons",
          "code": "cured"
        }
      ]
    },
    "explanatory_letter": "Епізод був відмінений у зв'язку з помилкою при виборі пацієнта"
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
404
not found
3
401
Invalid access token
4
403
forbidden
5
403
Your scope does not allow to access this resource. Missing allowances: composition:read
6
Специфічні
7
...