Purpose

This web service is designed to return immunizations info by episode_id.

Specification

Link	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/episode-of-care/get-immunizations-in-episode-context
Resource	/api/patients/{{patient_id}}/episodes/{{episode_id}}/immunizations
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 is designed to return immunizations info by episode_id.

Filters

Filter	Type	Description	Example
patient_id	String	Patient identifier	`70a9e15b-b71b-4caf-8f2e-ff247e8a5677`
episode_id	String	Episode identifier	`a10aeafb-0df2-4091-bc83-f07e92a100ae`
vaccine_code	String		`wex-10`
date_from	String		`1990-01-01`
date_to	String		`2000-01-01`
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

Verify the validity of access token
- Return 401 in case validation fails
Verify token is not expired
- in case error return 401
Check user scopes in order to perform this action (scope = 'immunization:read')
- Return 403 in case invalid scope(s)

Headers

Наприклад:

Content-Type:application/json
Authorization:Bearer Bearer {{access_token}}
API-key:{{secret}}

Request data validation

API paragraph not found

Processing

API paragraph not found

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",
      "status": "completed",
      "not_given": false,
      "vaccine_code": {
        "coding": [
          {
            "system": "eHealth/vaccine_codes",
            "code": "HepAHepB"
          }
        ]
      },
      "context": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "date": "2018-10-08T09:46:37.694Z",
      "inserted_at": "2018-08-02T10:45:16.000Z",
      "updated_at": "2018-08-02T10:45:16.000Z",
      "primary_source": false,
      "performer": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ],
            "text": "Галина Олександрівна"
          },
          "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
        }
      },
      "manufacturer": "VacinePro Manufacturer",
      "lot_number": "AAJN11K",
      "expiration_date": "2018-10-08T09:46:37.694Z",
      "site": {
        "coding": [
          {
            "system": "eHealth/immunization_body_sites",
            "code": "oral"
          }
        ]
      },
      "route": {
        "coding": [
          {
            "system": "eHealth/vaccination_routes",
            "code": "IM"
          }
        ]
      },
      "dose_quantity": {
        "value": 18,
        "unit": "mg",
        "system": "eHealth/immunization_dosage_units"
      },
      "explanation": {
        "reasons": {
          "coding": [
            {
              "system": "eHealth/reason_explanations",
              "code": "immunization_by_calendar"
            }
          ],
          "text": "Планове за календарем щеплень"
        }
      },
      "reactions": [
        {
          "detail": {
            "identifier": {
              "type": {
                "coding": [
                  {
                    "system": "eHealth/resources",
                    "code": "observation"
                  }
                ]
              },
              "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
            },
            "display_value": "null"
          }
        }
      ],
      "vaccination_protocols": [
        {
          "dose_sequence": 1,
          "description": "Vaccination Protocol Sequence 1",
          "authority": {
            "coding": [
              {
                "system": "eHealth/vaccination_authorities",
                "code": "WVO"
              }
            ]
          },
          "series": "Vaccination Series 1",
          "series_doses": 2,
          "target_diseases": [
            {
              "coding": [
                {
                  "system": "eHealth/vaccination_target_diseases",
                  "code": "1857005"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "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
200
401		Access token validation failed
403		Invalid scope

Get immunizations in episode context

Purpose

Specification

Logic

Filters

Request structure

Authorize

Headers

Request data validation

Processing

Response structure

Post-processing processes

HTTP status codes