Tross
CoverMyMeds

Submit prior authorization

Submit prior authorization in CoverMyMeds

POSThttps://api.ontross.com/api/integrations/covermymeds/submit-prior-authorization
Request Fields
input.request_key
string
required
Portal identifier for the authorization being sent.
Example
"BEXAMPLE"
input.expected_lock_version
integer
required
Version from the latest get-prior-authorization response.
Example
3
input.idempotency_key
string
required
Stable UUID for this one send attempt; reuse it only for retries.
Example
"3f2504e0-4f89-11d3-9a0c-0305e82c3301"
input.certify_clinical_information
boolean
required
Attest to the clinical certification shown by CoverMyMeds at Send To Plan.
Example
true
input.answer_updates
array
Question changes supplied for the current authorization send attempt.
input.answer_updates[].question_name
string
Question name from the latest get-prior-authorization response.
Example
"patient_first_name"
input.answer_updates[].section_name
string
Containing group identifier from the latest authorization detail response.
Example
"patient"
input.answer_updates[].section_index
integer
Zero-based position of the containing question group.
Example
0
input.answer_updates[].row_index
integer
Zero-based position of the containing question row.
Example
2
input.answer_updates[].value
string
Text, one choice key, or a list of choice keys.
Example
"string"
input.answer_updates[].display_text
string
Required when a dropdown has no embedded choices.
Example
"Massachusetts"
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
Example
"00000000-0000-4000-8000-000000000000"
Output Fields
request_key
string
Portal identifier for the authorization involved in this send attempt.
Example
"BEXAMPLE"
workflow_status
string
Portal processing stage reported after the send attempt.
Example
"submitted"
response_status
string
Decision indicator returned for the authorization after sending.
Example
"approved"
lock_version
integer
Revision counter returned after the authorization send attempt.
Example
4
next_action
string
Required follow-up step determined after the send attempt.
Example
"await_plan_decision"
upstream_accepted
boolean
Whether the portal accepted the authorization send attempt.
Example
true
replayed
boolean
Whether this result came from an earlier identical send attempt.
Example
false
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/covermymeds/submit-prior-authorization \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"request_key":"BEXAMPLE","expected_lock_version":3,"idempotency_key":"3f2504e0-4f89-11d3-9a0c-0305e82c3301","certify_clinical_information":true,"answer_updates":[]},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "request_key": "BEXAMPLE",
    "expected_lock_version": 3,
    "idempotency_key": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
    "certify_clinical_information": true,
    "answer_updates": []
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "request_key": "BEXAMPLE",
    "workflow_status": "submitted",
    "response_status": "approved",
    "lock_version": 4,
    "next_action": "await_plan_decision",
    "upstream_accepted": true,
    "replayed": false
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}