Hint Health DocumentInteraction API
The DocumentInteraction API from Hint Health — 2 operation(s) for documentinteraction.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/hint-health-documentinteraction-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Hint Health Document Interaction API
license:
name: Private
termsOfService: https://www.hint.com/terms
x-refined-note:
- x-api-evangelist-harvest differs across the merged source definitions and was not carried
version: '1.0'
description: 'Operations tagged DocumentInteraction across 2 of this provider''s published API definitions: hint-health-hint-health-api-openapi.yml, hint-health-partner-endpoints-2026-07-01-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.hint.com/api
description: Production
- url: https://api.sandbox.hint.com/api
description: Sandbox
tags:
- name: DocumentInteraction
paths:
/provider/patients/{patient_id}/interactions/document:
post:
tags:
- DocumentInteraction
operationId: DocumentInteraction.CreateDocumentInteraction
summary: Create Document Interaction
description: ''
parameters:
- name: patient_id
in: path
required: true
description: Unique Patient ID
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Public.InteractionBlueprint_one'
example:
id: inter-ab12C345DeF6
body: This is a test body
patient_id: pat-123456
status: draft
title: 'Lab #123456'
type: partner
integration_error_message: null
integration_last_synced_at: null
integration_record_id: null
integration_sync_status: enabled
integration_web_link: null
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Provider.Patients.Interactions.DocumentController.create_body'
security:
- BearerAuth: []
servers:
- url: https://api.hint.com/api
description: Production
- url: https://api.sandbox.hint.com/api
description: Sandbox
/provider/patients/{patient_id}/interactions/document/{id}:
get:
tags:
- DocumentInteraction
operationId: DocumentInteraction.ShowDocumentInteraction
summary: Show Document Interaction
description: ''
parameters:
- name: patient_id
in: path
required: true
description: Unique Patient ID
schema:
type: string
- name: id
in: path
required: true
description: Unique Document Interaction ID
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Public.InteractionBlueprint_one'
example:
id: inter-ab12C345DeF6
body: This is a test body
patient_id: pat-123456
status: draft
title: 'Lab #123456'
type: partner
integration_error_message: null
integration_last_synced_at: null
integration_record_id: null
integration_sync_status: enabled
integration_web_link: null
security:
- BearerAuth: []
patch:
tags:
- DocumentInteraction
operationId: DocumentInteraction.UpdateDocumentInteraction
summary: Update Interaction
description: ''
parameters:
- name: patient_id
in: path
required: true
description: Unique Patient ID
schema:
type: string
- name: id
in: path
required: true
description: Unique Document Interaction ID
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Public.InteractionBlueprint_one'
example:
id: inter-ab12C345DeF6
body: This is a test body
patient_id: pat-123456
status: draft
title: 'Lab #123456'
type: partner
integration_error_message: null
integration_last_synced_at: null
integration_record_id: null
integration_sync_status: enabled
integration_web_link: null
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Provider.Patients.Interactions.DocumentController.update_body'
security:
- BearerAuth: []
servers:
- url: https://api.hint.com/api
description: Production
- url: https://api.sandbox.hint.com/api
description: Sandbox
components:
schemas:
Public.InteractionBlueprint_one:
type: object
properties:
id:
type: string
body:
type: string
patient_id:
type: string
status:
type: string
title:
type: string
type:
type: string
Provider.Patients.Interactions.DocumentController.update_body:
title: Update_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.
attachments:
type: array
items:
type: string
description: The attachments of the interaction. Files will be downloaded as part of the request. If provided it will OVERRIDE the attachments on the interaction so make sure to provide all the attachments if you want to keep them.
integration_record_id:
type: string
integration_error_message:
type: string
integration_web_link:
type: string
required:
- status
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
Public.InteractionBlueprint_one_2:
type: object
properties:
id:
type: string
body:
type: string
event_timestamp:
type: string
format: date-time
patient_access:
type: boolean
patient_id:
type: string
status:
type: string
title:
type: string
type:
type: string
files:
type: array
items:
$ref: '#/components/schemas/Public.Interaction.FileBlueprint_leaf'
Provider.Patients.Interactions.DocumentController.update_body_2:
title: Update_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.
files:
type: array
items:
type: string
description: The files to attach to the interaction. They will be downloaded as part of the request. If provided it will OVERRIDE the files on the interaction, so include all the files you want to keep.
event_timestamp:
type: string
format: date-time
description: The event timestamp of the interaction.
integration_record_id:
type: string
integration_error_message:
type: string
integration_web_link:
type: string
required:
- status
Provider.Patients.Interactions.DocumentController.create_body_2:
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.
files:
type: array
items:
type: string
description: The files to attach to the interaction. They will be downloaded as part of the request.
event_timestamp:
type: string
format: date-time
description: The event timestamp of the interaction.
integration_record_id:
type: string
integration_error_message:
type: string
integration_web_link:
type: string
required:
- status
Public.Interaction.FileBlueprint_leaf:
type: object
properties:
id:
type: string
filename:
type: string
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: Practice access token or Partner API key (Bearer authentication)
hint_api_key:
type: apiKey
name: AUTHORIZATION
in: header
description: 'Enter your token in the format: `Bearer {your_api_key}`'
x-refined-from:
- hint-health-hint-health-api-openapi.yml
- hint-health-partner-endpoints-2026-07-01-openapi.yml