Purpose

This method is designed to search for a composition by the specified parameters and get a list of results that match these parameters.

Specification

Link	https://app.swaggerhub.com/apis/bugzi11a/emal/1.0.8#/main/searchCompositions
Resource	/patients/{patientId}/composition
Scope	composition:search
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

API paragraph not found

Input parameters

Input parameter	Values	Type	Description	Example
patientId		String ($uuid)	MPI patient ID

Filters

Filter	Values	Type	Description
offset		integer (query)	The number of items to skip before starting to collect the result set
limit	minimum: 1 maximum: 50 Default value : 20	integer (query)	The numbers of items to return
type	NEWBORN TEMP_DISABILITY	string (query)
episodeOfCare		string ($uuid) (query)

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",
    "title": "string",
    "type": {
      "coding": [
        {
          "system": "eHealth/composition_types",
          "code": "NEWBORN"
        }
      ]
    },
    "date": "string",
    "encounter": {
      "type": {
        "coding": [
          {
            "system": "eHealth/composition",
            "code": "string"
          }
        ],
        "text": "string"
      },
      "value": "e49abc30-6d17-11ea-b83c-673680173afa"
    },
    "episodeOfCare": {
      "type": {
        "coding": [
          {
            "system": "eHealth/composition",
            "code": "string"
          }
        ],
        "text": "string"
      },
      "value": "e49abc30-6d17-11ea-b83c-673680173afa"
    }
  }
]

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error
200	Search results

searchCompositions

Purpose

Specification

Logic

Input parameters

Filters

Request structure

Authorize

Headers

Validation data request

Processing

Response structure

Post-processing processes

HTTP status codes