RxClass Search¶
Searches RxClass by a provided class name and returns the results as a JSON string along with a human-readable status. It validates the input, queries the underlying RxNorm service, and formats the response to include the original search term and results.
Usage¶
Use this node when you need to look up RxClass entries by a class name (e.g., therapeutic class or mechanism-related classes). Typically placed early in a workflow to identify class IDs or verify available classes before fetching detailed info or members.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| class_name | True | STRING | The drug class name to search for in RxClass. | ACE Inhibitors |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| class_search_results | STRING | A JSON string containing the search term and the raw results returned by the RxClass service. | { "search_term": "ACE Inhibitors", "results": { ... } } |
| status | STRING | A status message indicating success or describing any error encountered during the search. | Successfully searched RxClass for 'ACE Inhibitors' |
Important Notes¶
- The class_name input must not be empty; an empty value returns an error status and an empty JSON object.
- The first output is a JSON string; downstream nodes or scripts may need to parse it to access fields such as results.
- If the underlying service reports an error, the first output contains the error JSON and the status will start with 'API Error:'.
- Results are formatted to include both the original search_term and the results payload for clarity.
- Network or service rate limits can affect response time and availability. Retry if transient errors occur.
Troubleshooting¶
- Empty or blank class name: Provide a non-empty class_name to avoid 'Error: Class name cannot be empty'.
- API Error in status: Inspect the class_search_results JSON for an 'error' field and adjust the query or retry later.
- Parsing issues downstream: Ensure you parse the JSON string from class_search_results before attempting to access fields.
- Unexpected or empty results: Verify the class name spelling or try alternative class terms; some classes may not have entries or may be named differently.