Eden Health grdn.routes.impl.next-step API

Contains handlers for routes related to Patients.

OpenAPI Specification

eden-health-grdn-routes-impl-next-step-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  version: null
  title: Grdn grdn.handler grdn.routes.impl.next-step API
  description: Eden Health Inc. primary backend API service.
consumes:
- application/json
produces:
- application/json
tags:
- name: grdn.routes.impl.next-step
  description: Contains handlers for routes related to Patients.
paths:
  /v2/next-steps:
    post:
      summary: create-next-step-handler
      description: ''
      tags:
      - grdn.routes.impl.next-step
      parameters:
      - in: body
        name: grdn.specs.patients/create-next-step-handler-spec
        description: 'origin spec: grdn.specs.patients/create-next-step-handler-spec'
        schema:
          type: object
          properties:
            due-date:
              type: string
            visit-reason-id:
              type: integer
              format: int64
            provider-id:
              type: integer
              format: int64
              x-anyOf:
              - type: integer
                format: int64
              - type: string
            in-person-only:
              type: boolean
            patient-id:
              type: string
              format: uuid
            note:
              type: string
            send-date:
              type: string
            title:
              type: string
            type:
              type: string
            with-provider-id:
              type: string
              format: uuid
              allowEmptyValue: true
          required:
          - patient-id
          - type
          title: grdn.specs.patients/create-next-step-handler-spec
      responses:
        default:
          description: Default success response.
          schema: {}
  /v2/next-steps/{next-step-id}:
    put:
      summary: edit-next-step-handler
      description: ''
      tags:
      - grdn.routes.impl.next-step
      parameters:
      - in: path
        name: next-step-id
        description: 'origin spec: grdn.specs.patients/edit-next-step-handler-spec'
        required: true
        type: string
        format: uuid
      - in: body
        name: grdn.specs.patients/edit-next-step-handler-spec
        description: 'origin spec: grdn.specs.patients/edit-next-step-handler-spec'
        schema:
          type: object
          properties:
            due-date:
              type: string
            visit-reason-id:
              type: integer
              format: int64
            in-person-only:
              type: boolean
            note:
              type: string
            send-date:
              type: string
            title:
              type: string
            type:
              type: string
            with-provider-id:
              type: string
              format: uuid
              allowEmptyValue: true
          title: grdn.specs.patients/edit-next-step-handler-spec
      responses:
        default:
          description: Default success response.
          schema: {}
  /v2/patient/{patient-id}/next-steps:
    get:
      summary: get-next-steps-handler
      description: Gets next steps for patient. Calls Athena for Quality Measures and upcoming Appts.
      tags:
      - grdn.routes.impl.next-step
      parameters:
      - in: path
        name: patient-id
        description: 'origin spec: '
        required: null
      responses:
        default:
          description: Default success response.
          schema: {}
  /v2/patient/{patient-id}/next-steps/{next-step-id}:
    post:
      summary: respond-next-step-handler
      description: Respond to a next step
      tags:
      - grdn.routes.impl.next-step
      parameters:
      - in: path
        name: patient-id
        description: 'origin spec: '
        required: null
      - in: path
        name: next-step-id
        description: 'origin spec: '
        required: null
      responses:
        default:
          description: Default success response.
          schema:
            type: object
            properties:
              next-step-id:
                type: string
                format: uuid
              reply-type:
                type: string
              decline-reason-type:
                type: string
              decline-detail:
                type: string
              resolved-month:
                type: string
              delete-reason-type:
                type: string
            required:
            - next-step-id
            title: grdn.specs.patients/respond-next-step-handler-response