Get an asynchronous normalized data generation
GET/generate-normalized-data-async/:id
Poll the status —and results if successful— of an asynchronous normalized data generation.
Request
Responses
- 200
The asynchronous normalized data generation details.
Operation spec
{
"method": "get",
"path": "/generate-normalized-data-async/{id}",
"operationId": "get-generate-normalized-data-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 normalized data 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 normalized data extracted from the note.",
"properties": {
"conditions": {
"description": "FHIR conditions (including their ICD-10 code) corresponding to the patient's medical conditions as mentioned in the clinical note.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"properties": {
"clinical_status": {
"type": "string",
"enum": [
"ACTIVE",
"RESOLVED"
],
"description": "The [clinical status](https://www.hl7.org/fhir/condition-definitions.html#Condition.clinicalStatus) of the condition. Only `ACTIVE` and `RESOLVED` are supported for now.",
"example": "ACTIVE",
"title": "fhir_condition_clinical_status"
},
"coding": {
"description": "ICD-10 coding representation of this condition.",
"type": "object",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only ICD-10 is supported for now.",
"enum": [
"http://hl7.org/fhir/sid/icd-10-cm"
]
},
"code": {
"type": "string",
"example": "G44.8",
"description": "Code of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"display": {
"type": "string",
"example": "Other specified headache syndromes.",
"description": "Description of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"is_hcc": {
"description": "Indicates if this code maps to a Hierarchical Condition Category (HCC) under the version 28 risk adjustment model.",
"type": "boolean"
},
"is_mcc": {
"description": "Indicates if this code qualifies as a Major Complication or Comorbidity (MCC).",
"type": "boolean"
}
},
"required": [
"code",
"display",
"system",
"is_hcc",
"is_mcc"
],
"title": "icd10_entry_with_hcc_mcc"
},
"alternative_coding": {
"type": "array",
"description": "An array of ICD-10 codes that are closely related to the primary coding and represent plausible alternative coding for the condition.",
"items": {
"type": "object",
"description": "An ICD-10 entry including HCC and MCC information.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only ICD-10 is supported for now.",
"enum": [
"http://hl7.org/fhir/sid/icd-10-cm"
]
},
"code": {
"type": "string",
"example": "G44.8",
"description": "Code of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"display": {
"type": "string",
"example": "Other specified headache syndromes.",
"description": "Description of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"is_hcc": {
"description": "Indicates if this code maps to a Hierarchical Condition Category (HCC) under the version 28 risk adjustment model.",
"type": "boolean"
},
"is_mcc": {
"description": "Indicates if this code qualifies as a Major Complication or Comorbidity (MCC).",
"type": "boolean"
}
},
"required": [
"code",
"display",
"system",
"is_hcc",
"is_mcc"
],
"title": "icd10_entry_with_hcc_mcc"
}
},
"categories": {
"description": "Categories of the condition. `PROBLEM_LIST_ITEM` refers to conditions that are resolved or may appear in past medical history, including chronic conditions that are not treated during the current encounter. `ENCOUNTER_DIAGNOSIS` refers to conditions treated during the current encounter. A condition can appear in both categories.",
"type": "array",
"items": {
"type": "string",
"enum": [
"PROBLEM_LIST_ITEM",
"ENCOUNTER_DIAGNOSIS"
],
"description": "The category of a [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"example": "PROBLEM_LIST_ITEM",
"title": "fhir_condition_category"
}
},
"corresponding_note_problem": {
"description": "The title of the problem sub-header corresponding to this condition, in the \"Assessment & Plan\" section of the input note. This field is only filled when `include_corresponding_note_problems` is set to `true` in the request and that an `ASSESSMENT_AND_PLAN` section has been provided in the input note. If the condition was not extracted from the `ASSESSMENT_AND_PLAN` section, this field will be `null`.",
"type": "string"
}
},
"required": [
"coding"
],
"title": "fhir_patient_condition"
}
},
"observations": {
"description": "FHIR observations (including their LOINC code) extracted from the clinical note.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR observation](https://www.hl7.org/fhir/observation.html).",
"properties": {
"coding": {
"description": "LOINC coding representation of this observation.",
"type": "object",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only LOINC is supported for now.",
"enum": [
"http://loinc.org"
]
},
"code": {
"type": "string",
"example": "29463-7",
"description": "Code of the LOINC entry."
},
"display": {
"type": "string",
"example": "Body weight",
"description": "Description of the LOINC entry."
}
},
"required": [
"code",
"display",
"system"
],
"title": "loinc_entry"
},
"value_quantity": {
"description": "The value quantity for this observation, if not a range.",
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
],
"title": "observation_value_quantity"
},
"value_range": {
"description": "The value range for this observation, if not a quantity.",
"type": "object",
"properties": {
"low": {
"description": "The lower bound of the range.",
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
],
"title": "observation_value_quantity"
},
"high": {
"description": "The higher bound of the range.",
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
],
"title": "observation_value_quantity"
}
},
"required": [
"low",
"high"
],
"title": "observation_value_range"
},
"note": {
"type": "string",
"description": "Additional comment about the observation.",
"example": "Measured at rest."
}
},
"required": [
"coding"
],
"title": "observation_entry"
}
}
},
"required": [
"conditions",
"observations"
],
"title": "async_normalized_data_succeeded_payload"
}
},
"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 normalized data extracted from the note.",
"properties": {
"conditions": {
"description": "FHIR conditions (including their ICD-10 code) corresponding to the patient's medical conditions as mentioned in the clinical note.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"properties": {
"clinical_status": {
"type": "string",
"enum": [
"ACTIVE",
"RESOLVED"
],
"description": "The [clinical status](https://www.hl7.org/fhir/condition-definitions.html#Condition.clinicalStatus) of the condition. Only `ACTIVE` and `RESOLVED` are supported for now.",
"example": "ACTIVE",
"title": "fhir_condition_clinical_status"
},
"coding": {
"description": "ICD-10 coding representation of this condition.",
"type": "object",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only ICD-10 is supported for now.",
"enum": [
"http://hl7.org/fhir/sid/icd-10-cm"
]
},
"code": {
"type": "string",
"example": "G44.8",
"description": "Code of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"display": {
"type": "string",
"example": "Other specified headache syndromes.",
"description": "Description of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"is_hcc": {
"description": "Indicates if this code maps to a Hierarchical Condition Category (HCC) under the version 28 risk adjustment model.",
"type": "boolean"
},
"is_mcc": {
"description": "Indicates if this code qualifies as a Major Complication or Comorbidity (MCC).",
"type": "boolean"
}
},
"required": [
"code",
"display",
"system",
"is_hcc",
"is_mcc"
],
"title": "icd10_entry_with_hcc_mcc"
},
"alternative_coding": {
"type": "array",
"description": "An array of ICD-10 codes that are closely related to the primary coding and represent plausible alternative coding for the condition.",
"items": {
"type": "object",
"description": "An ICD-10 entry including HCC and MCC information.",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only ICD-10 is supported for now.",
"enum": [
"http://hl7.org/fhir/sid/icd-10-cm"
]
},
"code": {
"type": "string",
"example": "G44.8",
"description": "Code of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"display": {
"type": "string",
"example": "Other specified headache syndromes.",
"description": "Description of the [ICD-10](https://www.icd10data.com/ICD10CM/Codes) entry."
},
"is_hcc": {
"description": "Indicates if this code maps to a Hierarchical Condition Category (HCC) under the version 28 risk adjustment model.",
"type": "boolean"
},
"is_mcc": {
"description": "Indicates if this code qualifies as a Major Complication or Comorbidity (MCC).",
"type": "boolean"
}
},
"required": [
"code",
"display",
"system",
"is_hcc",
"is_mcc"
],
"title": "icd10_entry_with_hcc_mcc"
}
},
"categories": {
"description": "Categories of the condition. `PROBLEM_LIST_ITEM` refers to conditions that are resolved or may appear in past medical history, including chronic conditions that are not treated during the current encounter. `ENCOUNTER_DIAGNOSIS` refers to conditions treated during the current encounter. A condition can appear in both categories.",
"type": "array",
"items": {
"type": "string",
"enum": [
"PROBLEM_LIST_ITEM",
"ENCOUNTER_DIAGNOSIS"
],
"description": "The category of a [FHIR condition](https://www.hl7.org/fhir/condition.html).",
"example": "PROBLEM_LIST_ITEM",
"title": "fhir_condition_category"
}
},
"corresponding_note_problem": {
"description": "The title of the problem sub-header corresponding to this condition, in the \"Assessment & Plan\" section of the input note. This field is only filled when `include_corresponding_note_problems` is set to `true` in the request and that an `ASSESSMENT_AND_PLAN` section has been provided in the input note. If the condition was not extracted from the `ASSESSMENT_AND_PLAN` section, this field will be `null`.",
"type": "string"
}
},
"required": [
"coding"
],
"title": "fhir_patient_condition"
}
},
"observations": {
"description": "FHIR observations (including their LOINC code) extracted from the clinical note.",
"type": "array",
"items": {
"type": "object",
"description": "Structured [FHIR observation](https://www.hl7.org/fhir/observation.html).",
"properties": {
"coding": {
"description": "LOINC coding representation of this observation.",
"type": "object",
"properties": {
"system": {
"type": "string",
"description": "The used coding system, only LOINC is supported for now.",
"enum": [
"http://loinc.org"
]
},
"code": {
"type": "string",
"example": "29463-7",
"description": "Code of the LOINC entry."
},
"display": {
"type": "string",
"example": "Body weight",
"description": "Description of the LOINC entry."
}
},
"required": [
"code",
"display",
"system"
],
"title": "loinc_entry"
},
"value_quantity": {
"description": "The value quantity for this observation, if not a range.",
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
],
"title": "observation_value_quantity"
},
"value_range": {
"description": "The value range for this observation, if not a quantity.",
"type": "object",
"properties": {
"low": {
"description": "The lower bound of the range.",
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
],
"title": "observation_value_quantity"
},
"high": {
"description": "The higher bound of the range.",
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The value of the quantity."
},
"unit": {
"type": "string",
"description": "The unit of the observation quantity.",
"enum": [
"METER",
"CENTIMETER",
"FOOT",
"KILOGRAM",
"POUND",
"MILLIMETERS_OF_MERCURY",
"CENTIMETERS_OF_MERCURY",
"CELSIUS",
"FAHRENHEIT",
"BEATS_PER_MINUTE",
"BREATHS_PER_MINUTE",
"LITER_PER_MINUTE",
"MILLIMETER",
"PERCENT",
"INCH"
],
"title": "observation_value_unit"
},
"system": {
"type": "string",
"description": "The used coding system, only UCUM is supported for now.",
"enum": [
"https://ucum.org"
]
},
"code": {
"type": "string",
"description": "The [UCUM](https://ucum.org/ucum.html) code of the unit.",
"example": "kg"
}
},
"required": [
"value",
"system"
],
"title": "observation_value_quantity"
}
},
"required": [
"low",
"high"
],
"title": "observation_value_range"
},
"note": {
"type": "string",
"description": "Additional comment about the observation.",
"example": "Measured at rest."
}
},
"required": [
"coding"
],
"title": "observation_entry"
}
}
},
"required": [
"conditions",
"observations"
],
"title": "async_normalized_data_succeeded_payload"
}
},
"required": [
"id",
"status"
],
"title": "async_normalized_data_succeeded"
}
}
},
"title": "async_normalized_data"
}
}
}
}
}
}