Get Coverage
GET {{baseUrl}}/api/v2/Coverage?patient=<integer>&departmentId=<integer>&_count=<integer>&_offset=<integer>&include=<string>&ignore-restrictions=<boolean>
Overview:
Retrieves detailed information on insurance coverage, allowing healthcare developers to access and display real-time data regarding patients' insurance plans for streamlined verification and validation within clinical workflows.
Use Cases:
: Member Eligibility Checks
: Claims Adjudication
: Referral Insurance Discovery
: Clinical Trial Prequalification
: Care Gap Identification
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
patient | string | (Required) The patient identifier associated with the coverage. | |
departmentId | string | (Required) The department identifier | |
_count | string | The maximum number of results to return | |
_offset | string | The number of results to skip | |
include | string | Fields to include in the response | |
ignore-restrictions | string | Ignore restrictions |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-source-id | string | (Required) The source id provided for connecting to the data source | |
Authorization | string |
RESPONSES
status: OK
[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","type":"\u003cstring\u003e","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","beneficiary":{"reference":"\u003cstring\u003e","id":"\u003cstring\u003e"},"id":"\u003cstring\u003e","status":"\u003cstring\u003e","identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"policyHolder":{"display":"\u003cstring\u003e","reference":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueCode":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDate":"\u003cdate\u003e","valueHumanName":{"given":["\u003cstring\u003e","\u003cstring\u003e"],"family":"\u003cstring\u003e"},"valueAddress":{"state":"\u003cstring\u003e","postalCode":"\u003cstring\u003e","country":"\u003cstring\u003e","line":["\u003cstring\u003e","\u003cstring\u003e"]}},{"url":"\u003cstring\u003e","valueCode":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDate":"\u003cdate\u003e","valueHumanName":{"given":["\u003cstring\u003e","\u003cstring\u003e"],"family":"\u003cstring\u003e"},"valueAddress":{"state":"\u003cstring\u003e","postalCode":"\u003cstring\u003e","country":"\u003cstring\u003e","line":["\u003cstring\u003e","\u003cstring\u003e"]}}],"identifier":{}},"period":{"start":"\u003cdateTime\u003e","end":"\u003cdateTime\u003e"},"relationship":{"id":"\u003cinteger\u003e","text":"\u003cstring\u003e"},"class":[{"name":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueDate":"\u003cdate\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueDate":"\u003cdate\u003e"}],"type":{"coding":[{"system":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}}},{"resource":{"resourceType":"\u003cstring\u003e","beneficiary":{"reference":"\u003cstring\u003e","id":"\u003cstring\u003e"},"id":"\u003cstring\u003e","status":"\u003cstring\u003e","identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"policyHolder":{"display":"\u003cstring\u003e","reference":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueCode":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDate":"\u003cdate\u003e","valueHumanName":{"given":["\u003cstring\u003e","\u003cstring\u003e"],"family":"\u003cstring\u003e"},"valueAddress":{"state":"\u003cstring\u003e","postalCode":"\u003cstring\u003e","country":"\u003cstring\u003e","line":["\u003cstring\u003e","\u003cstring\u003e"]}},{"url":"\u003cstring\u003e","valueCode":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDate":"\u003cdate\u003e","valueHumanName":{"given":["\u003cstring\u003e","\u003cstring\u003e"],"family":"\u003cstring\u003e"},"valueAddress":{"state":"\u003cstring\u003e","postalCode":"\u003cstring\u003e","country":"\u003cstring\u003e","line":["\u003cstring\u003e","\u003cstring\u003e"]}}],"identifier":{}},"period":{"start":"\u003cdateTime\u003e","end":"\u003cdateTime\u003e"},"relationship":{"id":"\u003cinteger\u003e","text":"\u003cstring\u003e"},"class":[{"name":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueDate":"\u003cdate\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueDate":"\u003cdate\u003e"}],"type":{"coding":[{"system":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}}}]}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","type":"\u003cstring\u003e","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","beneficiary":{"reference":"\u003cstring\u003e","id":"\u003cstring\u003e"},"id":"\u003cstring\u003e","status":"\u003cstring\u003e","identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"policyHolder":{"display":"\u003cstring\u003e","reference":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueCode":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDate":"\u003cdate\u003e","valueHumanName":{"given":["\u003cstring\u003e","\u003cstring\u003e"],"family":"\u003cstring\u003e"},"valueAddress":{"state":"\u003cstring\u003e","postalCode":"\u003cstring\u003e","country":"\u003cstring\u003e","line":["\u003cstring\u003e","\u003cstring\u003e"]}},{"url":"\u003cstring\u003e","valueCode":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDate":"\u003cdate\u003e","valueHumanName":{"given":["\u003cstring\u003e","\u003cstring\u003e"],"family":"\u003cstring\u003e"},"valueAddress":{"state":"\u003cstring\u003e","postalCode":"\u003cstring\u003e","country":"\u003cstring\u003e","line":["\u003cstring\u003e","\u003cstring\u003e"]}}],"identifier":{}},"period":{"start":"\u003cdateTime\u003e","end":"\u003cdateTime\u003e"},"relationship":{"id":"\u003cinteger\u003e","text":"\u003cstring\u003e"},"class":[{"name":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueDate":"\u003cdate\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueDate":"\u003cdate\u003e"}],"type":{"coding":[{"system":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}}},{"resource":{"resourceType":"\u003cstring\u003e","beneficiary":{"reference":"\u003cstring\u003e","id":"\u003cstring\u003e"},"id":"\u003cstring\u003e","status":"\u003cstring\u003e","identifier":[{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"policyHolder":{"display":"\u003cstring\u003e","reference":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueCode":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDate":"\u003cdate\u003e","valueHumanName":{"given":["\u003cstring\u003e","\u003cstring\u003e"],"family":"\u003cstring\u003e"},"valueAddress":{"state":"\u003cstring\u003e","postalCode":"\u003cstring\u003e","country":"\u003cstring\u003e","line":["\u003cstring\u003e","\u003cstring\u003e"]}},{"url":"\u003cstring\u003e","valueCode":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueDate":"\u003cdate\u003e","valueHumanName":{"given":["\u003cstring\u003e","\u003cstring\u003e"],"family":"\u003cstring\u003e"},"valueAddress":{"state":"\u003cstring\u003e","postalCode":"\u003cstring\u003e","country":"\u003cstring\u003e","line":["\u003cstring\u003e","\u003cstring\u003e"]}}],"identifier":{}},"period":{"start":"\u003cdateTime\u003e","end":"\u003cdateTime\u003e"},"relationship":{"id":"\u003cinteger\u003e","text":"\u003cstring\u003e"},"class":[{"name":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","type":{"text":"\u003cstring\u003e"},"value":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueDate":"\u003cdate\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueDate":"\u003cdate\u003e"}],"type":{"coding":[{"system":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","display":"\u003cstring\u003e"}]}}}]}}]