Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hint Health ClinicalNoteInteraction API

The ClinicalNoteInteraction API from Hint Health — 2 operation(s) for clinicalnoteinteraction.

Hint Health ClinicalNoteInteraction API is one of 49 APIs that Hint Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ClinicalNoteInteraction. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.hint.com/api, https://api.sandbox.hint.com/api.

3 operations 2 paths 2 schemas 1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.hint.com
Authentication
HTTP Bearer
License
Private
Terms of Service
Resource Areas
1

Authentication & Security 1

Hint Health ClinicalNoteInteraction API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Practice access token or Partner API key (Bearer authentication)

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

ClinicalNoteInteraction 3
POST
/provider/patients/{patient_id}/interactions/clinical_note
Create Clinical Note Interaction
ClinicalNoteInteraction.CreateClinicalNoteInteraction 1 param body → 200
GET
/provider/patients/{patient_id}/interactions/clinical_note/{id}
Show Clinical Note Interaction
ClinicalNoteInteraction.ShowClinicalNoteInteraction 2 params → 200
PATCH
/provider/patients/{patient_id}/interactions/clinical_note/{id}
Update Clinical Note Interaction
ClinicalNoteInteraction.UpdateClinicalNoteInteraction 2 params body → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Public.Interaction.ClinicalNoteBlueprint_one (11 properties), Interaction.ClinicalNoteSanitizer (10 properties). Each schema is shown below with its type and property counts.

Public.Interaction.ClinicalNoteBlueprint_one
object
11 properties
Interaction.ClinicalNoteSanitizer
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hint-health-clinicalnoteinteraction-api-openapi.yml Raw ↑

Other APIs Hint Health publishes across the network.

Hint Health AccountAccessToken API
Hint Health Affiliate API
Hint Health AffiliateBill API
Hint Health AffiliatePatient API
Hint Health CancellationReason API
Hint Health Charge API
Hint Health ChargeItem API
Hint Health Company API
Hint Health CompanyPlan API
Hint Health Coupon API
Hint Health Credit API
Hint Health CreditCategory API