Skip to main content
A visit is one consultation with a patient — the same record the app creates when a clinician records. You create it with a transcript or a recording; RxNote transcribes the recording, writes the note and, if asked, a summary.

​
Statuses

The status is the visit’s processing status exactly as the app shows it. Most notes complete within one to three minutes.

​
Idempotency

POST /visits requires an Idempotency-Key header — your own unique id for the consultation, such as your appointment id. Sending the same key and body again returns the same visit instead of creating a second one, so retrying after a timeout or a 5xx is always safe. The same key with a different body fails with 409 IDEMPOTENCY_CONFLICT.

​
Outputs

outputs chooses what to produce: any of transcript, note, summary. The default is ["transcript", "note"]. Send ["transcript"] for transcription only. Fields you did not ask for are left out of the response; fields not ready yet are null.

​
Clinicians

With a personal key, the visit is the key owner’s. With an organization key, clinician_email is required and must belong to a member of the organization. Either way the note uses that clinician’s templates and preferences, and the visit appears in their RxNote patient list.

​
Templates

GET /templates returns the templates the clinician can pick in the app. Pass template_id to choose one; without it, the clinician’s default template is used.

​
The note

Sections and fields come in template order. Their ids are stable even if a label is renamed, so map fields into your system by id. Use html to show the note as written. If the clinician edits the note in RxNote, GET /visits/{id} returns the edited note. To rewrite the note, write more notes from the visit (a progress note, a letter) or draw its ICD codes, see Notes and codes.