HDR FHIR API

GET PaymentReconciliation Resource Bundle

get

/oracle-fhir-server/fhir/PaymentReconciliation

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

The processing outcome
payment-issuer(optional): string

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

The reference to the claim
requestor(optional): string

The reference to the provider who submitted the claim
status(optional): string

The status of the payment reconciliation

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object PaymentReconciliation

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

Nested Schema : PaymentReconciliation

Type: object

Show Source

created: string

Minimum Length: 1
detail: array detail

Minimum Number of Items: 1

Unique Items Required: true
disposition: string

Minimum Length: 1
formCode: object Basic_code
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

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

Minimum Length: 1
paymentAmount: object ChargeItem_priceOverride
paymentDate: string

Minimum Length: 1
paymentIdentifier: object Account_identifier
paymentIssuer: object Account_coverage
period: object Account_servicePeriod
processNote: array processNote

Minimum Number of Items: 1

Unique Items Required: true
request: object Account_coverage
requestor: object Account_coverage
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text

{
    "type":"object",
    "required":[
        "created",
        "detail",
        "disposition",
        "formCode",
        "id",
        "identifier",
        "meta",
        "outcome",
        "paymentAmount",
        "paymentDate",
        "paymentIdentifier",
        "paymentIssuer",
        "period",
        "processNote",
        "request",
        "requestor",
        "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
        },
        "period":{
            "$ref":"#/definitions/Account_servicePeriod"
        },
        "created":{
            "type":"string",
            "minLength":1
        },
        "paymentIssuer":{
            "$ref":"#/definitions/Account_coverage"
        },
        "request":{
            "$ref":"#/definitions/Account_coverage"
        },
        "requestor":{
            "$ref":"#/definitions/Account_coverage"
        },
        "outcome":{
            "type":"string",
            "minLength":1
        },
        "disposition":{
            "type":"string",
            "minLength":1
        },
        "paymentDate":{
            "type":"string",
            "minLength":1
        },
        "paymentAmount":{
            "$ref":"#/definitions/ChargeItem_priceOverride"
        },
        "paymentIdentifier":{
            "$ref":"#/definitions/Account_identifier"
        },
        "detail":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/PaymentReconciliation_detail"
            },
            "minItems":1
        },
        "formCode":{
            "$ref":"#/definitions/Basic_code"
        },
        "processNote":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/PaymentReconciliation_processNote"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : detail

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object PaymentReconciliation_detail

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

Type: object

Show Source

reference: string

Minimum Length: 1

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

Nested Schema : Account_servicePeriod

Type: object

Show Source

end: string

Minimum Length: 1
start: string

Minimum Length: 1

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

Nested Schema : processNote

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object PaymentReconciliation_processNote

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

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

Type: object

Show Source

amount(optional): object ChargeItem_priceOverride
date: string

Minimum Length: 1
identifier(optional): object Account_identifier
payee(optional): object Account_coverage
request(optional): object ChargeItem_performingOrganization
response(optional): object ChargeItem_performingOrganization
submitter(optional): object Account_coverage
type(optional): object Basic_code

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

Nested Schema : ChargeItem_performingOrganization

Type: object

Show Source

identifier: object Account_identifier

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

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

Type: object

Show Source

text: string

Minimum Length: 1
type: string

Minimum Length: 1

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