List visits

Visits created with this account’s keys, newest first. Scope visits:read.

GET /visits

List visits

cURL

curl --request GET \
  --url https://rxnote.ai/api/v1/visits \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "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": {}
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "has_more": true
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

patient_id · integer

status · enum<string>

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

page · integer · default: 1

Required range: x >= 1

limit · integer · default: 20

Required range: 1 <= x <= 100

Response

200

application/json

A page of visits.

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes