HDR FHIR API

GET ExplanationOfBenefit Resource Bundle

get

/oracle-fhir-server/fhir/ExplanationOfBenefit

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
care-team(optional): string

Member of the CareTeam
claim(optional): string

The reference to the claim
coverage(optional): string

The plan under which the claim was adjudicated
created(optional): string(date)

The creation date for the EOB
detail-udi(optional): string

UDI associated with a line item detail product or service
disposition(optional): string

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

Encounters associated with a billed line item
enterer(optional): string

The party responsible for the entry of the Claim
facility(optional): string

Facility responsible for the goods and services
identifier(optional): string

The business identifier of the Explanation of Benefit
item-udi(optional): string

UDI associated with a line item product or service
patient(optional): string

The reference to the patient
payee(optional): string

The party receiving any payment for the Claim
procedure-udi(optional): string

UDI associated with a procedure
provider(optional): string

The reference to the provider
status(optional): string

Status of the instance
subdetail-udi(optional): string

UDI associated with a line item detail subdetail product or service

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object ExplanationOfBenefit

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

Nested Schema : ExplanationOfBenefit

Type: object

Show Source

careTeam: array careTeam

Minimum Number of Items: 1

Unique Items Required: true
claim: object Account_coverage
claimResponse: object Account_coverage
created: string

Minimum Length: 1
disposition: string

Minimum Length: 1
enterer: object Account_coverage
facility: object Account_coverage
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
item: array item

Minimum Number of Items: 1

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

Minimum Length: 1
patient: object Account_coverage
payee: object ExplanationOfBenefit_payee
provider: object Account_coverage
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text
total: array total

Minimum Number of Items: 1

Unique Items Required: true
type: object Basic_code
use: string

Minimum Length: 1

{
    "type":"object",
    "required":[
        "careTeam",
        "claim",
        "claimResponse",
        "created",
        "disposition",
        "enterer",
        "facility",
        "id",
        "identifier",
        "insurance",
        "insurer",
        "item",
        "meta",
        "outcome",
        "patient",
        "payee",
        "provider",
        "resourceType",
        "status",
        "text",
        "total",
        "type",
        "use"
    ],
    "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
        },
        "type":{
            "$ref":"#/definitions/Basic_code"
        },
        "use":{
            "type":"string",
            "minLength":1
        },
        "patient":{
            "$ref":"#/definitions/Account_coverage"
        },
        "created":{
            "type":"string",
            "minLength":1
        },
        "enterer":{
            "$ref":"#/definitions/Account_coverage"
        },
        "insurer":{
            "$ref":"#/definitions/Account_coverage"
        },
        "provider":{
            "$ref":"#/definitions/Account_coverage"
        },
        "payee":{
            "$ref":"#/definitions/ExplanationOfBenefit_payee"
        },
        "facility":{
            "$ref":"#/definitions/Account_coverage"
        },
        "claim":{
            "$ref":"#/definitions/Account_coverage"
        },
        "claimResponse":{
            "$ref":"#/definitions/Account_coverage"
        },
        "outcome":{
            "type":"string",
            "minLength":1
        },
        "disposition":{
            "type":"string",
            "minLength":1
        },
        "careTeam":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Claim_careTeam"
            },
            "minItems":1
        },
        "insurance":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/CoverageEligibilityRequest_insurance"
            },
            "minItems":1
        },
        "item":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ExplanationOfBenefit_item"
            },
            "minItems":1
        },
        "total":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ClaimResponse_total"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : careTeam

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Claim_careTeam

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Claim_careTeam"
    },
    "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 : 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 CoverageEligibilityRequest_insurance

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

Nested Schema : item

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ExplanationOfBenefit_item

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ExplanationOfBenefit_item"
    },
    "minItems":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 : ExplanationOfBenefit_payee

Type: object

Show Source

party: object Account_coverage
type: object Basic_code

{
    "required":[
        "party",
        "type"
    ],
    "properties":{
        "type":{
            "$ref":"#/definitions/Basic_code"
        },
        "party":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

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 : total

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ClaimResponse_total

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

Nested Schema : Basic_code

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : Claim_careTeam

Type: object

Show Source

provider(optional): object Account_coverage
sequence: number

{
    "required":[
        "sequence"
    ],
    "properties":{
        "sequence":{
            "type":"number"
        },
        "provider":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

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 : CoverageEligibilityRequest_insurance

Type: object

Show Source

coverage(optional): object Account_coverage
focal: boolean

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

Nested Schema : ExplanationOfBenefit_item

Type: object

Show Source

adjudication(optional): array adjudication

Minimum Number of Items: 1

Unique Items Required: true
careTeamSequence(optional): array careTeamSequence
encounter(optional): array encounter

Minimum Number of Items: 1

Unique Items Required: true
net(optional): object ChargeItem_priceOverride
productOrService(optional): object Basic_code
sequence: number
servicedDate: string

Minimum Length: 1
udi(optional): array udi

Minimum Number of Items: 1

Unique Items Required: true
unitPrice(optional): object ChargeItem_priceOverride

{
    "required":[
        "sequence",
        "servicedDate"
    ],
    "properties":{
        "sequence":{
            "type":"number"
        },
        "careTeamSequence":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "productOrService":{
            "$ref":"#/definitions/Basic_code"
        },
        "servicedDate":{
            "type":"string",
            "minLength":1
        },
        "unitPrice":{
            "$ref":"#/definitions/ChargeItem_priceOverride"
        },
        "net":{
            "$ref":"#/definitions/ChargeItem_priceOverride"
        },
        "udi":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "encounter":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "adjudication":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ClaimResponse_total"
            },
            "minItems":1
        }
    }
}

Nested Schema : adjudication

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ClaimResponse_total

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

Nested Schema : careTeamSequence

Type: array

Show Source

Array of: object items

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

Nested Schema : encounter

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

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

Nested Schema : ChargeItem_priceOverride

Type: object

Show Source

currency: string

Minimum Length: 1
value: number

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

Nested Schema : udi

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

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

Nested Schema : ClaimResponse_total

Type: object

Show Source

amount(optional): object ChargeItem_priceOverride
category(optional): object Claim_priority

{
    "properties":{
        "category":{
            "$ref":"#/definitions/Claim_priority"
        },
        "amount":{
            "$ref":"#/definitions/ChargeItem_priceOverride"
        }
    }
}

Nested Schema : Claim_priority

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CapabilityStatement_interaction_1

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

Nested Schema : CapabilityStatement_interaction_1

Type: object

Show Source

code: string

Minimum Length: 1

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

Nested Schema : items

Type: object

Show Source

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

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 : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_code

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

Nested Schema : ActivityDefinition_code

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1

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