HDR FHIR API

GET ClaimResponse Resource Bundle

get

/oracle-fhir-server/fhir/ClaimResponse

This endpoint supports the retrieval of ClaimResponse resource list.It returns Bundle of ClaimResponse 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 identity of the ClaimResponse
insurer(optional): string

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

The processing outcome
patient(optional): string

The subject of care
payment-date(optional): string(date)

The expected payment date
request(optional): string

The claim reference
requestor(optional): string

The Provider of the claim
status(optional): string

The status of the ClaimResponse
use(optional): string

The type of claim

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object ClaimResponse

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

Nested Schema : ClaimResponse

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
insurer: object ChargeItem_performingOrganization
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
payeeType: object Basic_code
payment: object ClaimResponse_payment
request: object Account_coverage
requestor: object Account_coverage
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
subType: object Basic_code
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":[
        "created",
        "disposition",
        "id",
        "identifier",
        "insurer",
        "item",
        "meta",
        "outcome",
        "patient",
        "payeeType",
        "payment",
        "request",
        "requestor",
        "resourceType",
        "status",
        "subType",
        "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"
        },
        "subType":{
            "$ref":"#/definitions/Basic_code"
        },
        "use":{
            "type":"string",
            "minLength":1
        },
        "patient":{
            "$ref":"#/definitions/Account_coverage"
        },
        "created":{
            "type":"string",
            "minLength":1
        },
        "insurer":{
            "$ref":"#/definitions/ChargeItem_performingOrganization"
        },
        "requestor":{
            "$ref":"#/definitions/Account_coverage"
        },
        "request":{
            "$ref":"#/definitions/Account_coverage"
        },
        "outcome":{
            "type":"string",
            "minLength":1
        },
        "disposition":{
            "type":"string",
            "minLength":1
        },
        "payeeType":{
            "$ref":"#/definitions/Basic_code"
        },
        "item":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ClaimResponse_item"
            },
            "minItems":1
        },
        "total":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ClaimResponse_total"
            },
            "minItems":1
        },
        "payment":{
            "$ref":"#/definitions/ClaimResponse_payment"
        },
        "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 : ChargeItem_performingOrganization

Type: object

Show Source

identifier: object Account_identifier

{
    "required":[
        "identifier"
    ],
    "properties":{
        "identifier":{
            "$ref":"#/definitions/Account_identifier"
        }
    }
}

Nested Schema : item

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ClaimResponse_item

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

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":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 : ClaimResponse_payment

Type: object

Show Source

amount: object ChargeItem_priceOverride
date: string

Minimum Length: 1
identifier: object Account_identifier
type: object Basic_code

{
    "required":[
        "amount",
        "date",
        "identifier",
        "type"
    ],
    "properties":{
        "type":{
            "$ref":"#/definitions/Basic_code"
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "amount":{
            "$ref":"#/definitions/ChargeItem_priceOverride"
        },
        "identifier":{
            "$ref":"#/definitions/Account_identifier"
        }
    }
}

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

Type: object

Show Source

adjudication(optional): array adjudication

Minimum Number of Items: 1

Unique Items Required: true
itemSequence: number

{
    "required":[
        "itemSequence"
    ],
    "properties":{
        "itemSequence":{
            "type":"number"
        },
        "adjudication":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ClaimResponse_adjudication"
            },
            "minItems":1
        }
    }
}

Nested Schema : adjudication

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ClaimResponse_adjudication

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

Nested Schema : ClaimResponse_adjudication

Type: object

Show Source

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

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

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

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/Account_type_coding"
            },
            "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 : coding

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

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"
        }
    }
}