---
title: "Create Form Interaction"
method: POST
path: "/provider/partner-invisible/patients/{patient_id}/interactions/form"
tags: ["FormInteraction"]
---

# Create Form Interaction

`POST /provider/partner-invisible/patients/{patient_id}/interactions/form`

## Request

- Base URL: `https://api.sandbox.hint.com/api`
- URL: `https://api.sandbox.hint.com/api/provider/partner-invisible/patients/{patient_id}/interactions/form`
- Auth: API key in header `AUTHORIZATION`

## Path parameters

- `patient_id` string, required

## Request body

- InteractionFormSanitizer
  - `form_id` string, required: Stable identifier for the form template, used to map questions to the health history. The same value should be sent every time this form is submitted.
  - `form_name` string, required: The name of the form that was completed.
  - `submission_data` InteractionFormSanitizerSubmissionDataSanitizer, required
    - `questions` InteractionFormSanitizerQuestionSanitizer[], required: The answered questions, in the order they should be displayed. At least one is required and their ids must be unique.
      - `id` string, required: Identifier for the question, unique within the submission.
      - `question_sub_type` 'ShortAnswer' | 'MultipleChoiceSingleSelection' | 'MultipleChoiceMultipleSelection', required: How the question was answered.
      - `text` string, required: The question as it was presented.
      - `answer` string: The answer to a ShortAnswer question. Required for ShortAnswer, rejected for the multiple choice sub types.
      - `answers` string[]: The selections for a multiple choice question. Required for the multiple choice sub types and rejected for ShortAnswer. MultipleChoiceSingleSelection accepts exactly one selection. Selections cannot contain commas.
      - `further_explanation` string: Free text elaborating on the answer.
    - `submitted_at` string, date-time: When the form was submitted. Defaults to event_timestamp.
  - `event_timestamp` string, date-time: When the form was completed. Defaults to the current time.
  - `files` InteractionFileSanitizer[]: The files to store with the form. They will be downloaded as part of the request. A bare URL string is also accepted in place of an object. When `filename` is omitted Hint infers one and rejects the request with a 422 if it cannot.
    - `url` string, required: An https URL to download, or a `data:` URI carrying the file inline.
    - `filename` string: The name to store the file under. When omitted it is taken from the response's Content-Disposition, then the URL's path, and any missing extension is derived from the file's contents. A file that cannot be named is rejected with a 422.
  - `integration_record_id` string
  - `integration_error_message` string
  - `integration_web_link` string

## Response `200`

Successful response

- PublicInteractionBlueprintOne
  - `id` string
  - `body` string
  - `created_at` string, date-time
  - `event_timestamp` string, date-time
  - `patient_access` boolean
  - `patient_id` string
  - `quantity` integer, nullable: Only returned for `rx` and `erx`. Historical order snapshot; unavailable values are null.
  - `refills` integer, nullable: Only returned for `rx` and `erx`. Historical order snapshot; unavailable values are null.
  - `rx_id` string, nullable: Only returned for `rx` and `erx`. Historical order snapshot; unavailable values are null.
  - `status` string
  - `title` string
  - `type` string
  - `updated_at` string, date-time
  - `vendor_order_id` string: Only returned when the interaction type is `lab`.
  - `files` PublicInteractionFileBlueprintLeaf[]
    - `id` string
    - `filename` string
    - `type` string
  - `medication` PublicPrescriptionMedicationBlueprintLeaf
    - `product_name` string, nullable
    - `ndc` string, nullable
    - `rx_norm` string, nullable
    - `strength` string, nullable
    - `strength_uom` string, nullable
    - `dosage_form` string, nullable
    - `sig_text` string, nullable
    - `start_date` string, date, nullable
  - `order` PublicInteractionLabOrderBlueprintLeaf
    - `lab_reference_id` string
    - `ordered_from` string
    - `authored_on` string
    - `collected_at` string
    - `author` string
    - `author_reference` string
    - `intent` string
    - `lab_account_id` string
    - `actions` PublicInteractionLabOrderActionBlueprintLeaf[]
      - `reference` string
      - `display` string
    - `subject` PublicInteractionLabOrderSubjectBlueprintLeaf
      - `reference` string
      - `display` string
  - `report` PublicInteractionLabReportBlueprintLeaf
    - `issued` string
    - `status` string
    - `lab_reference_id` string
    - `order_reference` string
  - `results` PublicInteractionLabResultBlueprintLeaf[]: Only returned when the interaction type is `lab`.
    - `id` string
    - `code_text` string
    - `issued` string
    - `value_string` string
    - `text` string
    - `interpretation` string[]
    - `subject` string
    - `code` PublicInteractionLabResultCodeBlueprintLeaf[]
      - `code` string
      - `display` string
    - `value_quantity` PublicInteractionLabResultQuantityBlueprintLeaf
      - `value` union
        - number, float
        - string
      - `unit` string
    - `ranges` PublicInteractionLabResultRangeBlueprintLeaf[]
      - `text` string
      - `low` PublicInteractionLabResultQuantityBlueprintLeaf
        - `value` union
          - number, float
          - string
        - `unit` string
      - `high` PublicInteractionLabResultQuantityBlueprintLeaf
        - `value` union
          - number, float
          - string
        - `unit` string

## Changes

- **2026-11-03** `c9bda0d2dd87`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hint/apis/partner-endpoints/changes/provider/partner-invisible/patients/:patient_id/interactions/form/post.md)

---

[API](https://skmtc.dev/hint/apis/partner-endpoints.md) - [All operations](https://skmtc.dev/hint/apis/partner-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/hint/apis/partner-endpoints/revisions/c9bda0d2dd87?raw)