Create a visit

Starts a consultation for a patient. With transcript, the note is written at once. With audio, the visit waits in recording and the response carries an upload URL: PUT the file there, then call process. Scope visits:write.

POST /visits

Create a visit

cURL

curl --request POST \
  --url https://rxnote.ai/api/v1/visits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "patient_id": 4821,
  "clinician_email": "[e-mail]",
  "language": "en",
  "template_id": 12,
  "outputs": [
    "transcript",
    "note"
  ],
  "transcript": "<string>"
}
'

201

{
  "id": 90211,
  "patient_id": 123,
  "status": "recording",
  "language": "<string>",
  "template_id": 123,
  "outputs": [
    "transcript"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "icd_codes": {
    "code_version": "icd11",
    "generated_at": "<string>",
    "codes": [
      {
        "code": "CA02",
        "name": "Acute pharyngitis",
        "confidence": "high"
      }
    ]
  },
  "error": {
    "code": "TRANSCRIPTION_FAILED",
    "message": "<string>"
  },
  "upload": {
    "url": "<string>",
    "method": "PUT",
    "headers": {
      "Content-Type": "audio/webm"
    },
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "transcript": {
    "text": "<string>",
    "duration_seconds": 123,
    "segments": [
      {
        "speaker": 123,
        "start_ms": 123,
        "end_ms": 123,
        "text": "<string>"
      }
    ]
  },
  "note": {
    "template": {
      "id": 123,
      "name": "<string>"
    },
    "framework": "soap",
    "sections": [
      {
        "id": "<string>",
        "title": "<string>",
        "fields": [
          {
            "id": "<string>",
            "label": "<string>",
            "text": "<string>"
          }
        ]
      }
    ],
    "html": "<string>"
  },
  "summary": {}
}

Authorizations

Authorization · string · header · required

Your API key, created in RxNote under Settings → API: Authorization: Bearer rxn_live_….

Headers

Idempotency-Key · string · required

Your unique id for this consultation (for example your appointment id). Retrying with the same key returns the same visit.

Required string length: 1 - 255

Example:

"appt-2026-10-21-0001"

Body

application/json

patient_id · integer · required

From POST /patients.

Example:

4821

clinician_email · string<email>

Required with an organization key: the RxNote member acting. With a personal key, omit it or send the owner's own email.

Maximum string length: 255

Example:

"[e-mail]"

language · string · default: en

Language of the consultation.

Required string length: 2 - 10

Example:

"en"

template_id · integer

A template from GET /templates. Omitted: the clinician's default template, as in the app.

Example:

12

outputs · enum<string>[]

What to produce. A note always needs the transcript, so note implies it.

Minimum array length: 1

Available options: transcript, note, summary

audio · object

Send this to upload a recording: the response carries a URL to PUT the file to.

Show child attributes

transcript · string

Send this instead of audio to write the note from text you already have. Processing starts at once.

Required string length: 1 - 500000

Response

201

application/json

The visit.

id · integer · required

Example:

90211

patient_id · integer · required

status · enum<string> · required

Available options: recording, pending, processing, transcribing, generating-soap, completed, failed, no-speech

language · string · required

template_id · integer | null · required

outputs · enum<string>[] · required

Available options: transcript, note, summary

created_at · string<date-time> · required

completed_at · string<date-time> | null · required

icd_codes · object | null · required

Set once POST /visits/{id}/icd-codes has run.

Show child attributes

error · object | null · required

Show child attributes

upload · object

Only while the status is recording (waiting for the audio).

Show child attributes

transcript · object | null

Omitted unless requested; null until ready.

Show child attributes

note · object | null

Omitted unless requested; null until ready.

Show child attributes

summary · object | null

Omitted unless requested; null until ready.

Show child attributes