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

...

languagegraphql

...

Page Properties
idAPI_Specification

Link

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

Resource

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

Scope

Scope для доступу

Components

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

Microservices

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

Protocol type

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

Request type

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

Sync/Async

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

Public/Private/Internal

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

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

Autorize

Headers

 

Request data validation

Processing

 

Response structure

 

Post-processing processes

 

HTTP status codes