[Alpha] Extract medical codes with phenocr
/construe/phenocrAlpha: phenocr is an alpha feature. Request parameters, response shape, and results may change between releases. Do not depend on it for production workloads yet.
Extracts medical codes from natural language clinical text using phenocr.
Supported code systems: HPO, ICD-10-CM, RXNORM, and SNOMED_CT_US. The code system name and version are both required.
Successfully extracted codes
Response fields
Code system name. Can be a built-in system or a custom system name.
Built-in systems:
- CPT
- HCPCS
- HPO
- ICD-10
- ICD-10-CM
- ICD-10-PCS
- LOINC
- RXNORM
- SNOMED_CT_US
- SNOMED_CT_US_LITE
Custom systems:
- Any valid system name uploaded via /construe/upload. Requires a paid plan.
Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
Specific code system version.
The extracted code
Short description of the code
Whether the code passed validation. Always true unless include_invalid is set to true, in which case invalid codes will have this set to false.
Explanation for why this code was extracted (if include_rationale is true)
Whether this code is an ancestor (parent) of an extracted code rather than directly extracted. Only present when include_ancestors is true.
Source text references showing where this code was found in the input. Only present when include_citations is true and chunking method supports it. Ancestor codes do not receive citations.
The exact text span containing evidence for the code
Starting byte offset in the original input text (0-indexed)
Ending byte offset (exclusive), such that input[begin_offset:end_offset] == text
Higher-level groupings the extracted code belongs to (e.g. HPO category terms). Only populated by full-extraction chunking methods such as "fasthpocr".
Identifier for the category term (e.g. an HPO URI).
Human-readable label for the category term.