REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

• Properties of a REST API method document

• Purpose

• Logic

• Configuration parameters

• Dictionaries

• Input parameters

• Request structure

• Headers

• Request data validation

• Processing

• Response structure examples

• HTTP status codes

• Post-processing processes

• Technical modules where the method is used

Properties of a REST API method document

Purpose

This method allows to get a list of Composition in patient context. Also, this list can be filtered using search parameters.

Key points

1. Only authenticated and authorized employee with appropriate scope can use this method

2. Method returns a short information of Compositions that belongs to the specified patient.

3. List can be filtered by search params.

Logic

Service logic

Service returns all Compositions related to the patient, filtered by submitted parameters:

• Get all Composition by subject from compositions collection (MongoDB)

• Filter list above by submitted search parameters

• Render a response according to specification with a list of found Composition entities.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorization

• Verify the validity of access token

  • in case of error - return 401 “Invalid access token” in case of validation fails

• Verify that token is not expired

  • in case of error - return 401 “Invalid access token”

• Check user and client scopes in order to perform this action (scope = 'composition:read')

  • return 403 “Your scope does not allow to access this resource. Missing allowances: composition:read” in case of invalid scope(s)

• Access to the resource is also managed by ABAC module

Validate Patient

• Get Patient identifier from the URL

• Check it exists in Mongo DB

  • Return 404 ('not found') in case of error

Search params

All search params are optional. Search with a few params executes according to the logical AND rule.

• encounter_id

  • filter list by composition.encounter.identifier.value

• context_episode_id

  • filter list by episode of care - composition.context_episode_id

• type

  • filter list by composition.type.coding[*].code

• category

  • filter list by composition.category.coding[*].code

• title

  • filter list by composition.title

• status

  • filter list by composition.status

• author

  • filter list by composition.author.identifier.value

• attester

  • filter list by composition.attester.party.value

• custodian

  • filter list by composition.custodian.identifier.value

• date_from

  • filter list by $.date_from <= composition.date

• date_to

  • filter list by $.date_to >= composition.date

• page

  • filter list by page number

• page_size

  • a limit on the number of objects to be returned, between 1 and 100. Default: 50

Processing

N/A

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used