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

[DRAFT] Get Immunizations (Patient Summary) [API-007-008-009-0292]

Owned by Serhii Boldin (SoE eHealth) (Unlicensed)
Last updated: about 5 hours ago by Mykhaylo Khapchyk (SoE eHealth)
2 min read

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/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 Immunizations (Patient Summary) [API-007-008-009-0292]

Guideline ID

GUI-0011

Author

@Mykhaylo Khapchyk (SoE eHealth)

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-007-008-009-0292

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-008

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

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-immunizations

Resource

{{host}}/api/patients/{{patient_id}}/summary/immunizations

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This web service is designed to return immunizations list for a specified patient.

Logic

N/A (Not applicable)

Configuration parameters

N/A (Not applicable)

Dictionaries

  1. eHealth/resources - patient (parameter “patient_id“ in request)

  2. eHealth/vaccine_codes (parameter “vaccine_code“ in request/response)

  3. eHealth/resources - episode (parameter “status“ in response)

  4. eHealth/resources - encounter (parameter “context“ in response)

  5. eHealth/resources - employee (parameter “performer“ in response)

  6. eHealth/report_origins (parameter “report_origin“ in response)

  7. eHealth/immunization_body_sites (parameter “site“ in response)

  8. eHealth/vaccination_routes (parameter “route“ in response)

  9. eHealth/immunization_dosage_units (parameter “dose_quantity:system“ in response)

  10. eHealth/reason_explanations (parameter “explanation:reasons“ in response)

  11. eHealth/reason_not_given_explanations (parameter “explanation:reasons_not_given“ in response)

  12. eHealth/resources - observation (parameter “reactions“ in response)

  13. eHealth/vaccination_authorities (parameter “vaccination_protocol:authority“ in response)

  14. eHealth/vaccination_target_diseases (parameter “vaccination_protocol:authority“ in response)

Input parameters

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 M

String

Unique patient identifier

70a9e15b-b71b-4caf-8f2e-ff247e8a5677

2

vaccine_code

 

String

 

wex-10

3

period_start_from

 

String

 

2017-01-01

4

period_start_to

 

String

 

2017-01-01

5

page

 

Number

Page number

2

6

page_size

 

Number

A limit on the number of objects to be returned, between 1 and 100. Default: 50

50

Request structure

See on API-specification

Headers

See on Headers

Authorize

Request to process the request using a token in the headers

Request data validation

Validate token

  • Verify the validity of access token

    • Return 401 in case validation fails

  • Verify token is not expired

    • in case error return 401 

Validate scopes

  • Check user scopes in order to perform this action (scope = 'patient_summary:read')

    1. Return 403 in case invalid scope(s)

Access to the resource is also managed by ABAC module.

Validate patient

  • Validate patient exists in MongoDB

    • In case of error return 404 not found

Processing

  1. Get all patient's immunizations

  2. Apply filters provided by user

  3. Render a response according to specification

Response structure examples

See on API-specification

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

 

Response

 

3

 

401

 

Access token validation failed

 

4

 

401

 

Access token expired

 

5

 

403

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

Forbiden

 

6

 

404

 

Not found

 

7

Специфічні

Post-processing processes

N/A (Not applicable)

Technical modules where the method is used

N/A (Not applicable)

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