Purpose

...

Return a list of short Encounter info filtered by search params

Specification

...

Page Properties
Link https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-short-encounters-by-search-params Resource /api/patients/{{patient_id}}/summary/encounters 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

...

The endpoint returns a list of short Encounter info filtered by search params

...

Filter	Values	Type	Description	Example
patient_id		String	Unique patient identifier	7075e0e2-6b57-47fd-aff7-324806efa7e5
date_from		String		1990-01-01
date_to		String		2000-01-01
episode_id		String		f48d1b6c-a021-4d6a-a5a4-aee93e152ecc
status		String		finished
type		String		discharge
class		String		INPATIENT
performer_speciality		String		VIROLOGY
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

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

...

API paragraph not found

Processing*

API paragraph not found

...

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 = 'patient_summary:read')

  1. Return 403 in case invalid scope(s)

Validate patient

• Validate patient exists in MongoDB

  • In case of error return 404 not found

Processing

1. Get all patient's encounters

2. Filter using Forbidden Groups

3. Apply filters provided by user

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "465fb6fe-2dea-4b8a-9ef7-58379d1eaab0",
      "status": "finised",
      "date": "2018-08-02T10:45:16.000Z",
      "episode": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "class": {
        "system": "eHealth/encounter_classes",
        "code": "inpatient"
      },
      "type": {
        "coding": [
          {
            "system": "eHealth/encounter_types",
            "code": "discharge"
          }
        ]
      },
      "performer_speciality": {
        "coding": [
          {
            "system": "SPECIALITY_TYPE",
            "code": "VIROLOGY"
          }
        ]
      }
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

Post-processing processes

...

API paragraph not found

HTTP status codes

...

Page Properties
HTTP status code Message What caused the error  200

...