Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Status

Page Properties


Specification
Status
colourGreen
titledone
Apiary
Status
colourGreen
titledone
JSON Schema request
Status
colourRed
titlespecs
JSON Schema response

Status
colourRed
titlespecs


Purpose

This WS is designed to describe the process of creating new medical program.

APIary 

http://docs.uaehealthapi.apiary.io/#reference/internal.-nhs-admin/medical-programs/create-medical-program

Input parameters 

  • name
  • is_active

Authorize

  1. Verify the validity of access token
  2. Check user scope (scope = 'medical_programs:write') in order to perform this action
    1. In case error - generate 401 response

Validate request (JSON schema)

  1. Validate request using JSON schemas (TBD):
    1. Return 422 with list of validation errors in case validation fails (422 EView)

Create new Medical Program

  1. Create new record in Medical_programs 
  2. Fill data 
Destination
Source
id
name$.name
is_active$.is_active
inserted_at:timestamp
inserted_byuser_id
updated_at:timestamp
updated_byuser_id

Prepare & return response data structure

  1. Fill response WS data structure 
  2. Validate response using JSON schemas (TBD)
    1. Return 422 with list of validation errors in case validation fails (422 EView)