@emulates/caretalk 0.0.0-stage → 2.3.1

package/openapi.yaml

@@ -0,0 +1,1191 @@
+openapi: 3.1.0
+info:
+  title: CareTalk external API (Emulates subset)
+  description: 'Stateful mock subset of CareTalk''s `/externalapi`: client login, form definitions (GetForm),
+    saving patient forms, patient search and insert, states, free slots and appointments. Hand-authored
+    from the consumer (caretalk-client.service.ts, caretalk.types.ts, caretalk-forms.type.ts); the vendor
+    publishes no spec.
+
+    '
+  version: '1'
+  x-emulates-upstream:
+    note: Wire shapes from apps/backend/src/modules/global-services/services/caretalk/*.ts (zod schemas
+      and interfaces).
+servers:
+- url: https://api.caretalkbeta.com
+security:
+- bearerAuth: []
+paths:
+  /externalapi/Auth/client-login:
+    post:
+      operationId: ClientLogin
+      description: Exchange the API user's credentials for a bearer token.
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        '200':
+          description: Token
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AuthResponse'
+        '400': &id001
+          description: Validation failed (ASP.NET ProblemDetails)
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemDetails'
+        '401':
+          description: Bad credentials
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Message'
+      security: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/LoginBody'
+  /externalapi/Forms/GetForm/{formName}:
+    get:
+      operationId: GetForm
+      description: A form definition by name or slug (an unknown form is an empty list). With AppointmentId
+        / PatientId, the patient's latest saved round of it.
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        '200':
+          description: Matching forms
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/CareTalkForm'
+        '401': &id002
+          description: 'Missing, unknown or expired bearer token (empty body, WWW-Authenticate: Bearer)'
+      parameters:
+      - name: formName
+        in: path
+        required: true
+        schema:
+          type: string
+          enum:
+          - Health History
+          - health-history
+          - AOE Questions
+          - aoe-questions
+          - unknown-form
+      - name: AppointmentId
+        in: query
+        required: false
+        schema:
+          type: integer
+          minimum: 0
+          maximum: 5
+      - name: PatientId
+        in: query
+        required: false
+        schema:
+          type: integer
+          minimum: 0
+          maximum: 5
+  /externalapi/Forms/SavePatientForm:
+    post:
+      operationId: SavePatientForm
+      description: Save a patient's answers to a form (the form-submission queue's call).
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      responses:
+        '200':
+          description: Saved
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SaveResult'
+        '400': *id001
+        '404':
+          description: Unknown patient or form
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemDetails'
+        '401': *id002
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/FormSubmission'
+      parameters:
+      - name: patientId
+        in: query
+        required: true
+        schema:
+          type: integer
+          minimum: 1
+          maximum: 5
+      - name: patientAppointmentId
+        in: query
+        required: false
+        schema:
+          type: integer
+          minimum: 1
+          maximum: 5
+  /externalapi/Patients/SearchForPatient:
+    get:
+      operationId: SearchForPatient
+      description: Find a patient by name, ZIP and date of birth (any of YYYY-MM-DD, MM/DD/YYYY or ISO).
+        Not found is a 400.
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        '200':
+          description: Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SearchResult'
+        '400':
+          description: Not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SearchMiss'
+        '401': *id002
+      parameters:
+      - name: FirstName
+        in: query
+        required: true
+        schema:
+          type: string
+          enum:
+          - Ada
+          - Grace
+      - name: LastName
+        in: query
+        required: true
+        schema:
+          type: string
+          enum:
+          - Lovelace
+          - Hopper
+      - name: zipCode
+        in: query
+        required: true
+        schema:
+          type: string
+          enum:
+          - '84101'
+          - '10001'
+      - name: DateOfBirth
+        in: query
+        required: true
+        schema:
+          type: string
+          enum:
+          - '1985-12-10'
+          - 12/10/1985
+          - '1990-01-02'
+  /externalapi/States:
+    get:
+      operationId: ListStates
+      description: Every US state CareTalk licenses in.
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        '200':
+          description: States
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/State'
+        '401': *id002
+  /externalapi/Patients:
+    post:
+      operationId: InsertPatient
+      description: Create a patient (the account backfill).
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      responses:
+        '200':
+          description: The patient
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Patient'
+        '400': *id001
+        '401': *id002
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PatientBody'
+  /externalapi/PatientAppointments/GetFreeSlots:
+    get:
+      operationId: GetFreeSlots
+      description: Open slots on a date.
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        '200':
+          description: Slots
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/FreeSlot'
+        '400': *id001
+        '401': *id002
+      parameters:
+      - name: date
+        in: query
+        required: true
+        schema:
+          type: string
+          enum:
+          - '2026-10-05'
+          - '2026-10-06'
+      - name: programId
+        in: query
+        required: true
+        schema:
+          type: integer
+          enum:
+          - 21
+      - name: eligibleId
+        in: query
+        required: true
+        schema:
+          type: integer
+          minimum: 1
+          maximum: 5
+  /externalapi/PatientAppointments:
+    post:
+      operationId: ScheduleAppointment
+      description: Book a slot for an eligible patient.
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      responses:
+        '200':
+          description: Booked
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ScheduledAppointment'
+        '400': *id001
+        '401': *id002
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ScheduleBody'
+  /externalapi/PatientAppointments/GetPatientAppointmentsByEligibleId/{eligibleId}:
+    get:
+      operationId: GetPatientAppointments
+      description: A patient's appointments.
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        '200':
+          description: Appointments
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Appointment'
+        '401': *id002
+      parameters:
+      - name: eligibleId
+        in: path
+        required: true
+        schema:
+          type: integer
+          minimum: 1
+          maximum: 5
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+  schemas:
+    LoginBody:
+      type: object
+      required:
+      - userName
+      - password
+      properties:
+        userName:
+          type: string
+          minLength: 1
+          maxLength: 64
+        password:
+          type: string
+          minLength: 1
+          maxLength: 64
+    AuthResponse:
+      type: object
+      required:
+      - token
+      properties:
+        token:
+          type: string
+          x-emulates-volatile:
+            kind: token
+        expiration: &id003
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+    Message:
+      type: object
+      required:
+      - message
+      properties:
+        message:
+          type: string
+    ProblemDetails:
+      type: object
+      required:
+      - title
+      - status
+      properties:
+        type:
+          type: string
+        title:
+          type: string
+        status:
+          type: integer
+        errors:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              type: string
+        traceId:
+          type: string
+          x-emulates-volatile:
+            kind: opaque
+    QuestionAnswer:
+      type: object
+      required:
+      - id
+      - answer
+      - questionId
+      - isChecked
+      - createdAt
+      properties:
+        id:
+          type: integer
+        answer:
+          type: string
+        freeAnswerText:
+          type:
+          - string
+          - 'null'
+        questionId:
+          type: integer
+        complexity:
+          type:
+          - integer
+          - 'null'
+        isChecked:
+          type: boolean
+        updatedAt:
+          type:
+          - string
+          - 'null'
+        createdAt:
+          type: string
+        deletedAt:
+          type:
+          - string
+          - 'null'
+        description:
+          type:
+          - string
+          - 'null'
+    Question:
+      type: object
+      required:
+      - id
+      - questionText
+      - groupId
+      - answerTypeId
+      - questionAnswers
+      properties:
+        id:
+          type: integer
+        questionText:
+          type: string
+        groupId:
+          type: integer
+        sectionId:
+          type:
+          - integer
+          - 'null'
+        answerTypeId:
+          type: integer
+          enum:
+          - 1
+          - 2
+          - 3
+          - 4
+          - 5
+        alignment:
+          type:
+          - integer
+          - 'null'
+        answerText:
+          type:
+          - string
+          - 'null'
+        answerComplexity:
+          type: integer
+        questionOrder:
+          type:
+          - integer
+          - 'null'
+        isMainQuestion:
+          type: boolean
+        isTrueFalseQuestion:
+          type:
+          - boolean
+          - 'null'
+        updatedAt:
+          type: string
+        createdAt:
+          type: string
+        deletedAt:
+          type:
+          - string
+          - 'null'
+        tfValue:
+          type:
+          - boolean
+          - 'null'
+        caption:
+          type:
+          - string
+          - 'null'
+        questionAnswers:
+          type: array
+          items:
+            $ref: '#/components/schemas/QuestionAnswer'
+    FormGroup:
+      type: object
+      required:
+      - id
+      - name
+      - formId
+      - groupQuestions
+      - subGroups
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+        formId:
+          type: integer
+        parentGroupId:
+          type:
+          - integer
+          - 'null'
+        updatedAt:
+          type:
+          - string
+          - 'null'
+        createdAt:
+          type: string
+        deletedAt:
+          type:
+          - string
+          - 'null'
+        description:
+          type:
+          - string
+          - 'null'
+        caption:
+          type:
+          - string
+          - 'null'
+        groupQuestions:
+          type: array
+          items:
+            type: object
+            required:
+            - questionId
+            - groupId
+            - question
+            properties:
+              questionId:
+                type: integer
+              groupId:
+                type: integer
+              question:
+                $ref: '#/components/schemas/Question'
+              questionOrder:
+                type:
+                - integer
+                - 'null'
+        mainQuestion:
+          type:
+          - object
+          - 'null'
+        subGroups:
+          type: array
+          items:
+            type: object
+    CareTalkForm:
+      type: object
+      required:
+      - formRoundId
+      - patientAppointmentId
+      - submitDate
+      - fullFormDto
+      properties:
+        formRoundId:
+          type: integer
+        patientAppointmentId:
+          type:
+          - integer
+          - 'null'
+        submitDate: &id004
+          type:
+          - string
+          - 'null'
+          x-emulates-volatile:
+            kind: timestamp
+        fullFormDto:
+          type: object
+          required:
+          - id
+          - name
+          - isAllowMultible
+          - slug
+          - groups
+          properties:
+            id:
+              type: integer
+            name:
+              type: string
+            isAllowMultible:
+              type: boolean
+            slug:
+              type: string
+            description:
+              type:
+              - string
+              - 'null'
+            updatedAt:
+              type: string
+            createdAt:
+              type: string
+            deletedAt:
+              type:
+              - string
+              - 'null'
+            groups:
+              type: array
+              items:
+                $ref: '#/components/schemas/FormGroup'
+    FormSubmission:
+      type: object
+      required:
+      - fullFormDto
+      properties:
+        fullFormDto:
+          type: object
+          required:
+          - id
+          - name
+          - groups
+          properties:
+            id:
+              type: integer
+              minimum: 1
+              examples:
+              - 101
+              - 102
+            name:
+              type: string
+              minLength: 1
+              maxLength: 80
+            groups:
+              type: array
+              maxItems: 2
+              items:
+                type: object
+                required:
+                - groupQuestions
+                properties:
+                  groupQuestions:
+                    type: array
+                    maxItems: 3
+                    items:
+                      type: object
+                      required:
+                      - questionId
+                      - question
+                      properties:
+                        questionId:
+                          type: integer
+                          minimum: 0
+                          examples:
+                          - 1001
+                          - 1002
+                          - 1003
+                          - 1101
+                        question:
+                          type: object
+                          required:
+                          - id
+                          - questionAnswers
+                          properties:
+                            id:
+                              type: integer
+                              minimum: 0
+                              examples:
+                              - 1001
+                              - 1002
+                              - 1003
+                              - 1101
+                            questionAnswers:
+                              type: array
+                              maxItems: 2
+                              items:
+                                type: object
+                                required:
+                                - id
+                                - answer
+                                properties:
+                                  id:
+                                    type: integer
+                                    minimum: 0
+                                    examples:
+                                    - 0
+                                    - 5001
+                                    - 5002
+                                    - 5003
+                                    - 5101
+                                  answer:
+                                    type: string
+                                    minLength: 1
+                                    maxLength: 40
+                                  freeAnswerText:
+                                    type: string
+                                    maxLength: 200
+    SaveResult:
+      type: object
+      required:
+      - success
+      properties:
+        success:
+          type: boolean
+        message:
+          type: string
+    SearchResult:
+      type: object
+      required:
+      - isExists
+      - eligibleId
+      - programId
+      properties:
+        isExists:
+          type: boolean
+        eligibleId:
+          type: integer
+        programId:
+          type: integer
+    SearchMiss:
+      type: object
+      required:
+      - isExists
+      - message
+      properties:
+        isExists:
+          type: boolean
+        message:
+          type: string
+    State:
+      type: object
+      required:
+      - id
+      - stateUid
+      - name
+      - abbreviation
+      properties:
+        id:
+          type: integer
+        stateUid:
+          type: string
+        name:
+          type: string
+        abbreviation:
+          type: string
+        physiciansStateLicenseds:
+          type: array
+        users:
+          type: array
+        stateLocationCapabilities:
+          type: array
+    PatientBody:
+      type: object
+      required:
+      - dateOfBirth
+      - programId
+      - recordStatus
+      - recordId
+      - height
+      - weight
+      - highBloodPressure
+      - lowBloodPressure
+      - dateFinalized
+      - tokenDate
+      properties:
+        firstName:
+          type: string
+          examples:
+          - Ada
+          - Grace
+          maxLength: 80
+        lastName:
+          type: string
+          examples:
+          - Lovelace
+          - Hopper
+          maxLength: 80
+        mobilePhone:
+          type: string
+          maxLength: 20
+        email:
+          type: string
+          maxLength: 80
+        dateOfBirth:
+          type: string
+          examples:
+          - '1985-12-10T00:00:00.000Z'
+          - '1990-01-02T00:00:00.000Z'
+          maxLength: 80
+        gender:
+          type: integer
+          examples:
+          - 0
+          - 1
+          - 2
+        address:
+          type: string
+          maxLength: 80
+        state:
+          type: string
+          examples:
+          - UT
+          - NY
+          maxLength: 80
+        city:
+          type: string
+          maxLength: 40
+        userStateId:
+          type: integer
+          minimum: 1
+          maximum: 51
+        programId:
+          type: integer
+          examples:
+          - 21
+        zipCode:
+          type: string
+          examples:
+          - '84101'
+          - '10001'
+          maxLength: 80
+        height:
+          type: number
+          minimum: 0
+          maximum: 100
+        weight:
+          type: number
+          minimum: 0
+          maximum: 500
+        highBloodPressure:
+          type: number
+          minimum: 0
+          maximum: 250
+        lowBloodPressure:
+          type: number
+          minimum: 0
+          maximum: 200
+        recordStatus:
+          type: string
+          examples:
+          - Active
+          - Finalized
+          maxLength: 80
+        recordId:
+          type: string
+          examples:
+          - GV-001
+          - GV-1234
+          maxLength: 20
+        dateFinalized:
+          type: string
+          examples:
+          - '2026-09-20T00:00:00.000Z'
+          maxLength: 80
+        tokenDate:
+          type: string
+          examples:
+          - '2026-09-20T00:00:00.000Z'
+          maxLength: 80
+    Patient:
+      type: object
+      required:
+      - id
+      - programId
+      - recordStatus
+      - clientId
+      - createdAt
+      properties:
+        id:
+          type: integer
+        firstName:
+          type:
+          - string
+          - 'null'
+        middleInitial:
+          type:
+          - string
+          - 'null'
+        lastName:
+          type:
+          - string
+          - 'null'
+        mobilePhone:
+          type:
+          - string
+          - 'null'
+        homePhone:
+          type:
+          - string
+          - 'null'
+        token:
+          type:
+          - string
+          - 'null'
+        tokenDate:
+          type:
+          - string
+          - 'null'
+        apptStatus:
+          type:
+          - string
+          - 'null'
+        email:
+          type:
+          - string
+          - 'null'
+        dateOfBirth:
+          type:
+          - string
+          - 'null'
+        gender:
+          type:
+          - integer
+          - 'null'
+        address:
+          type:
+          - string
+          - 'null'
+        state:
+          type:
+          - string
+          - 'null'
+        city:
+          type:
+          - string
+          - 'null'
+        userStateId:
+          type:
+          - integer
+          - 'null'
+        userState:
+          type:
+          - string
+          - 'null'
+        zipCode:
+          type:
+          - string
+          - 'null'
+        recordStatus:
+          type: string
+        clientStatus:
+          type:
+          - string
+          - 'null'
+        clientBatchId:
+          type:
+          - string
+          - 'null'
+        authorization:
+          type:
+          - boolean
+          - 'null'
+        mbi:
+          type:
+          - string
+          - 'null'
+        ssn:
+          type:
+          - string
+          - 'null'
+        mspPatientId:
+          type:
+          - string
+          - 'null'
+        recordId:
+          type:
+          - string
+          - 'null'
+        height:
+          type:
+          - number
+          - 'null'
+        weight:
+          type:
+          - number
+          - 'null'
+        highBloodPressure:
+          type:
+          - number
+          - 'null'
+        lowBloodPressure:
+          type:
+          - number
+          - 'null'
+        dateFinalized:
+          type:
+          - string
+          - 'null'
+        programId:
+          type: integer
+        eligibilityId:
+          type:
+          - integer
+          - 'null'
+        clientId:
+          type: integer
+        fileId:
+          type:
+          - integer
+          - 'null'
+        oldId:
+          type:
+          - integer
+          - 'null'
+        formattedUserMobile:
+          type:
+          - string
+          - 'null'
+        planName:
+          type:
+          - string
+          - 'null'
+        healthGorillaId:
+          type:
+          - string
+          - 'null'
+        hG_P360_Retrieve_location:
+          type:
+          - string
+          - 'null'
+        hG_P360_Retrieve_Status:
+          type:
+          - string
+          - 'null'
+        hG_P360_Retrieve_json:
+          type:
+          - string
+          - 'null'
+        program:
+          type:
+          - string
+          - 'null'
+        client:
+          type:
+          - string
+          - 'null'
+        patientMedications:
+          type:
+          - array
+          - 'null'
+        patientDiagnostics:
+          type:
+          - array
+          - 'null'
+        patientAppointments:
+          type:
+          - array
+          - 'null'
+        patientAppointment: {}
+        formRounds:
+          type:
+          - array
+          - 'null'
+        createdAt: *id003
+        updatedAt: *id004
+        deletedAt:
+          type:
+          - string
+          - 'null'
+    FreeSlot:
+      type: object
+      required:
+      - id
+      - doctorId
+      - doctorName
+      - timeZone
+      - from
+      - to
+      properties:
+        id:
+          type: integer
+        medicalSpecialty:
+          type:
+          - string
+          - 'null'
+        doctorId:
+          type: integer
+        doctorName:
+          type: string
+        doctor:
+          type:
+          - string
+          - 'null'
+        doctorUid:
+          type:
+          - integer
+          - 'null'
+        timeZone:
+          type: string
+        offset:
+          type:
+          - number
+          - 'null'
+        from:
+          type: string
+        to:
+          type: string
+    ScheduleBody:
+      type: object
+      required:
+      - doctorId
+      - patientId
+      - from
+      - to
+      properties:
+        doctorId:
+          type: integer
+          minimum: 1
+          examples:
+          - 7
+          - 8
+        patientId:
+          type: integer
+          minimum: 1
+          maximum: 5
+        from:
+          type: string
+          examples:
+          - '2026-10-05T09:00:00'
+          - '2026-10-05T10:00:00'
+          maxLength: 40
+          minLength: 10
+        to:
+          type: string
+          examples:
+          - '2026-10-05T09:30:00'
+          - '2026-10-05T10:30:00'
+          maxLength: 40
+          minLength: 10
+    ScheduledAppointment:
+      type: object
+      required:
+      - id
+      - patientId
+      - eligibilityId
+      - appointmentStatus
+      - physicianId
+      properties:
+        id:
+          type: integer
+        patientId:
+          type: 'null'
+        eligibilityId:
+          type: integer
+        appointmentStatus:
+          type: integer
+        physicianId:
+          type: integer
+    Appointment:
+      type: object
+      required:
+      - id
+      - patientId
+      - eligibilityId
+      - createdAt
+      - appointmentStatus
+      - physicianId
+      - startDateTime
+      - endDateTime
+      properties:
+        id:
+          type: integer
+        patientId:
+          type:
+          - integer
+          - 'null'
+        eligibilityId:
+          type: integer
+        createdAt: *id003
+        appointmentStatus:
+          type: integer
+        physicianId:
+          type: integer
+        startDateTime:
+          type: string
+        endDateTime:
+          type: string