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

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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

/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 Condition context [API-007-008-003-0284]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-007-008-003-0284

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-008

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

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/conditions/get-condition-context

Resource

{{host}}/api/patients/{{patient_id}}/conditions/{{condition_id}}/context

Scope

medical_event_context:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

Purpose

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

Logic

Service returns context (episode), condition based on:

  • Get Condition object by condition_id from conditions (MongoDB)

  • Get condition.context_episode_id from Condition object

  • Render a response according to specification

Configuration parameters

N/A

Dictionaries

  1. eHealth/resources - condition(parameter “id“ in request)

  2. eHealth/resources - employee (parameter “asserter“ in response)

  3. eHealth/report_origins (parameter “patient“ in response)

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

  5. eHealth/ICD10/condition_codes (parameter “code“ in response)

  6. eHealth/condition_clinical_statuses (parameter “clinical_status“ in response)

  7. eHealth/condition_verification_statuses (parameter “verification_status“ in response)

  8. eHealth/condition_severities (parameter “severity“ in response)

  9. eHealth/body_sites (parameter “body_sites“ in response)

  10. eHealth/condition_stages (parameter “body_sites“ in response)

  11. eHealth/ICPC2/reasons (parameter “evidences:codes“ in response)

  12. eHealth/resources - observations (parameter “evidences:details“ in response)

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 M

String

Unique MPI patient identifier

7a489bbd-d8e2-48d9-92fd-fcf0102f7b08

2

id

 M

String

Unique condition identifier

340b86fd-23f3-4a33-94c5-8ec19d116c33

Request structure

See on API-specification

 Example

Headers

See on Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Processing

N/A

Response structure examples

See on API-specification

 Example
{
  "data": {
    "id": "6fe6d880-f100-4e39-a278-1d14eb8472ef",
    "primary_source": true,
    "asserter": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ],
          "text": ""
        },
        "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
      }
    },
    "context": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "encounter"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "code": {
      "coding": [
        {
          "system": "eHealth/ICD10/condition_codes",
          "code": "K87"
        }
      ]
    },
    "clinical_status": "active",
    "verification_status": "provisional",
    "severity": {
      "coding": [
        {
          "system": "eHealth/condition_severities",
          "code": "55604002"
        }
      ]
    },
    "body_sites": [
      {
        "coding": [
          {
            "system": "eHealth/body_sites",
            "code": "head"
          }
        ]
      }
    ],
    "onset_date": "2018-10-08T09:46:37.694Z",
    "asserted_date": "2018-10-08T09:46:37.694Z",
    "inserted_at": "2018-08-02T10:45:16.000Z",
    "updated_at": "2018-08-02T10:45:16.000Z",
    "stage": {
      "summary": {
        "coding": [
          {
            "system": "eHealth/condition_stages",
            "code": "14803004"
          }
        ]
      }
    },
    "evidences": [
      {
        "codes": [
          {
            "coding": [
              {
                "system": "eHealth/ICPC2/reasons",
                "code": "169068008"
              }
            ]
          }
        ],
        "details": [
          {
            "identifier": {
              "type": {
                "coding": [
                  {
                    "system": "eHealth/resources",
                    "code": "observation"
                  }
                ]
              },
              "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
            },
            "display_value": "null"
          }
        ]
      }
    ]
  },
  "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

 

 

200

 

 

 

3

 

401

 

Access token validation failed

 

4

 

401

 

Access token expired

 

5

 

403

 

Invalid scope

 

6

Специфічні

Post-processing processes

N/A

Technical modules where the method is used

  • No labels

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