Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Lab Interaction API

4 actions 4 updates phrasing extends openapi/hint-health-labinteraction-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/lab'].post

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

$.paths['/provider/patients/{patient_id}/interactions/lab/{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 Lab Interaction API
  version: 1.0.0
extends: openapi/hint-health-labinteraction-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/lab'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a lab order for a patient
      effect: write
      questions:
      - How do I push a lab order and its results into a patient's chart?
      - Can I attach a lab report when recording a lab interaction?
      instructions:
      - text: Create a lab interaction for patient {patient_id}.
        slots:
          patient_id: path.patient_id
      - text: Record lab order {vendor_order_id} for patient {patient_id} with status {status}.
        slots:
          vendor_order_id: requestBody.vendor_order_id
          patient_id: path.patient_id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/interactions/lab/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a patient's lab interaction
      effect: read
      questions:
      - What results came back on a specific lab order?
      - Can I view one lab interaction for a patient?
      instructions:
      - text: Show lab interaction {id} for patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      - text: Get the results of lab {id} on patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/interactions/lab/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a patient's lab interaction
      effect: write
      questions:
      - Can I add results to a lab order after it was created?
      - Is it possible to change the status of an existing lab interaction?
      instructions:
      - text: Set lab interaction {id} on patient {patient_id} to status {status}.
        slots:
          id: path.id
          patient_id: path.patient_id
          status: requestBody.status
      - text: Add results {results} to lab {id} for patient {patient_id}.
        slots:
          results: requestBody.results
          id: path.id
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'