Versions Compared

Version Old Version 3 New Version Current
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)

...

Document type

Метод REST API

Document title

[DRAFT] [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)

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

Resource

{{host}}//api.ehealth.gov.ua/api/patients/patient_id/compositions/id/immunizations/encounterimmunization_packageid

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

...

 

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

immunization_id

 M

String ($uuid) (path)

Immunization identifier

3a0dcfd7-5348-4511-b46d-b2dc4b94ca98

Request structure

See on API-specification

...

...

Headers

Headers

Request data validation

...

  • 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",
    "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

403

forbidden

4

403

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

5

404

not found

6

Специфічні

7

 

...