ZnanyLekarz · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Docplanner Integrations Patient Presence API

3 actions 3 updates phrasing extends openapi/znanylekarz-patient-presence-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for ZnanyLekarz's API. It is a proposal applied on top of the contract, not a document ZnanyLekarz publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/presence/patient'].post
$.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/presence/patient'].delete

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Docplanner Integrations Patient Presence API
  version: 1.0.0
extends: openapi/znanylekarz-patient-presence-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: 2
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/presence/patient'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a patient as present at a visit
      effect: write
      questions:
      - How do I record that a patient showed up for their appointment?
      - Can I check a patient in for a booked visit?
      instructions:
      - text: Mark the patient as present for booking {booking} at address {address} of doctor {doctor} in facility {facility}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          booking: path.booking_id
      - text: Check in the patient for booking {booking}.
        slots:
          booking: path.booking_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/presence/patient'].delete
  update:
    x-apievangelist-phrasing:
      intent: Mark a patient as a no-show
      effect: destructive
      questions:
      - How do I record that a patient didn't turn up for their visit?
      - Can I flag a booking as a no-show?
      instructions:
      - text: Record that the patient did not attend booking {booking} with doctor {doctor} at facility {facility}, address {address}.
        slots:
          facility: path.facility_id
          doctor: path.doctor_id
          address: path.address_id
          booking: path.booking_id
      - text: Record booking {booking} as a no-show.
        slots:
          booking: path.booking_id
      method: generated
      generated: '2026-10-01'