Purpose*

This method is designed to get a composition

Specification*

Link	https://app.swaggerhub.com/apis/bugzi11a/emal/1.0.8#/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

Logic*

Input parameters

Input parameter	Type	Description
compositionId	String ($uuid) (path)	Composition object ID
patientId	String ($uuid) (path)	Patient object ID
episodeId	String ($uuid) (path)	Episode of care object ID
encounterId	String ($uuid) (path)	Encounter object ID

Request structure

See on SwaggerHub

Authorize*

API paragraph not found

Headers*

API paragraph not found

Validation data request*

API paragraph not found

Processing*

API paragraph not found

Response structure*

See on SwaggerHub

Example:

Response example

{
  "identifier": {
    "type": {
      "coding": [
        {
          "system": "eHealth/composition",
          "code": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  },
  "status": "PRELIMINARY",
  "category": {
    "coding": [
      {
        "system": "eHealth/composition_categories",
        "code": "LIVE_BIRTH"
      }
    ]
  },
  "type": {
    "coding": [
      {
        "system": "eHealth/composition_types",
        "code": "NEWBORN"
      }
    ]
  },
  "date": "string",
  "title": "string",
  "relatesTo": {
    "code": "transforms",
    "targetIdentifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/composition",
            "code": "string"
          }
        ],
        "text": "string"
      },
      "value": "e49abc30-6d17-11ea-b83c-673680173afa"
    }
  },
  "event": [
    {
      "code": {
        "coding": [
          {
            "system": "eHealth/composition_events",
            "code": "COMPOSITION_VALIDITY_PERIOD"
          }
        ]
      },
      "period": {
        "start": "2020-06-26T15:22:53.403Z",
        "end": "2020-07-26T15:22:53.403Z"
      }
    }
  ],
  "subject": {
    "type": {
      "coding": [
        {
          "system": "eHealth/composition",
          "code": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  },
  "custodian": {
    "type": {
      "coding": [
        {
          "system": "eHealth/composition",
          "code": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  },
  "encounter": {
    "type": {
      "coding": [
        {
          "system": "eHealth/composition",
          "code": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  },
  "author": {
    "type": {
      "coding": [
        {
          "system": "eHealth/composition",
          "code": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  },
  "section": {
    "focus": {
      "type": {
        "coding": [
          {
            "system": "eHealth/composition",
            "code": "string"
          }
        ],
        "text": "string"
      },
      "value": "e49abc30-6d17-11ea-b83c-673680173afa"
    },
    "text": {
      "status": "generated",
      "div": "string"
    }
  },
  "extension": [
    {
      "valueCode": "IS_ACCIDENT",
      "valueBoolean": true
    },
    {
      "valueCode": "ERLN_DISABILITY_TICKET",
      "valueString": "string"
    },
    {
      "valueCode": "ERLN_DISABILITY_ERROR_TEXT",
      "valueString": "string"
    },
    {
      "valueCode": "TEMP_DISABILITY_PROCESSING_STATUS",
      "valueString": "PENDING"
    },
    {
      "valueCode": "TREATMENT_VIOLATION",
      "valueString": "late_arrival"
    },
    {
      "valueCode": "IS_INTOXICATED",
      "valueBoolean": true
    },
    {
      "valueCode": "IS_FOREIGN_TREATMENT",
      "valueBoolean": true
    },
    {
      "valueCode": "IS_FORCE_RENEW",
      "valueBoolean": true
    },
    {
      "valueCode": "AUTHORIZE_WITH",
      "valueUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    {
      "valueCode": "NEWBORN_PROCESSING_STATUS",
      "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
404	In case the Composition does not exist

getComposition

Purpose*

Specification*

Logic*

Input parameters

Request structure

Authorize*

Headers*

Validation data request*

Processing*

Response structure*

Post-processing processes*

HTTP status codes*