Eden Health grdn.routes.impl.screeners API

swagger: '2.0'
info:
  version: null
  title: Grdn grdn.handler grdn.routes.impl.screeners API
  description: Eden Health Inc. primary backend API service.
consumes:
- application/json
produces:
- application/json
tags:
- name: grdn.routes.impl.screeners
  description: Handlers for screener fetching and submission.
paths:
  /v2/patient/{patient-id}/screener:
    get:
      summary: get-screener-handler
      description: "Given a patient id, return all active (unscored) screeners for that patient.\n  Filters the screeners and enriches the data per the `eden-screeners` athena\n  config entry.\n  Prepends any custom screeners from our dB."
      tags:
      - grdn.routes.impl.screeners
      parameters:
      - in: path
        name: patient-id
        description: 'origin spec: grdn.specs/patient-id-params'
        required: true
        type: string
        format: uuid
      - in: query
        name: funnel-id
        description: 'origin spec: grdn.specs/patient-id-params'
        required: false
        type: string
        format: uuid
      responses:
        default:
          description: Default success response.
          schema: {}
  /v2/patient/{patient-id}/screener-status:
    get:
      summary: get-screener-status-handler
      description: Gets all screeners completed by the patient, and filters the list based on screener-group.
      tags:
      - grdn.routes.impl.screeners
      parameters:
      - in: path
        name: patient-id
        description: 'origin spec: grdn.specs/get-screener-status-params'
        required: true
        type: string
        format: uuid
      - in: query
        name: screener-groups
        description: 'origin spec: grdn.specs/get-screener-status-params'
        required: false
        type: array
        items:
          type: string
      responses:
        default:
          description: Default success response.
          schema:
            type: object
            properties:
              screener-status:
                type: array
                items:
                  type: object
                  properties:
                    screener-group:
                      type: string
                    latest-version:
                      type: string
                    completed-version:
                      type: string
                  required:
                  - screener-group
                  - latest-version
                  - completed-version
            required:
            - screener-status
            title: grdn.specs.screeners/get-screener-status-response
  /v2/patient/{patient-id}/vax-location:
    get:
      summary: get-vax-location-handler
      description: Gets location from latest COVID vaccine survey response completed by the patient.
      tags:
      - grdn.routes.impl.screeners
      parameters:
      - in: path
        name: patient-id
        description: 'origin spec: grdn.specs/patient-id-params'
        required: true
        type: string
        format: uuid
      - in: query
        name: funnel-id
        description: 'origin spec: grdn.specs/patient-id-params'
        required: false
        type: string
        format: uuid
      responses:
        default:
          description: Default success response.
          schema:
            type: object
            properties:
              location:
                type: string
            required:
            - location
            title: grdn.specs.screeners/get-vax-location-response
  /v2/screener-card:
    get:
      summary: get-screener-card-handler
      description: Given a screener ID return sorted question list
      tags:
      - grdn.routes.impl.screeners
      parameters:
      - in: query
        name: screener-response-id
        description: 'origin spec: grdn.specs/screener-card-response-params'
        required: true
        type: string
        format: uuid
      - in: query
        name: covid-screener-id
        description: 'origin spec: grdn.specs/screener-card-response-params'
        required: true
        type: string
        format: uuid
      responses:
        default:
          description: Default success response.
          schema: {}