| Table of Contents | ||||
|---|---|---|---|---|
|
...
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/ehealthua/compositions/2.39.2#/main/searchCompositions |
Resource | /patients/{patientId}/composition |
Scope | composition:search |
Components | |
Using Dictionaries | COMPOSITION_STATUS COMPOSITION_TYPES |
Using Microservices | API paragraph not found |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private/Internal | Public |
Logic
...
| View file | ||
|---|---|---|
|
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
subject | string($uuid) | subject's MPI ID (patientID - incompatible with focus) | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 | |
focus | string($uuid) | subject's MPI ID (patientID - incompatible with subject) | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
Filters
Filter | Values | Type | Description | Example |
|---|---|---|---|---|
offset | minimum: 0 | integer(query) | The number of items to skip before starting to collect the result set. | 2 |
limit | minimum: 1 | integer(query) | The numbers of items to return. | 30 |
type | TEMP_DISABILITY NEWBORN | string(query) | COMPOSITION_TYPES dictionary value | TEMP_DISABILITY |
episodeOfCare | string($uuid) | episodeOfCareId | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 | |
encounter | string($uuid) | encounterId | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 | |
status |
|
|
| string(query) | COMPOSITION_STATUS ictionary value | ENTERED |
_IN |
_ERROR |
Dictionaries
...
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
HTTP status code | Message | What caused the error |
|---|---|---|
200 | Search results |
|