Versions Compared

Version Old Version 3 New Version 4
Changes made by

Anzhela Kovalenko (SoE eHealth)

Anzhela Kovalenko (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configuration parameters

N/A

Dictionaries

...

eHealth/resources - condition(parameter “id“ in request)

...

eHealth/resources - employee (parameter “asserter“ in response)

...

eHealth/report_origins (parameter “patient“ in response)

...

eHealth/resources - encounter (parameter “context“ in response)

...

eHealth/condition_clinical_statuses (parameter “clinical_status“ in response)

...

eHealth/condition_verification_statuses (parameter “verification_status“ in response)

...

eHealth/condition_severities (parameter “severity“ in response)

...

eHealth/resources - observations (parameter “evidences:details“ in response)

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 M 

String

Unique MPI patient Patient identifier

7a489bbd70a9e15b-d8e2b71b-48d94caf-92fd8f2e-fcf0102f7b08ff247e8a5677

2

condition_id

 M 

String

Unique condition Condition identifier

340b86fda10aeafb-23f30df2-4a334091-94c5bc83-8ec19d116c33f07e92a100ae

Request structure

See on API-specification

Expand
titleExample
Code Block
languagejson
Headers
See on Headers
Request data validation
Authorize
...
  • Verify the validity of access token
    • Return (401, 'Invalid access token') in case of validation fails
  • Verify that token is not expired
    • in case of error - return (401, 'Invalid access token')
  • Check user scopes in order to perform this action (scope = 'medical_event_context:read')
    • Return (403, 'Your scope does not allow to access this resource. Missing allowances: medical_event_context:read') in case of invalid scope(s)
Validate Person
  • Get Person identifier from the URL
  • Check it exists in DB
    • Return 404 ('not_found') in case of error
Validate Encounter
  • Get Condition identifier from the URL
    • Check it exists in DB
      • Return 404 ('not_found') in case of error
    • Check Condition belongs to patient
      • Return 404 ('not_found') in case of error
Processing
N/A
Response structure examples
...
 Expand
titleExample
 Code Block
languagejson
{
  "data": {
    "idepisode": "6fe6d880-f100-4e39-a278-1d14eb8472ef",
    "primary_source": true,
    "asserter": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ],
          "text": ""
        },
        "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"episode"
       }     },
    "context": {
     
"identifier": {         "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "encounter"
            }
          ]
        },
        "value": "9183a36b7c3da506-4d45804d-42444550-93398993-63d81cd08d9cbf17f9ee0403"
      },
      "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"
          }
        ]
      }
    ]
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}
...
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
 
 
200
 
 
 
3
 
401
 
Access token validation failed
 
4
 
401
 
Access token expired
 
5
 
403
 
Invalid scope
 
6
Специфічні
Post-processing processes
...