Versions Compared

Key

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

Purpose

This WS allows to get rule engine field set for Rule engine rules configurator in Administration panel.

Key points

  1. This is a graphQl query method used in Administration panel only.

  2. Only authenticated and authorized NHS employee with can get rule engine field set.

Specification

Page Properties
idAPI_Specification

...

Code Block
languagegraphql

Link

API paragraph not found

Посилання на Apiary або Swagger

Resource

API paragraph not found

Посилання на ресурс, наприклад: /api/persons/create

Scope

API paragraph not found

Scope для доступу

Components

API paragraph not found

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

API paragraph not found

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

API paragraph not found

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

API paragraph not found

Метод є синхронним чи асинхронним?

Public/Private/Internal

Private

Потрібно зазначити тип методу за ступенем доступності

Expand
Code Block
"Reads a single `RuleEngineFieldSet`."
  ruleEngineFieldSet: JSON

...

Logic

  1. Create response with following fields:

Expand
Code Block
episode    
    type
    period
       start
       end
    current_diagnoses
       code
    inserted_at
    updated_at

encounter    
    class
    type
    date
    hospitalization
       discharge_department
       re_admisson
    reasons
    actions
    inserted_at
    updated_at

condition    
    code
    verification_status
    clinical_status
    primary_source
    severity
    asserted_date
    onset_date
    body_sites
    inserted_at
    updated_at

diagnostic_report    
    code
    category
    primary_source
    issued
    conclusion_code
    effective
       effective_date_time
       effective_period
          start
          end
    inserted_at
    updated_at

procedure    
    category
    code
    primary_source
    outcome
    performed_date_time
    inserted_at
    updated_at

observation    
    categories
    code
    primary_source
    body_site
    interpretation
    value
       value_string
       value_date_time
       value_period
       value_quantity
       value_sampled_data
       value_boolean
       value_range
       value_codeable_concept
       value_ratio
       value_time
    effective
       effective_date_time
       effective_period
          start
          end
    issued
    method
    inserted_at
    updated_at

patient    
    age
    gender

2. Enrich response with possible comparators for each field set.

3. Render a response according to schema.

Request structure

API paragraph not found

Autorize

API paragraph not found

Headers

 API paragraph not found

Request data validation

API paragraph not found

Processing

 API paragraph not found

Response structure

 API paragraph not found

Post-processing processes

 API paragraph not found

HTTP status codes

 API paragraph not found