Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

Purpose

This method is designed to search for a composition

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

...

API paragraph not found

Global and configuration parameters

None

Input parameters

Input parameter

Values

Type

Description

Example

patientId

String ($uuid)

MPI patient ID

Filters

Filter

Values

Type

Description

Example

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

Validate request (JSON schema)

API paragraph not found

Validation data request

API paragraph not found

Processing

API paragraph not found

Response structure

See on SwaggerHub

Example:

Expand
titleResponse example
Code Block
[
  {
    "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

NoneAPI paragraph not found

HTTP status codes

HTTP status code

Message

What caused the error

 200

Search results

 

Backward compatibility

...