# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Thehiveryiq Com Hipaa Hive API
  version: 1.0.0
extends: openapi/thehiveryiq-com-hipaa-hive-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/v1/hipaa-hive/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check HIPAA Hive service health
      effect: read
      questions:
      - Is the HIPAA Hive attestation service up?
      - Can I confirm HIPAA Hive is reachable before recording events?
      instructions:
      - text: Check HIPAA Hive health.
      - text: Tell me whether the HIPAA attestation service is healthy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hipaa-hive/pricing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get HIPAA Hive pricing
      effect: read
      questions:
      - What does HIPAA Hive charge for its attestations?
      - Where can I see pricing for PHI and breach receipts?
      instructions:
      - text: Show HIPAA Hive pricing.
      - text: Get the price list for HIPAA attestation receipts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hipaa-hive/baa_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest a Business Associate Agreement scope
      effect: write
      questions:
      - How do I record a signed BAA between a covered entity and a business associate?
      - Can a BAA attestation list the PHI categories and minimum-necessary scope it covers?
      instructions:
      - text: Attest a BAA between {covered_entity_did} and {business_associate_did} for {purpose_of_use}, scope {minimum_necessary_scope}.
        slots:
          covered_entity_did: requestBody.covered_entity_did
          business_associate_did: requestBody.business_associate_did
          purpose_of_use: requestBody.purpose_of_use
          minimum_necessary_scope: requestBody.minimum_necessary_scope
      - text: Record BAA {baa_reference_id} between {covered_entity_did} and {business_associate_did}, scope {minimum_necessary_scope}, purpose {purpose_of_use}.
        slots:
          baa_reference_id: requestBody.baa_reference_id
          covered_entity_did: requestBody.covered_entity_did
          business_associate_did: requestBody.business_associate_did
          minimum_necessary_scope: requestBody.minimum_necessary_scope
          purpose_of_use: requestBody.purpose_of_use
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hipaa-hive/phi_access_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a PHI access event
      effect: write
      questions:
      - How do I log that a system accessed a patient's protected health information?
      - Can a PHI access receipt reference a pseudonymous patient DID instead of real identifiers?
      instructions:
      - text: Record PHI access by {covered_entity_did} for {purpose_of_use} under scope {minimum_necessary_scope}.
        slots:
          covered_entity_did: requestBody.covered_entity_did
          purpose_of_use: requestBody.purpose_of_use
          minimum_necessary_scope: requestBody.minimum_necessary_scope
      - text: Attest that {covered_entity_did} accessed PHI for patient {patient_did_reference}, purpose {purpose_of_use}, scope {minimum_necessary_scope}.
        slots:
          covered_entity_did: requestBody.covered_entity_did
          patient_did_reference: requestBody.patient_did_reference
          purpose_of_use: requestBody.purpose_of_use
          minimum_necessary_scope: requestBody.minimum_necessary_scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hipaa-hive/phi_disclose_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a PHI disclosure to a recipient
      effect: write
      questions:
      - How do I attest that PHI was disclosed to an outside recipient?
      - Can a disclosure receipt name the recipient DID and the BAA it relied on?
      instructions:
      - text: Record a PHI disclosure from {covered_entity_did} to {recipient_did} for {purpose_of_use}, scope {minimum_necessary_scope}.
        slots:
          covered_entity_did: requestBody.covered_entity_did
          recipient_did: requestBody.recipient_did
          purpose_of_use: requestBody.purpose_of_use
          minimum_necessary_scope: requestBody.minimum_necessary_scope
      - text: Attest {covered_entity_did} disclosed PHI under BAA {baa_reference_id}, purpose {purpose_of_use}, scope {minimum_necessary_scope}.
        slots:
          covered_entity_did: requestBody.covered_entity_did
          baa_reference_id: requestBody.baa_reference_id
          purpose_of_use: requestBody.purpose_of_use
          minimum_necessary_scope: requestBody.minimum_necessary_scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hipaa-hive/minimum_necessary_check'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a HIPAA minimum-necessary check
      effect: write
      questions:
      - Can I check whether a requested set of fields meets the HIPAA minimum-necessary standard?
      - Is the minimum-necessary determination recorded as a receipt?
      instructions:
      - text: Run a minimum-necessary check for {covered_entity_did}, scope {minimum_necessary_scope}, purpose {purpose_of_use}.
        slots:
          covered_entity_did: requestBody.covered_entity_did
          minimum_necessary_scope: requestBody.minimum_necessary_scope
          purpose_of_use: requestBody.purpose_of_use
      - text: Check if fields {requested_fields} fit scope {minimum_necessary_scope} for {covered_entity_did}, purpose {purpose_of_use}.
        slots:
          requested_fields: requestBody.requested_fields
          minimum_necessary_scope: requestBody.minimum_necessary_scope
          covered_entity_did: requestBody.covered_entity_did
          purpose_of_use: requestBody.purpose_of_use
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hipaa-hive/ai_inference_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Attest an AI inference that touched PHI
      effect: write
      questions:
      - How do I record that an AI model ran inference over patient health data?
      - Can an AI inference receipt carry model DID and confidence metadata?
      instructions:
      - text: Attest an AI inference over PHI by {covered_entity_did}, scope {minimum_necessary_scope}, purpose {purpose_of_use}.
        slots:
          covered_entity_did: requestBody.covered_entity_did
          minimum_necessary_scope: requestBody.minimum_necessary_scope
          purpose_of_use: requestBody.purpose_of_use
      - text: Record an AI inference for {covered_entity_did} with model metadata {ai_inference_metadata}, scope {minimum_necessary_scope}, purpose {purpose_of_use}.
        slots:
          covered_entity_did: requestBody.covered_entity_did
          ai_inference_metadata: requestBody.ai_inference_metadata
          minimum_necessary_scope: requestBody.minimum_necessary_scope
          purpose_of_use: requestBody.purpose_of_use
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hipaa-hive/patient_access_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a patient-directed access event
      effect: write
      questions:
      - How do I log a 21st Century Cures patient-directed access request?
      - Can I attach a hash of the patient's authorization to a USCDI access receipt?
      instructions:
      - text: Record patient-directed access for {patient_did_reference} at {covered_entity_did}, scope {minimum_necessary_scope}.
        slots:
          patient_did_reference: requestBody.patient_did_reference
          covered_entity_did: requestBody.covered_entity_did
          minimum_necessary_scope: requestBody.minimum_necessary_scope
      - text: Attest Cures Act access by patient {patient_did_reference} to {covered_entity_did}, scope {minimum_necessary_scope}, authorization {authorization_hash}.
        slots:
          patient_did_reference: requestBody.patient_did_reference
          covered_entity_did: requestBody.covered_entity_did
          minimum_necessary_scope: requestBody.minimum_necessary_scope
          authorization_hash: requestBody.authorization_hash
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hipaa-hive/breach_assessment_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a four-factor HIPAA breach risk analysis
      effect: write
      questions:
      - How do I document the four-factor risk assessment after a possible HIPAA breach?
      - Can the breach analysis record a low-probability-of-compromise determination?
      instructions:
      - text: 'Log a breach risk assessment for {covered_entity_did}: PHI involved {factor_nature_and_extent}, received by {factor_unauthorized_person}.'
        slots:
          covered_entity_did: requestBody.covered_entity_did
          factor_nature_and_extent: requestBody.factor_nature_and_extent
          factor_unauthorized_person: requestBody.factor_unauthorized_person
      - text: Record for {covered_entity_did} whether PHI was viewed ({factor_acquisition_or_viewing}) and how risk was mitigated ({factor_mitigation}).
        slots:
          covered_entity_did: requestBody.covered_entity_did
          factor_acquisition_or_viewing: requestBody.factor_acquisition_or_viewing
          factor_mitigation: requestBody.factor_mitigation
      - text: 'Record a four-factor breach analysis for {covered_entity_did} concluding low probability of compromise: {low_probability_determination}.'
        slots:
          covered_entity_did: requestBody.covered_entity_did
          low_probability_determination: requestBody.low_probability_determination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hipaa-hive/breach_notice_attest'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a HIPAA breach notification
      effect: write
      questions:
      - How do I attest that breach notifications went out within the 60-day window?
      - Can a breach notice link back to the earlier breach assessment receipt?
      instructions:
      - text: Record a breach notice for {covered_entity_did} sent {days_since_discovery} days after discovery.
        slots:
          covered_entity_did: requestBody.covered_entity_did
          days_since_discovery: requestBody.days_since_discovery
      - text: Attest a {notification_type} breach notice by {covered_entity_did}, {days_since_discovery} days in, for assessment {breach_assessment_receipt_id}.
        slots:
          notification_type: requestBody.notification_type
          covered_entity_did: requestBody.covered_entity_did
          days_since_discovery: requestBody.days_since_discovery
          breach_assessment_receipt_id: requestBody.breach_assessment_receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hipaa-hive/chain_verify'].get
  update:
    x-apievangelist-phrasing:
      intent: Verify the HIPAA receipt chain
      effect: read
      questions:
      - Is the chain of HIPAA receipts for a covered entity intact and validly signed?
      - Can I verify every receipt tied to one pseudonymous patient?
      instructions:
      - text: Verify the HIPAA receipt chain for covered entity {covered_entity_did}.
        slots:
          covered_entity_did: query.covered_entity_did
      - text: Check signature validity of all HIPAA receipts for patient {patient_did_reference}.
        slots:
          patient_did_reference: query.patient_did_reference
      method: generated
      generated: '2026-09-26'