Purpose

Return episodes, that patient gave approvals to read by a current employee.

Specification

Link	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/episode-of-care/get-approved-episodes
Resource	/api/patients/{{patient_id}}/episodes/approved
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

This web service returns episodes, that patient gave approvals to read by a current employee.

Filters

Filter	Type	Description	Example
patient_id	String	Patient identifier	`70a9e15b-b71b-4caf-8f2e-ff247e8a5677`
page	Number	Page number	`2`
page_size	Number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	`50`
code	String	current diagnosis code	`R80`

Request structure

API paragraph not found

Authorize

Request to process the request using a token in the headers

Headers

Наприклад:

Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
api-key:aFBLVTZ6Z2dON1V

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 = 'episode:read')
1. Return 403 in case invalid scope(s)

Processing

Select list of employees from PRM related to the current user in the current legal_entity, using data from the token
Select all active approvals from Medical Events, where these employees referenced as a `granted_to`
Select all the episodes from ME that are referenced as `granted resources` in the approvals from step 2.
Show episodes to the client ordered by inserted_at

Response structure

See on Apiary

Example:

Response example

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "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": "Епізод був відмінений у зв'язку з помилкою при виборі пацієнта"
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

Post-processing processes