Table of Contents

minLevel	1
maxLevel	7

Purpose

This method is designed to get a compositionallows to get the details of the Composition and detailed information about the related medical report.

Used in processes:

1. Пошук та отримання МВ (загальний процес)

Specification

Link	https://app.swaggerhub.com/apis/bugzi11aehealthua/emalcompositions/12.032.8#2#/main/getComposition
Resource	/patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}
Scope	composition:read
Components	Compositions
Using Dictionaries	API paragraph not found
Using Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Async
Public/Private/Internal	Public

...

Input parameter	Type	Description	Example
compositionId	String ($uuid) (path)	Composition object ID	8c696fa4-6607-4aef-bab7-33cabc2dda2c
patientId	String ($uuid) (path)	Patient object ID	6a524088-c3f6-44ef-bcea-12a8e2900431
episodeId	String ($uuid) (path)	Episode of care object ID	e4f8c204-4879-4a90-a89f-707ffd7f02c4
encounterId	String ($uuid) (path)	Encounter object ID	d44ac2e9-9c83-4f5a-9ce1-0b764f260fff

Request structure

See on SwaggerHub

Expand

title	Get

request GET 'https://{environment}/api/patients/6a524088-c3f6-44ef-bcea-12a8e2900431/composition/8c696fa4-6607-4aef-bab7-33cabc2dda2c/episode/e4f8c204-4879-4a90-a89f-707ffd7f02c4/encounter/d44ac2e9-9c83-4f5a-9ce1-0b764f260fff' \

Authorize

API paragraph not found

Headers

API paragraph not found

Validation data request

...

Check user scopes in order to perform this action (scope = 'composition:read')
return 401 (Unauthorized) in case of invalid scope(s)

Headers

Content-Type: application/json
Authorization: Bearer {token}
api-key: {secret}

Validation data request

In the case of access denied to view the Composition according to the rules of ABAK - return 403 "Access denied"

Expand

title	Excample for access denied

{
"error": {
"type": "forbidden",
"message": "Access denied"
},
"meta": {
"type": "object",
"code": 403,
"request_id": "1b49cfc5-da89-4e72-a1b9-4448a4f23f0b#3245097",
"url": "http://{environment}/api/patients/eb26f1e9-5bf0-435a-ad99-8364db773cd2/composition/b3e1e5e0-ce30-40df-9ffe-6296024dafae/episode/a2876da5-bc86-430b-932b-166603d9d97b/encounter/64afc7f1-6c4c-4dc2-8c44-5d5e1c56a4f6"
}
}

Processing

API paragraph not found

Response structure

See on SwaggerHub

Example:

Expand

title	Response example

Code Block

{
  "identifierauthor": {
    "type": {
      "coding": [
        {
          "systemcode": "eHealth/compositionemployee",
          "codesystem": "stringeHealth/resources"
        }
      ],
      "text": "string"
    },
    "value": "e49abc3043cc2161-6d171c2b-11ea481b-b83ca618-673680173afa77e35817f850"
  },
  "status": "PRELIMINARY",
  "category": {
    "coding": [
      {
        "systemcode": "eHealth/composition_categoriesSICKNESS",
        "codesystem": "LIVECOMPOSITION_BIRTHCATEGORIES"
      }
    ]
  },
  "custodian": {
    "type": {
      "coding": [
        {
          "systemcode": "eHealth/compositionlegal_typesentity",
          "codesystem": "NEWBORNeHealth/resources"
        }
      ]
    },
    "datevalue": "string",0dccb76f-3ed0-40f4-8f73-e95e2f91ea29"
  "title": "string"},
  "relatesTodate": {
    "code": "transforms""2022-10-24T12:34:49.956Z",
    "targetIdentifierencounter": {
 
    "type": {
        "coding": [
 
        {

           "systemcode": "eHealth/compositionencounter",
            "codesystem": "stringeHealth/resources"

         }
        ],
 
      "text": "string"
 
    },

     "value": "e49abc30e39ee5ae-6d172644-11ea4f04-b83c8e64-673680173afabb359866e907"
 
  }
  },
  "event": [
    {
      "code": {
        "coding": [
          {
            "systemcode": "eHealth/composition_eventsCOMPOSITION_VALIDITY_PERIOD",
            "codesystem": "COMPOSITION_VALIDITY_PERIODEVENTS"
          }
        ]
      },
      "period": {
        "startend": "20202022-0610-26T1528T10:2245:53.403Z16Z",
        "endstart": "20202022-0710-26T1524T10:2245:53.403Z16Z"
      }
    }
  ],
  "subjectextension": {
    "type": {
      "coding": [
   
    {
   
      "systemvalueCode": "eHealth/compositionAUTHORIZE_WITH",

         "codevalueUuid": "string"e7ff2eef-712f-4676-960d-6aa16dce2103"
    },
    {
}      "valueBoolean": ]true,
      "textvalueCode": "stringIS_FORCE_RENEW"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"{
   },   "custodianvalueBoolean": true,
 {     "typevalueCode": {       "coding": ["IS_ACCIDENT"
    },
    {
  
       "systemvalueCode": "eHealth/compositionTREATMENT_VIOLATION",
          "codevalueString": "string"
   reject_recommendation"
    },
    {
 ],       "textvalueCode": "string"
  TREATMENT_VIOLATION_DATE",
 },     "valuevalueDate": "e49abc302022-6d17-11ea-b83c-673680173afa"10-24"
    },
  "encounter": {
    "type": {
      "codingvalueBoolean": [
        {
true,
         "systemvalueCode": "eHealth/composition",IS_FOREIGN_TREATMENT"
    },
    {
"code": "string"         }
      ]"valueBoolean": true,
      "textvalueCode": "stringIS_INTOXICATED"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  }],
  "authoridentifier": {
    "type": {
      "coding": [
        {
          "systemcode": "eHealth/composition",
          "codesystem": "stringeHealth/resources"
        }
      ],
      "text": "string"
    },
    "value": "e49abc302e629d9d-6d177d19-11ea4bc4-b83c937d-673680173afa9000b567fd2a"
  },
  "relatesTo": [],
  "section": {
    "focus": {
      "type": {
        "coding": [
          {
            "systemcode": "eHealth/compositionperson",
            "codesystem": "stringeHealth/resources"
          }
        ],
        "text": "string"
      },
      "value": "e49abc3052b504c7-6d170177-11ea4078-b83c834b-673680173afa52d89154081c"
    },
    "text": {
      "statusdiv": "generated",
      "divstatus": "stringempty"
    }
  },
  "extensionstatus": [
    {
      "valueCode": "IS_ACCIDENT""PRELIMINARY",
      "valueBooleansubject": true
    },     {
      "valueCodetype": "ERLN_DISABILITY_TICKET",{
      "valueStringcoding": "string"[
    },     {
      "valueCode": "ERLN_DISABILITY_ERROR_TEXT",       "valueStringcode": "string"
    },
person",
   {       "valueCodesystem": "TEMP_DISABILITY_PROCESSING_STATUS",eHealth/resources"
      "valueString": "PENDING"     },
    {       "valueCode": "TREATMENT_VIOLATION"],
      "valueStringtext": "late_arrivalstring"
    },

   {       "valueCode"value": "IS_INTOXICATED",52b504c7-0177-4078-834b-52d89154081c"
      "valueBoolean": true
    },
    {
      "valueCode"title": "IS_FOREIGN_TREATMENTK5HP-HX65-4C8X-E85B",
 
    "valueBooleantype": true
    },
    {

     "valueCodecoding": "IS_FORCE_RENEW",[
      "valueBoolean": true
    },{
     {       "valueCodecode": "AUTHORIZETEMP_WITHDISABILITY",
      "valueUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    {
      "valueCodesystem": "NEWBORNCOMPOSITION_PROCESSING_STATUSTYPES",
      "valueString": "PENDING"}
    ]
}  }
]
}

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error
200	If the object exists and access is authorized
403	Access denied	In the case of access denied to view the Composition according to the rules of ABAK
404	In case the Composition does not exist

...

Version	Old Version 9	New Version 10
Changes made by	Serhii Boldin (SoE eHealth) (Unlicensed)	Kateryna Haleta (SoE eHealth)
Saved on	Dec 17, 2022	Feb 19, 2023

Versions Compared

Key

Purpose

Specification

Request structure

Authorize

Headers

Validation data request

Check user scopes in order to perform this action (scope = 'composition:read')
return 401 (Unauthorized) in case of invalid scope(s)

Headers

Validation data request

Processing

Response structure

Post-processing processes

HTTP status codes

Page Comparison

Versions Compared

Key

Purpose

Specification

Request structure

Authorize

Headers

Validation data request

Check user scopes in order to perform this action (scope = 'composition:read')return 401 (Unauthorized) in case of invalid scope(s)

Headers

Validation data request

Processing

Response structure

Post-processing processes

HTTP status codes

Check user scopes in order to perform this action (scope = 'composition:read')
return 401 (Unauthorized) in case of invalid scope(s)