RxClass Search¶
Searches the RxClass database for drug classes by name and returns a JSON-formatted result and a status message. It validates the input, handles API errors, and formats results to include the original search term with the returned data.
Usage¶
Use this node when you need to find drug classes by name (e.g., "ACE Inhibitors") to explore their identifiers or related metadata. It typically precedes nodes that require a class ID, such as fetching class information or listing class 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 RxClass search results. | {"search_term": "ACE Inhibitors", "results": {"rxclassMinConceptList": {"rxclassMinConcept": [{"classId": "...", "className": "Angiotensin-Converting Enzyme Inhibitors", "classType": "..."}]}}} |
| status | STRING | A human-readable status message indicating success or describing an error. | Successfully searched RxClass for 'ACE Inhibitors' |
Important Notes¶
- Input required: An empty class name returns an empty JSON object ("{}") and an error status.
- Output format: The first output is a JSON-formatted string, not a parsed object. Downstream nodes expecting structured data must parse it.
- API behavior: Results are sourced from the RxClass service; availability, rate limits, and content depend on the external API.
- Error handling: If the API reports an error, the error details are returned within the JSON string and reflected in the status message.
- Typical workflow: Use the returned class identifiers from the results to query class details or members in subsequent nodes.
Troubleshooting¶
- No results or empty list: Verify the spelling of the class name or try a broader term (e.g., search for "Statin" instead of a brand-specific term).
- Status shows 'Class name cannot be empty': Provide a non-empty class_name value.
- API Error in status: Indicates a network or service issue. Check connectivity, try again later, or reduce request frequency.
- Downstream parsing errors: Ensure you parse the JSON string from class_search_results before accessing fields.
- Unexpected fields or structure: The API response format may change; inspect the raw JSON output to adapt downstream processing.