Generated by API Evangelist
Written by API Evangelist tooling for Elation Health's API. It is a proposal applied on top of the contract, not a document Elation Health publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Settings Referral Orders API
version: 1.0.0
extends: openapi/elation-health-referral-orders-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: 4
- target: $.paths['/referral_orders/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a referral order
effect: read
questions:
- Can I look up a referral order by id?
- What consultant and specialty is a referral going to?
instructions:
- text: Get referral order {id}.
slots:
id: path.id
- text: Show the consultant and authorization on referral {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/referral_orders/'].put
update:
x-apievangelist-phrasing:
intent: Replace a referral order
effect: write
questions:
- Can I overwrite a referral order in full, including the consultant?
- Which call resends every referral order field?
instructions:
- text: Replace the referral for patient {patient} in practice {practice} with consultant {consultant}.
slots:
patient: requestBody.patient
practice: requestBody.practice
consultant: requestBody.consultant_name
- text: Overwrite patient {patient}'s referral with authorization number {auth}.
slots:
patient: requestBody.patient
auth: requestBody.auth_number
method: generated
generated: '2026-09-26'
- target: $.paths['/referral_orders/'].post
update:
x-apievangelist-phrasing:
intent: Create a referral order
effect: write
questions:
- How do I refer a patient to a specialist?
- Can I include ICD-10 codes and a re-evaluation date on a new referral?
instructions:
- text: Refer patient {patient} in practice {practice} to {consultant} ({short}) for {reason}.
slots:
patient: requestBody.patient
practice: requestBody.practice
consultant: requestBody.consultant_name
short: requestBody.short_consultant_name
reason: requestBody.authorization_for
- text: Create a {specialty} referral for patient {patient} with ICD-10 codes {codes}.
slots:
specialty: requestBody.specialty
patient: requestBody.patient
codes: requestBody.icd10_codes
method: generated
generated: '2026-09-26'
- target: $.paths['/referral_orders/'].patch
update:
x-apievangelist-phrasing:
intent: Update part of a referral order
effect: write
questions:
- Can I just add a resolution to an existing referral order?
- How do I patch the re-evaluation date on a referral?
instructions:
- text: Patch patient {patient}'s referral with resolution {resolution}.
slots:
patient: requestBody.patient
resolution: requestBody.resolution
- text: Set the re-evaluation date on patient {patient}'s referral to {date}.
slots:
patient: requestBody.patient
date: requestBody.date_for_reEval
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.