HDR FHIR API

GET CoverageEligibilityResponse Resource Bundle

get

/oracle-fhir-server/fhir/CoverageEligibilityResponse

This endpoint supports the retrieval of CoverageEligibilityResponse resource list.It returns Bundle of CoverageEligibilityResponse resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
created(optional): string(date)

The creation date
disposition(optional): string

The contents of the disposition message
identifier(optional): string

The business identifier
insurer(optional): string

The organization which generated this resource
outcome(optional): string

The processing outcome
patient(optional): string

The reference to the patient
request(optional): string

The EligibilityRequest reference
requestor(optional): string

The EligibilityRequest provider
status(optional): string

The EligibilityRequest status

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object CoverageEligibilityResponse

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CoverageEligibilityResponse"
    }
}

Nested Schema : CoverageEligibilityResponse

Type: object

Show Source

created: string

Minimum Length: 1
disposition: string

Minimum Length: 1
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
insurance: array insurance

Minimum Number of Items: 1

Unique Items Required: true
insurer: object Account_coverage
meta: object Account_meta
outcome: string

Minimum Length: 1
patient: object Account_coverage
purpose: array purpose
request: object Account_coverage
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text

{
    "type":"object",
    "required":[
        "created",
        "disposition",
        "id",
        "identifier",
        "insurance",
        "insurer",
        "meta",
        "outcome",
        "patient",
        "purpose",
        "request",
        "resourceType",
        "status",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "purpose":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "patient":{
            "$ref":"#/definitions/Account_coverage"
        },
        "created":{
            "type":"string",
            "minLength":1
        },
        "request":{
            "$ref":"#/definitions/Account_coverage"
        },
        "outcome":{
            "type":"string",
            "minLength":1
        },
        "disposition":{
            "type":"string",
            "minLength":1
        },
        "insurer":{
            "$ref":"#/definitions/Account_coverage"
        },
        "insurance":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/CoverageEligibilityResponse_insurance"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_identifier

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_identifier"
    },
    "minItems":1
}

Nested Schema : insurance

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CoverageEligibilityResponse_insurance

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/CoverageEligibilityResponse_insurance"
    },
    "minItems":1
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_meta

Type: object

Show Source

tag: array tag

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "tag"
    ],
    "properties":{
        "tag":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : purpose

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : Account_text

Type: object

Show Source

div: string

Minimum Length: 1
status: string

Minimum Length: 1

{
    "required":[
        "div",
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "minLength":1
        },
        "div":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_identifier

Type: object

Show Source

system: string

Minimum Length: 1
value: string

Minimum Length: 1

{
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "value":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : CoverageEligibilityResponse_insurance

Type: object

Show Source

coverage(optional): object Account_coverage
inforce: boolean

{
    "required":[
        "inforce"
    ],
    "properties":{
        "coverage":{
            "$ref":"#/definitions/Account_coverage"
        },
        "inforce":{
            "type":"boolean"
        }
    }
}

Nested Schema : tag

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Account_type_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "display",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}