Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

Purpose

...

API paragraph not foundThis API method is designed to get information about Episode by its identifier

Specification

...

Page Properties

Link

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/episode-of-care/get-episode-by-id

Resource

/api/patients/{{patient_id}}/episodes/{{episode_id}}

Scope

episode:read

Components

Episode of Care

Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private/Internal

Public

Logic*

...

Input parameters

Input parameter

Values

Type

Description

Example

patient_id

String

Patient identifier

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

episode_id

String

Episode identifier

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

Request structure

...

Body has to be empty

Authorize

...

Request to process the request using a token in the headers

Headers

...

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

Request data validation*

API paragraph not found

...

API paragraph not found

Response structure

...

See on Apiary

Example:

Expand
titleResponse example
Code Block
{
  "data": {
    "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
    "inserted_at": "2018-08-02T10:45:16.000Z",
    "updated_at": "2018-08-02T10:45:16.000Z",
    "type": {
      "system": "eHealth/episode_types",
      "code": "primary_care"
    },
    "status": "active",
    "name": "Діабет 2018",
    "current_diagnoses": [
      {
        "condition": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "condition"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          },
          "display_value": "null"
        },
        "code": {
          "coding": [
            {
              "system": "eHealth/ICPC2/conditions",
              "code": "A20"
            }
          ]
        },
        "role": {
          "coding": [
            {
              "system": "eHealth/diagnosis_roles",
              "code": "CC"
            }
          ]
        },
        "rank": 1
      }
    ],
    "diagnoses_history": [
      {
        "date": "2018-08-02T10:45:16.000Z",
        "evidence": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "encounter"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          },
          "display_value": "null"
        },
        "diagnoses": [
          {
            "condition": {
              "identifier": {
                "type": {
                  "coding": [
                    {
                      "system": "eHealth/resources",
                      "code": "condition"
                    }
                  ]
                },
                "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
              },
              "display_value": "null"
            },
            "code": {
              "coding": [
                {
                  "system": "eHealth/ICPC2/conditions",
                  "code": "A20"
                }
              ]
            },
            "role": {
              "coding": [
                {
                  "system": "eHealth/diagnosis_roles",
                  "code": "CC"
                }
              ]
            },
            "rank": 1
          },
          {
            "condition": {
              "identifier": {
                "type": {
                  "coding": [
                    {
                      "system": "eHealth/resources",
                      "code": "condition"
                    }
                  ]
                },
                "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
              },
              "display_value": "null"
            },
            "code": {
              "coding": [
                {
                  "system": "eHealth/ICPC2/conditions",
                  "code": "A20"
                }
              ]
            },
            "role": {
              "coding": [
                {
                  "system": "eHealth/diagnosis_roles",
                  "code": "CC"
                }
              ]
            },
            "rank": 1
          }
        ]
      }
    ],
    "status_history": [
      {
        "status": "active",
        "status reason": {
          "coding": [
            {
              "system": "eHealth/episode_closing_reasons",
              "code": "cured"
            }
          ]
        },
        "inserted_at": "2018-08-02T10:45:16.000Z"
      }
    ],
    "managing_organization": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "legal_entity"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "Медікал Солюшнc"
    },
    "period": {
      "start": "2018-08-02T10:45:16.000Z",
      "end": "2018-08-03T10:45:16.000Z"
    },
    "care_manager": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "null"
    },
    "closing_summary": "Носові шляхи вільні, горло рожеве, температура в нормі",
    "status_reason": {
      "coding": [
        {
          "system": "eHealth/episode_closing_reasons",
          "code": "cured"
        }
      ]
    },
    "explanatory_letter": "Епізод був відмінений у зв'язку з помилкою при виборі пацієнта"
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

...

API paragraph not found

HTTP status codes

...

HTTP status code

Message

What caused the error

 200

 

 

...