Resolve Carrier
Perform Resolve Carrier through athenahealth.
athena_resolve_carrierreadathenahealth
Inputs
- Carrier Text
carrier_textexpressionrequiredRequired literal value or workflow expression.
- Patient State
patient_stateexpressionOptional literal value or workflow expression.
- Plan Type Hint
plan_type_hintexpressionOptional literal value or workflow expression.
- Minimum Confidence
minimum_confidenceselectOptional selected identifier or value.
Default:
"high"Options: High — only an unambiguous match ("high"), Medium — accept a best reading ("medium")
- Allow Llm
allow_llmbooleanOptional true-or-false value.
Default:
true
Outputs
successSuccessmatchedMatchedreadyReadysearch_textSearch Textpackage_idPackage Idpackage_namePackage Nameproduct_typeProduct Typeis_super_packageIs Super PackageresolverResolverconfidenceConfidencerequires_reviewRequires Reviewreview_reasonReview Reasoncandidate_countCandidate Countmapping_settings_urlMapping Settings UrlcandidatesCandidateserror_messageError MessageerrorError
Output schema completeness: best_effort_declared
Safety
- External effect
- read
- Confirmation recommended
- No
- Retry safe
- Yes
- Dry run supported
- No
Schemas
These schemas are first-pass authoring guidance. Runtime validation remains authoritative.
Input schema
{
"type": "object",
"required": [
"carrier_text"
],
"properties": {
"allow_llm": {
"type": "boolean",
"default": true,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"carrier_text": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"patient_state": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"plan_type_hint": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"minimum_confidence": {
"enum": [
"high",
"medium"
],
"type": "string",
"default": "high",
"description": "Optional selected identifier or value.",
"x-workflow-field-type": "select"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"error": {},
"ready": {},
"matched": {},
"success": {},
"resolver": {},
"candidates": {},
"confidence": {},
"package_id": {},
"search_text": {},
"package_name": {},
"product_type": {},
"error_message": {},
"review_reason": {},
"candidate_count": {},
"requires_review": {},
"is_super_package": {},
"mapping_settings_url": {}
},
"additionalProperties": true
}