Versions Compared

Version Old Version 1 New Version Current
Changes made by

Anzhela Kovalenko (SoE eHealth)

Anzhela Kovalenko (SoE eHealth)

Saved on

Key

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

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[DRAFT] Get Immunization Medication Statement context [API-007-004-005007-02620266]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-007-004-005007-02620266

Microservices (namespace)

ME

Component

Episode

Component ID

COM-007-006

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

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/immunizationmedication-statement/get-medication-immunizationstatement-context

Resource

{{host}}/api/patients/{{patient_id}}/immunizations/{{immunizationmedication_statements/medication_statement_id}}/context

Scope

medical_event_context:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

...

This method allows to get the context of Immunization Medication Statement in order to create approval on episode and receive access to other medical events.

...

Service returns context (episode), immunization medication statement based on:

  • Get Immunization Medication Statement object byimmunizationmedication_statement_id from immunizations medication_statements (MongoDB)

  • Get immunizationmedication_statement.context.identifier from Immunization Medication Statement object

  • Call Get Encounter context :

    • Get Encounter objectby immunizationmedication_statement.context.identifier (immunizationmedication_statement.context.identifier = encounter._id)
      AFTER

    • Get encounter.episode from Encounter object

  • Render a response according to specification

...

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 

String

Patient identifier

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

2

immunizationmedication_statement_id

 

String

Immunization Medication Statement identifier

a10aeafb-0df2-4091-bc83-f07e92a100ae

Request structure

See on API-specification

Expand
titleExample
Code Block
languagejson
...
  • Get Person identifier from the URL
  • Check it exists in DB
    • Return 404 ('not_found') in case of error
Validate Encounter
  • Get Immunization Medication Statement identifier from the URL
    • Check it exists in DB
      • Return 404 ('not_found') in case of error
    • Check Immunization Medication Statement belongs to patient
      • Return 404 ('not_found') in case of error
...
Response structure examples
See on API-specification 
 Expand
titleExample
 Code Block
languagejson
{
  "data": {
    "episode": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "episode"
            }
          ]
        },
        "value": "7c3da506-804d-4550-8993-bf17f9ee0403"
      },
      "display_value": "null"
    }
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}
...