1 Purpose
2 Specification
3 Logic
4 Filters
5 Request structure
6 Authorize
7 Headers
8 Request data validation
- 8.1 Validate token
- 8.2 Validate scopes
9 Processing
10 Response structure
11 Post-processing processes
12 HTTP status codes

Purpose

This web service is designed to return conditions by episode_id or encouner_id.

Specification

Link	https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-conditions
Resource	/api/patients/{{patient_id}}summary/conditions
Scope	patient_summary:read
Components	Patient Summary
Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Async
Public/Private/Internal	Public

Logic

API paragraph not found

Filters

Filter	Values	Type	Description	Example

Filter	Type	Description	Example
patient_id	String	Unique patient identifier	`7a489bbd-d8e2-48d9-92fd-fcf0102f7b08`
page	Number	Page number	`1`
page_size	Number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	`50`
code	String		`A20`
onset_date_from	String		`1990-01-01`
onset_date_to	String		`2000-01-01`

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

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

Access to the resource is also managed by ABAC module

Processing

API paragraph not found

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "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"
            }
          ]
        }
      ]
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200

E-Health

Get Conditions (Summary)

Analytics

Purpose

Specification

Logic

Filters

Request structure

Authorize

Headers

Request data validation

Validate token

Validate scopes

Processing

Response structure

Post-processing processes

HTTP status codes

Related content