Get a job

A note or ICD-code job: its status, and the note or codes once completed. Scope visits:read.

GET /jobs/{id}

Get a job

cURL

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

200

{
  "id": "job_4Rt8Vb1Np3Zs7Hc2kQ9xLm",
  "kind": "note",
  "visit_id": 123,
  "status": "queued",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "error": {
    "code": "NOTE_FAILED",
    "message": "<string>"
  },
  "note": {
    "id": 5521,
    "visit_id": 123,
    "template": {
      "id": 123,
      "name": "<string>"
    },
    "framework": "<string>",
    "sections": [
      {
        "id": "<string>",
        "title": "<string>",
        "fields": [
          {
            "id": "<string>",
            "label": "<string>",
            "text": "<string>"
          }
        ]
      }
    ],
    "html": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "icd_codes": {
    "code_version": "icd11",
    "generated_at": "<string>",
    "codes": [
      {
        "code": "CA02",
        "name": "Acute pharyngitis",
        "confidence": "high"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Example:

"job_4Rt8Vb1Np3Zs7Hc2kQ9xLm"

Response

200

application/json

The job.

Work that runs after the request answers. Poll GET /jobs/{id} until completed or failed.

id · string · required

Example:

"job_4Rt8Vb1Np3Zs7Hc2kQ9xLm"

kind · enum<string> · required

Available options: note, icd_codes

visit_id · integer · required

status · enum<string> · required

Available options: queued, running, completed, failed

created_at · string<date-time> · required

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

error · object | null · required

Show child attributes

note · object | null

For a note job, once completed.

Show child attributes

icd_codes · object | null

For an icd_codes job, once completed.

Show child attributes