Get an asynchronous suggested orders generation
GET/generate-suggested-orders-async/:id
Poll the status — and results if successful — of an asynchronous suggested orders generation.
Request
Responses
- 200
The asynchronous suggested orders generation details.
Operation spec
{
"method": "get",
"path": "/generate-suggested-orders-async/{id}",
"operationId": "get-generate-suggested-orders-async",
"parameters": [
{
"name": "id",
"description": "The id of the asynchronous request.",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "A unique identifier.",
"example": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"title": "uuid"
},
"example": "23A9981B-9E46-4ADB-BB0B-8E406C624540"
}
],
"responses": {
"200": {
"description": "The asynchronous suggested orders generation details.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"title": "ONGOING",
"type": "object",
"properties": {
"id": {
"description": "The id of the asynchronous request.",
"type": "string",
"format": "uuid",
"example": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"title": "uuid"
},
"client_request_id": {
"type": "string",
"maxLength": 128,
"description": "An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.\n\n_Note_: this id must be different for every request. It is recommended to use a randomly generated UUID.",
"title": "client_request_id"
},
"status": {
"type": "string",
"enum": [
"ONGOING",
"FAILED",
"SUCCEEDED"
],
"title": "async_request_status"
}
},
"required": [
"id",
"status"
]
},
{
"title": "FAILED",
"type": "object",
"properties": {
"id": {
"description": "The id of the asynchronous request.",
"type": "string",
"format": "uuid",
"example": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"title": "uuid"
},
"client_request_id": {
"type": "string",
"maxLength": 128,
"description": "An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.\n\n_Note_: this id must be different for every request. It is recommended to use a randomly generated UUID.",
"title": "client_request_id"
},
"status": {
"type": "string",
"enum": [
"ONGOING",
"FAILED",
"SUCCEEDED"
],
"title": "async_request_status"
},
"payload": {
"type": "object",
"properties": {
"error_code": {
"type": "integer",
"example": 422
},
"error_message": {
"type": "string",
"example": "We can't generate the note when the transcript is too short."
}
},
"required": [
"error_code"
],
"title": "async_request_failed_payload"
}
},
"required": [
"id",
"status",
"payload"
]
},
{
"title": "SUCCEEDED",
"type": "object",
"properties": {
"id": {
"description": "The id of the asynchronous request.",
"type": "string",
"format": "uuid",
"example": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"title": "uuid"
},
"client_request_id": {
"type": "string",
"maxLength": 128,
"description": "An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.\n\n_Note_: this id must be different for every request. It is recommended to use a randomly generated UUID.",
"title": "client_request_id"
},
"status": {
"type": "string",
"enum": [
"ONGOING",
"FAILED",
"SUCCEEDED"
],
"title": "async_request_status"
},
"payload": {
"type": "object",
"description": "The orders suggested from the clinical note.",
"properties": {
"orders": {
"type": "array",
"description": "The suggested orders, across all categories.",
"items": {
"description": "An order suggested from the clinical note. The `category` discriminates the concrete order type.",
"oneOf": [
{
"title": "LABORATORY",
"type": "object",
"description": "A laboratory test order (e.g. CBC, HbA1c).",
"properties": {
"category": {
"type": "string",
"enum": [
"LABORATORY"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Complete blood count (CBC) with differential"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Rule out anemia; fatigue and pallor on exam"
}
},
"required": [
"category",
"description"
]
},
{
"title": "RADIOLOGY_IMAGING",
"type": "object",
"description": "An imaging study order (e.g. X-ray, CT, MRI).",
"properties": {
"category": {
"type": "string",
"enum": [
"RADIOLOGY_IMAGING"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "X-ray chest, 2 views"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Persistent cough for 3 weeks, evaluate for pneumonia"
}
},
"required": [
"category",
"description"
]
},
{
"title": "MEDICATION",
"type": "object",
"description": "A medication order. The prescription fields are extracted from the note and are `null` when the note does not mention them.",
"properties": {
"category": {
"type": "string",
"enum": [
"MEDICATION"
]
},
"description": {
"type": "string",
"description": "A short description of the medication, typically its name, strength and form.",
"example": "Metformin 500 mg tablet"
},
"details": {
"type": "string",
"nullable": true,
"description": "A human-readable summary of the prescription fields below, e.g. `(new) - 500 mg - 2 times per 1 day - route: oral`. `null` when none of them is set.",
"example": "(new) - 500 mg - 2 times per 1 day - route: oral"
},
"action": {
"nullable": true,
"type": "string",
"description": "The action to take on the medication. - `NEW`: start a new medication. - `REORDER`: renew an existing medication as is. - `CHANGE`: change an existing medication (e.g. its dose or frequency). - `DISCONTINUE`: stop an existing medication.",
"enum": [
"NEW",
"REORDER",
"CHANGE",
"DISCONTINUE"
],
"example": "NEW",
"title": "suggested_order_medication_action"
},
"dose_value": {
"type": "number",
"nullable": true,
"description": "The numeric part of the dose.",
"example": 500
},
"dose_unit": {
"type": "string",
"nullable": true,
"description": "The dose unit, as a UCUM code.",
"example": "mg"
},
"prn": {
"type": "boolean",
"nullable": true,
"description": "Whether the medication is to be taken as needed (_pro re nata_).",
"example": false
},
"frequency_times_per_period": {
"type": "integer",
"nullable": true,
"description": "The number of administrations per period, e.g. `2` in \"2 times per 1 day\".",
"example": 2
},
"frequency_period_length": {
"type": "integer",
"nullable": true,
"description": "The length of the period, e.g. `1` in \"2 times per 1 day\".",
"example": 1
},
"frequency_period_unit": {
"type": "string",
"nullable": true,
"description": "The unit of the period, as a UCUM code (e.g. `d`, `wk`, `h`).",
"example": "d"
},
"route": {
"type": "string",
"nullable": true,
"description": "The route of administration.",
"example": "Oral"
}
},
"required": [
"category",
"description"
]
},
{
"title": "PROCEDURE",
"type": "object",
"description": "A procedure order (e.g. skin lesion excision, colonoscopy).",
"properties": {
"category": {
"type": "string",
"enum": [
"PROCEDURE"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Colonoscopy"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Screening, family history of colorectal cancer"
}
},
"required": [
"category",
"description"
]
},
{
"title": "REFERRAL",
"type": "object",
"description": "A referral to another provider or specialty.",
"properties": {
"category": {
"type": "string",
"enum": [
"REFERRAL"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Cardiology referral"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Evaluate exertional chest tightness"
}
},
"required": [
"category",
"description"
]
},
{
"title": "IMMUNIZATION",
"type": "object",
"description": "A vaccine order.",
"properties": {
"category": {
"type": "string",
"enum": [
"IMMUNIZATION"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Influenza vaccine, seasonal"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Annual flu shot, patient agrees"
}
},
"required": [
"category",
"description"
]
},
{
"title": "DURABLE_MEDICAL_EQUIPMENT",
"type": "object",
"description": "A durable medical equipment order (e.g. CPAP, wheelchair).",
"properties": {
"category": {
"type": "string",
"enum": [
"DURABLE_MEDICAL_EQUIPMENT"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "CPAP machine"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Moderate obstructive sleep apnea confirmed by sleep study"
}
},
"required": [
"category",
"description"
]
}
],
"discriminator": {
"propertyName": "category",
"mapping": {
"LABORATORY": {
"type": "object",
"description": "A laboratory test order (e.g. CBC, HbA1c).",
"properties": {
"category": {
"type": "string",
"enum": [
"LABORATORY"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Complete blood count (CBC) with differential"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Rule out anemia; fatigue and pallor on exam"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_laboratory"
},
"RADIOLOGY_IMAGING": {
"type": "object",
"description": "An imaging study order (e.g. X-ray, CT, MRI).",
"properties": {
"category": {
"type": "string",
"enum": [
"RADIOLOGY_IMAGING"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "X-ray chest, 2 views"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Persistent cough for 3 weeks, evaluate for pneumonia"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_radiology_imaging"
},
"MEDICATION": {
"type": "object",
"description": "A medication order. The prescription fields are extracted from the note and are `null` when the note does not mention them.",
"properties": {
"category": {
"type": "string",
"enum": [
"MEDICATION"
]
},
"description": {
"type": "string",
"description": "A short description of the medication, typically its name, strength and form.",
"example": "Metformin 500 mg tablet"
},
"details": {
"type": "string",
"nullable": true,
"description": "A human-readable summary of the prescription fields below, e.g. `(new) - 500 mg - 2 times per 1 day - route: oral`. `null` when none of them is set.",
"example": "(new) - 500 mg - 2 times per 1 day - route: oral"
},
"action": {
"nullable": true,
"type": "string",
"description": "The action to take on the medication. - `NEW`: start a new medication. - `REORDER`: renew an existing medication as is. - `CHANGE`: change an existing medication (e.g. its dose or frequency). - `DISCONTINUE`: stop an existing medication.",
"enum": [
"NEW",
"REORDER",
"CHANGE",
"DISCONTINUE"
],
"example": "NEW",
"title": "suggested_order_medication_action"
},
"dose_value": {
"type": "number",
"nullable": true,
"description": "The numeric part of the dose.",
"example": 500
},
"dose_unit": {
"type": "string",
"nullable": true,
"description": "The dose unit, as a UCUM code.",
"example": "mg"
},
"prn": {
"type": "boolean",
"nullable": true,
"description": "Whether the medication is to be taken as needed (_pro re nata_).",
"example": false
},
"frequency_times_per_period": {
"type": "integer",
"nullable": true,
"description": "The number of administrations per period, e.g. `2` in \"2 times per 1 day\".",
"example": 2
},
"frequency_period_length": {
"type": "integer",
"nullable": true,
"description": "The length of the period, e.g. `1` in \"2 times per 1 day\".",
"example": 1
},
"frequency_period_unit": {
"type": "string",
"nullable": true,
"description": "The unit of the period, as a UCUM code (e.g. `d`, `wk`, `h`).",
"example": "d"
},
"route": {
"type": "string",
"nullable": true,
"description": "The route of administration.",
"example": "Oral"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_medication"
},
"PROCEDURE": {
"type": "object",
"description": "A procedure order (e.g. skin lesion excision, colonoscopy).",
"properties": {
"category": {
"type": "string",
"enum": [
"PROCEDURE"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Colonoscopy"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Screening, family history of colorectal cancer"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_procedure"
},
"REFERRAL": {
"type": "object",
"description": "A referral to another provider or specialty.",
"properties": {
"category": {
"type": "string",
"enum": [
"REFERRAL"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Cardiology referral"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Evaluate exertional chest tightness"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_referral"
},
"IMMUNIZATION": {
"type": "object",
"description": "A vaccine order.",
"properties": {
"category": {
"type": "string",
"enum": [
"IMMUNIZATION"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Influenza vaccine, seasonal"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Annual flu shot, patient agrees"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_immunization"
},
"DURABLE_MEDICAL_EQUIPMENT": {
"type": "object",
"description": "A durable medical equipment order (e.g. CPAP, wheelchair).",
"properties": {
"category": {
"type": "string",
"enum": [
"DURABLE_MEDICAL_EQUIPMENT"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "CPAP machine"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Moderate obstructive sleep apnea confirmed by sleep study"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_durable_medical_equipment"
}
}
},
"title": "suggested_order"
}
}
},
"required": [
"orders"
],
"title": "suggested_orders"
}
},
"required": [
"id",
"status"
]
}
],
"discriminator": {
"propertyName": "status",
"mapping": {
"ONGOING": {
"type": "object",
"properties": {
"id": {
"description": "The id of the asynchronous request.",
"type": "string",
"format": "uuid",
"example": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"title": "uuid"
},
"client_request_id": {
"type": "string",
"maxLength": 128,
"description": "An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.\n\n_Note_: this id must be different for every request. It is recommended to use a randomly generated UUID.",
"title": "client_request_id"
},
"status": {
"type": "string",
"enum": [
"ONGOING",
"FAILED",
"SUCCEEDED"
],
"title": "async_request_status"
}
},
"required": [
"id",
"status"
],
"title": "async_request_ongoing"
},
"FAILED": {
"type": "object",
"properties": {
"id": {
"description": "The id of the asynchronous request.",
"type": "string",
"format": "uuid",
"example": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"title": "uuid"
},
"client_request_id": {
"type": "string",
"maxLength": 128,
"description": "An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.\n\n_Note_: this id must be different for every request. It is recommended to use a randomly generated UUID.",
"title": "client_request_id"
},
"status": {
"type": "string",
"enum": [
"ONGOING",
"FAILED",
"SUCCEEDED"
],
"title": "async_request_status"
},
"payload": {
"type": "object",
"properties": {
"error_code": {
"type": "integer",
"example": 422
},
"error_message": {
"type": "string",
"example": "We can't generate the note when the transcript is too short."
}
},
"required": [
"error_code"
],
"title": "async_request_failed_payload"
}
},
"required": [
"id",
"status",
"payload"
],
"title": "async_request_failed"
},
"SUCCEEDED": {
"type": "object",
"properties": {
"id": {
"description": "The id of the asynchronous request.",
"type": "string",
"format": "uuid",
"example": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"title": "uuid"
},
"client_request_id": {
"type": "string",
"maxLength": 128,
"description": "An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.\n\n_Note_: this id must be different for every request. It is recommended to use a randomly generated UUID.",
"title": "client_request_id"
},
"status": {
"type": "string",
"enum": [
"ONGOING",
"FAILED",
"SUCCEEDED"
],
"title": "async_request_status"
},
"payload": {
"type": "object",
"description": "The orders suggested from the clinical note.",
"properties": {
"orders": {
"type": "array",
"description": "The suggested orders, across all categories.",
"items": {
"description": "An order suggested from the clinical note. The `category` discriminates the concrete order type.",
"oneOf": [
{
"title": "LABORATORY",
"type": "object",
"description": "A laboratory test order (e.g. CBC, HbA1c).",
"properties": {
"category": {
"type": "string",
"enum": [
"LABORATORY"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Complete blood count (CBC) with differential"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Rule out anemia; fatigue and pallor on exam"
}
},
"required": [
"category",
"description"
]
},
{
"title": "RADIOLOGY_IMAGING",
"type": "object",
"description": "An imaging study order (e.g. X-ray, CT, MRI).",
"properties": {
"category": {
"type": "string",
"enum": [
"RADIOLOGY_IMAGING"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "X-ray chest, 2 views"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Persistent cough for 3 weeks, evaluate for pneumonia"
}
},
"required": [
"category",
"description"
]
},
{
"title": "MEDICATION",
"type": "object",
"description": "A medication order. The prescription fields are extracted from the note and are `null` when the note does not mention them.",
"properties": {
"category": {
"type": "string",
"enum": [
"MEDICATION"
]
},
"description": {
"type": "string",
"description": "A short description of the medication, typically its name, strength and form.",
"example": "Metformin 500 mg tablet"
},
"details": {
"type": "string",
"nullable": true,
"description": "A human-readable summary of the prescription fields below, e.g. `(new) - 500 mg - 2 times per 1 day - route: oral`. `null` when none of them is set.",
"example": "(new) - 500 mg - 2 times per 1 day - route: oral"
},
"action": {
"nullable": true,
"type": "string",
"description": "The action to take on the medication. - `NEW`: start a new medication. - `REORDER`: renew an existing medication as is. - `CHANGE`: change an existing medication (e.g. its dose or frequency). - `DISCONTINUE`: stop an existing medication.",
"enum": [
"NEW",
"REORDER",
"CHANGE",
"DISCONTINUE"
],
"example": "NEW",
"title": "suggested_order_medication_action"
},
"dose_value": {
"type": "number",
"nullable": true,
"description": "The numeric part of the dose.",
"example": 500
},
"dose_unit": {
"type": "string",
"nullable": true,
"description": "The dose unit, as a UCUM code.",
"example": "mg"
},
"prn": {
"type": "boolean",
"nullable": true,
"description": "Whether the medication is to be taken as needed (_pro re nata_).",
"example": false
},
"frequency_times_per_period": {
"type": "integer",
"nullable": true,
"description": "The number of administrations per period, e.g. `2` in \"2 times per 1 day\".",
"example": 2
},
"frequency_period_length": {
"type": "integer",
"nullable": true,
"description": "The length of the period, e.g. `1` in \"2 times per 1 day\".",
"example": 1
},
"frequency_period_unit": {
"type": "string",
"nullable": true,
"description": "The unit of the period, as a UCUM code (e.g. `d`, `wk`, `h`).",
"example": "d"
},
"route": {
"type": "string",
"nullable": true,
"description": "The route of administration.",
"example": "Oral"
}
},
"required": [
"category",
"description"
]
},
{
"title": "PROCEDURE",
"type": "object",
"description": "A procedure order (e.g. skin lesion excision, colonoscopy).",
"properties": {
"category": {
"type": "string",
"enum": [
"PROCEDURE"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Colonoscopy"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Screening, family history of colorectal cancer"
}
},
"required": [
"category",
"description"
]
},
{
"title": "REFERRAL",
"type": "object",
"description": "A referral to another provider or specialty.",
"properties": {
"category": {
"type": "string",
"enum": [
"REFERRAL"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Cardiology referral"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Evaluate exertional chest tightness"
}
},
"required": [
"category",
"description"
]
},
{
"title": "IMMUNIZATION",
"type": "object",
"description": "A vaccine order.",
"properties": {
"category": {
"type": "string",
"enum": [
"IMMUNIZATION"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Influenza vaccine, seasonal"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Annual flu shot, patient agrees"
}
},
"required": [
"category",
"description"
]
},
{
"title": "DURABLE_MEDICAL_EQUIPMENT",
"type": "object",
"description": "A durable medical equipment order (e.g. CPAP, wheelchair).",
"properties": {
"category": {
"type": "string",
"enum": [
"DURABLE_MEDICAL_EQUIPMENT"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "CPAP machine"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Moderate obstructive sleep apnea confirmed by sleep study"
}
},
"required": [
"category",
"description"
]
}
],
"discriminator": {
"propertyName": "category",
"mapping": {
"LABORATORY": {
"type": "object",
"description": "A laboratory test order (e.g. CBC, HbA1c).",
"properties": {
"category": {
"type": "string",
"enum": [
"LABORATORY"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Complete blood count (CBC) with differential"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Rule out anemia; fatigue and pallor on exam"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_laboratory"
},
"RADIOLOGY_IMAGING": {
"type": "object",
"description": "An imaging study order (e.g. X-ray, CT, MRI).",
"properties": {
"category": {
"type": "string",
"enum": [
"RADIOLOGY_IMAGING"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "X-ray chest, 2 views"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Persistent cough for 3 weeks, evaluate for pneumonia"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_radiology_imaging"
},
"MEDICATION": {
"type": "object",
"description": "A medication order. The prescription fields are extracted from the note and are `null` when the note does not mention them.",
"properties": {
"category": {
"type": "string",
"enum": [
"MEDICATION"
]
},
"description": {
"type": "string",
"description": "A short description of the medication, typically its name, strength and form.",
"example": "Metformin 500 mg tablet"
},
"details": {
"type": "string",
"nullable": true,
"description": "A human-readable summary of the prescription fields below, e.g. `(new) - 500 mg - 2 times per 1 day - route: oral`. `null` when none of them is set.",
"example": "(new) - 500 mg - 2 times per 1 day - route: oral"
},
"action": {
"nullable": true,
"type": "string",
"description": "The action to take on the medication. - `NEW`: start a new medication. - `REORDER`: renew an existing medication as is. - `CHANGE`: change an existing medication (e.g. its dose or frequency). - `DISCONTINUE`: stop an existing medication.",
"enum": [
"NEW",
"REORDER",
"CHANGE",
"DISCONTINUE"
],
"example": "NEW",
"title": "suggested_order_medication_action"
},
"dose_value": {
"type": "number",
"nullable": true,
"description": "The numeric part of the dose.",
"example": 500
},
"dose_unit": {
"type": "string",
"nullable": true,
"description": "The dose unit, as a UCUM code.",
"example": "mg"
},
"prn": {
"type": "boolean",
"nullable": true,
"description": "Whether the medication is to be taken as needed (_pro re nata_).",
"example": false
},
"frequency_times_per_period": {
"type": "integer",
"nullable": true,
"description": "The number of administrations per period, e.g. `2` in \"2 times per 1 day\".",
"example": 2
},
"frequency_period_length": {
"type": "integer",
"nullable": true,
"description": "The length of the period, e.g. `1` in \"2 times per 1 day\".",
"example": 1
},
"frequency_period_unit": {
"type": "string",
"nullable": true,
"description": "The unit of the period, as a UCUM code (e.g. `d`, `wk`, `h`).",
"example": "d"
},
"route": {
"type": "string",
"nullable": true,
"description": "The route of administration.",
"example": "Oral"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_medication"
},
"PROCEDURE": {
"type": "object",
"description": "A procedure order (e.g. skin lesion excision, colonoscopy).",
"properties": {
"category": {
"type": "string",
"enum": [
"PROCEDURE"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Colonoscopy"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Screening, family history of colorectal cancer"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_procedure"
},
"REFERRAL": {
"type": "object",
"description": "A referral to another provider or specialty.",
"properties": {
"category": {
"type": "string",
"enum": [
"REFERRAL"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Cardiology referral"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Evaluate exertional chest tightness"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_referral"
},
"IMMUNIZATION": {
"type": "object",
"description": "A vaccine order.",
"properties": {
"category": {
"type": "string",
"enum": [
"IMMUNIZATION"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "Influenza vaccine, seasonal"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Annual flu shot, patient agrees"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_immunization"
},
"DURABLE_MEDICAL_EQUIPMENT": {
"type": "object",
"description": "A durable medical equipment order (e.g. CPAP, wheelchair).",
"properties": {
"category": {
"type": "string",
"enum": [
"DURABLE_MEDICAL_EQUIPMENT"
]
},
"description": {
"type": "string",
"description": "A short description of the order.",
"example": "CPAP machine"
},
"details": {
"type": "string",
"nullable": true,
"description": "Additional details about the order, as mentioned in the note (e.g. clinical indication, priority, laterality). `null` when there are none.",
"example": "Moderate obstructive sleep apnea confirmed by sleep study"
}
},
"required": [
"category",
"description"
],
"title": "suggested_order_durable_medical_equipment"
}
}
},
"title": "suggested_order"
}
}
},
"required": [
"orders"
],
"title": "suggested_orders"
}
},
"required": [
"id",
"status"
],
"title": "async_suggested_orders_generation_succeeded"
}
}
},
"title": "async_suggested_orders_generation"
}
}
}
}
}
}