Versions Compared

Version Old Version 2 New Version Current
Changes made by

Serhii.Matiushyn

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)

...

Properties of a REST API method document

Scope

Document type

Метод REST API

Document title

[Document statusDRAFT] REST API [Назва методу] [ID методуNEW] Get Immunization details in Composition context [API-007-011-001-0488]

Guideline ID

GUI-0011

Author

@Mariana Veremeieva (UA SoE eHealth)

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-007-011-001-0488

Microservices (namespace)

MPIME

Component

AuthCompositions_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-clientimmunization-details-in-composition-context

Resource

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

/compositions/id/immunizations/immunization_id

Scope

composition:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

Purpose

This method allows to get single Immunization 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

...

  • Get Immunization from immunizations collection (MongoDB)

    • Check it exists in DB

      • Return 404 ('not found') in case of error

    • Check Immunization belongs to the patient

      • Return 403 ('forbidden') in case of error

  • Render response according to specification

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in ConfluenceN/A

Dictionaries

N/A

Input parameters

Description of input parameters

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

23

 immunization_id

 

 

 

  M

String ($uuid) (path)

Immunization identifier

3a0dcfd7-5348-4511-b46d-b2dc4b94ca98

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

...

titleExample

...

Headers

Headers

...

Request data validation

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

 

...

 

...

 

...

 

...

 

...

Authorization

  • 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 ABAC module

Validate Patient

  • Get Patient identifier from the URL

  • Check it exists in DB

    • Return 404 ('not found') in case of error

...

  • Get Composition identifier from the URL

  • Check it exists in DB

    • Return 404 ('not found') in case of error

  • Check Composition belongs to patient

    • Return 403 ('forbidden') in case of error

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST APIN/A

Response structure examples

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API response structure, example

Expand
titleExample
Code Block
{
  "data": {
    "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
    "status": "completed",
    "not_given": false,
    "vaccine_code": {
      "coding": [
        {
          "system": "eHealth/vaccine_codes",
          "code": "HepAHepB"
        }
      ]
    },
    "context": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "encounter"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "date": "2018-10-08T09:46:37.694Z",
    "inserted_at": "2018-08-02T10:45:16.000Z",
    "updated_at": "2018-08-02T10:45:16.000Z",
    "primary_source": false,
    "performer": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ],
          "text": "Галина Олександрівна"
        },
        "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
      }
    },
    "manufacturer": "VacinePro Manufacturer",
    "lot_number": "AAJN11K",
    "expiration_date": "2018-10-08T09:46:37.694Z",
    "site": {
      "coding": [
        {
          "system": "eHealth/immunization_body_sites",
          "code": "oral"
        }
      ]
    },
    "route": {
      "coding": [
        {
          "system": "eHealth/vaccination_routes",
          "code": "IM"
        }
      ]
    },
    "dose_quantity": {
      "value": 18,
      "unit": "mg",
      "system": "eHealth/immunization_dosage_units"
    },
    "explanation": {
      "reasons": {
        "coding": [
          {
            "system": "eHealth/reason_explanations",
            "code": "immunization_by_calendar"
          }
        ],
        "text": "Планове за календарем щеплень"
      }
    },
    "reactions": [
      {
        "detail": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "observation"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          },
          "display_value": "null"
        }
      }
    ],
    "vaccination_protocols": [
      {
        "dose_sequence": 1,
        "description": "Vaccination Protocol Sequence 1",
        "authority": {
          "coding": [
            {
              "system": "eHealth/vaccination_authorities",
              "code": "WVO"
            }
          ]
        },
        "series": "Vaccination Series 1",
        "series_doses": 2,
        "target_diseases": [
          {
            "coding": [
              {
                "system": "eHealth/vaccination_target_diseases",
                "code": "1857005"
              }
            ]
          }
        ]
      }
    ]
  },
  "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

401

Invalid access token

3

 

401

Unauthorized

Помилка підтвердження

4

403

forbidden

54

403

Your scope does not allow to access this resource. Missing allowances: composition:read

65

1000

404

Composition not found

COMPOSITION_NOT_FOUND_404

Не знайдено медичний висновок

7

404

not found

8

Специфічні

9

 

422

Only for active MPI record can be created medication request!

 

 

6

Специфічні

7

 

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical N/A

Technical modules where the method is used

Название

ID ТМ

Статус

/wiki/spaces/ESOZ/pages/17378181218

TM0112

/wiki/spaces/YK/pages/17837688354

...