Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Partner Interaction API

4 actions 4 updates phrasing extends openapi/hint-health-partnerinteraction-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Hint Health's API. It is a proposal applied on top of the contract, not a document Hint Health publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/provider/patients/{patient_id}/interactions/partner'].post

$.paths['/provider/patients/{patient_id}/interactions/partner/{id}'].get

$.paths['/provider/patients/{patient_id}/interactions/partner/{id}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hint Health Partner Interaction API
  version: 1.0.0
extends: openapi/hint-health-partnerinteraction-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/provider/patients/{patient_id}/interactions/partner'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a partner interaction on a patient
      effect: write
      questions:
      - How do I log an event from my partner app on a patient's timeline?
      - Can I include a web link back to my system on a partner interaction?
      instructions:
      - text: Create a partner interaction titled {title} for patient {patient_id} with status {status}.
        slots:
          title: requestBody.title
          patient_id: path.patient_id
          status: requestBody.status
      - text: Log a {status} partner interaction on patient {patient_id} linking to {integration_web_link}.
        slots:
          status: requestBody.status
          patient_id: path.patient_id
          integration_web_link: requestBody.integration_web_link
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/interactions/partner/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a partner interaction on a patient
      effect: read
      questions:
      - Can I fetch a partner interaction I logged on a patient?
      - What status does a specific partner interaction have?
      instructions:
      - text: Show partner interaction {id} for patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      - text: Get patient {patient_id}'s partner interaction {id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/interactions/partner/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a partner interaction's status
      effect: write
      questions:
      - Is it possible to change the status of a partner interaction already logged?
      - Can I record a sync error on an existing partner interaction?
      instructions:
      - text: Set partner interaction {id} on patient {patient_id} to status {status}.
        slots:
          id: path.id
          patient_id: path.patient_id
          status: requestBody.status
      - text: Mark partner interaction {id} for patient {patient_id} as {status} with error {integration_error_message}.
        slots:
          id: path.id
          patient_id: path.patient_id
          status: requestBody.status
          integration_error_message: requestBody.integration_error_message
      method: generated
      generated: '2026-10-01'