Hint Health · Schema

Create_DocumentInteraction

Direct Primary CareDPCHealthcareMembership ManagementPatient EnrollmentMedical BillingEMRHealth Plans

Properties

Name Type Description
status string The status of the interaction.
title string The title of the interaction.
body string The body of the interaction. Markdown formatted.
attachments array The attachments of the interaction. Files will be downloaded as part of the request.
integration_record_id string
integration_error_message string
integration_web_link string
View JSON Schema on GitHub

JSON Schema

provider-patients-interactions-documentcontroller-create_body.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.hint.com/schemas/provider-patients-interactions-documentcontroller-create_body",
  "title": "Create_DocumentInteraction",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": " The status of the interaction.",
      "enum": [
        "draft",
        "signed",
        "addended",
        "deleted",
        "failed"
      ]
    },
    "title": {
      "type": "string",
      "description": "The title of the interaction."
    },
    "body": {
      "type": "string",
      "description": "The body of the interaction. Markdown formatted."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The attachments of the interaction. Files will be downloaded as part of the request."
    },
    "integration_record_id": {
      "type": "string"
    },
    "integration_error_message": {
      "type": "string"
    },
    "integration_web_link": {
      "type": "string"
    }
  },
  "required": [
    "status"
  ]
}