HDR FHIR API

GET Invoice Resource Bundle

get

/oracle-fhir-server/fhir/Invoice

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
account(optional): string

Account that is being balanced
date(optional): string(date)

Invoice date / posting date
identifier(optional): string

Business Identifier for item
issuer(optional): string

Issuing Organization of Invoice
participant(optional): string

Individual who was involved
participant-role(optional): string

Type of involvement in creation of this Invoice
patient(optional): string

Recipient(s) of goods and services
recipient(optional): string

Recipient of this invoice
status(optional): string

draft | issued | balanced | cancelled | entered-in-error
subject(optional): string

Recipient(s) of goods and services
totalgross(optional): integer

Gross total of this Invoice
totalnet(optional): integer

Net total of this Invoice
type(optional): string

Type of Invoice

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Invoice

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

Nested Schema : Invoice

Type: object

Show Source

account: object Account_coverage
date: string

Minimum Length: 1
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
issuer: object ChargeItem_performingOrganization
meta: object Account_meta
participant: array participant

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
subject: object Account_coverage
text: object Account_text
totalGross: object ChargeItem_priceOverride
totalNet: object ChargeItem_priceOverride

{
    "type":"object",
    "required":[
        "account",
        "date",
        "id",
        "identifier",
        "issuer",
        "meta",
        "participant",
        "resourceType",
        "status",
        "subject",
        "text",
        "totalGross",
        "totalNet"
    ],
    "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
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "participant":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Invoice_participant"
            },
            "minItems":1
        },
        "issuer":{
            "$ref":"#/definitions/ChargeItem_performingOrganization"
        },
        "account":{
            "$ref":"#/definitions/Account_coverage"
        },
        "totalNet":{
            "$ref":"#/definitions/ChargeItem_priceOverride"
        },
        "totalGross":{
            "$ref":"#/definitions/ChargeItem_priceOverride"
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

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

Type: object

Show Source

identifier: object Account_identifier

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

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Invoice_participant

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

Type: object

Show Source

actor(optional): object Account_coverage
role(optional): object ActivityDefinition_valueCodeableConcept

{
    "properties":{
        "role":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "actor":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

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 Account_type_coding

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