Update Coverage
PUT {{baseUrl}}/api/v2/Coverage/:coverage-id
Overview
Updates existing insurance coverage data, empowering developers to modify specific details associated with a particular patient's coverage, ensuring accurate and current insurance information for optimized clinical workflows.
This is only supported by ATHENA.
Use Cases:
Policy Updates: Update coverage policy details
Member Details Updates: Modify member eligibility info
Referral Policy Amendments: Modify referral policy coverage info
Clinical Trial Charges Update: Revise study charge eligibility
Care Plan Reassessment: Update coverage limits impacting care plan
Request Body
{"data"=>{"resourceType"=>"<string>", "beneficiary"=>{"reference"=>"<string>", "id"=>"<string>"}, "status"=>"<string>", "identifier"=>[{"system"=>"<string>", "value"=>"<string>"}, {"system"=>"<string>", "value"=>"<string>"}], "policyHolder"=>{"display"=>"<string>", "reference"=>"<string>", "extension"=>[{"url"=>"<string>", "valueCode"=>"<string>", "valueString"=>"<string>", "valueDate"=>"<date>", "valueAddress"=>{"state"=>"<string>", "postalCode"=>"<string>", "country"=>"<string>", "line"=>["<string>", "<string>"]}, "valueHumanName"=>{"given"=>["<string>", "<string>"], "family"=>"<string>"}}, {"url"=>"<string>", "valueCode"=>"<string>", "valueString"=>"<string>", "valueDate"=>"<date>", "valueAddress"=>{"state"=>"<string>", "postalCode"=>"<string>", "country"=>"<string>", "line"=>["<string>", "<string>"]}, "valueHumanName"=>{"given"=>["<string>", "<string>"], "family"=>"<string>"}}]}, "period"=>{"start"=>"<dateTime>", "end"=>"<dateTime>"}, "relationship"=>{"id"=>"<integer>", "text"=>"<string>"}, "class"=>[{"type"=>{"text"=>"<string>"}, "name"=>"<string>", "value"=>"<string>"}, {"type"=>{"text"=>"<string>"}, "name"=>"<string>", "value"=>"<string>"}], "extension"=>[{"url"=>"<string>", "valueString"=>"<string>", "valueInteger"=>"<integer>", "valueDate"=>"<date>"}, {"url"=>"<string>", "valueString"=>"<string>", "valueInteger"=>"<integer>", "valueDate"=>"<date>"}], "type"=>{"coding"=>[{"system"=>"<string>", "display"=>"<string>"}, {"system"=>"<string>", "display"=>"<string>"}]}}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
x-source-id | string | (Required) The source id provided for connecting to the data source | |
Content-Type | string | ||
Authorization | string |
RESPONSES
status: OK
[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"id":"\u003cinteger\u003e","status":"\u003cstring\u003e"}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"id":"\u003cinteger\u003e","status":"\u003cstring\u003e"}}]