HDR FHIR API

GET ChargeItem Resource Bundle

get

/oracle-fhir-server/fhir/ChargeItem

This endpoint supports the retrieval of ChargeItem resource list.It returns Bundle of ChargeItem 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 to place this charge
code(optional): string

A code that identifies the charge, like a billing code
context(optional): string

Encounter / Episode associated with event
entered-date(optional): string(date)

Date the charge item was entered
enterer(optional): string

Individual who was entering
factor-override(optional): number

Factor overriding the associated rules
identifier(optional): string

Business Identifier for item
occurrence(optional): string(date)

When the charged service was applied
patient(optional): string

Individual service was done for/to
performer-actor(optional): string

Individual who was performing
performer-function(optional): string

What type of performance was done
performing-organization(optional): string

Organization providing the charged service
price-override(optional): integer

Price overriding the associated rules
quantity(optional): integer

Quantity of which the charge item has been serviced
requesting-organization(optional): string

Organization requesting the charged service
service(optional): string

Which rendered service is being charged?
subject(optional): string

Individual service was done for/to

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object ChargeItem

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

Nested Schema : ChargeItem

Type: object

Show Source

account: array account

Minimum Number of Items: 1

Unique Items Required: true
code: object ChargeItem_code
context: object Account_coverage
definitionUri: array definitionUri
enteredDate: string

Minimum Length: 1
enterer: object Account_coverage
factorOverride: number
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
note: array note

Minimum Number of Items: 1

Unique Items Required: true
occurrencePeriod: object Account_servicePeriod
overrideReason: string

Minimum Length: 1
performer: array performer

Minimum Number of Items: 1

Unique Items Required: true
performingOrganization: object ChargeItem_performingOrganization
priceOverride: object ChargeItem_priceOverride
quantity: object ChargeItem_quantity
reason: array reason

Minimum Number of Items: 1

Unique Items Required: true
requestingOrganization: object ChargeItem_performingOrganization
resourceType: string

Minimum Length: 1
service: array service

Minimum Number of Items: 1

Unique Items Required: true
status: string

Minimum Length: 1
subject: object Account_coverage
text: object Account_text

{
    "type":"object",
    "required":[
        "account",
        "code",
        "context",
        "definitionUri",
        "enteredDate",
        "enterer",
        "factorOverride",
        "id",
        "identifier",
        "meta",
        "note",
        "occurrencePeriod",
        "overrideReason",
        "performer",
        "performingOrganization",
        "priceOverride",
        "quantity",
        "reason",
        "requestingOrganization",
        "resourceType",
        "service",
        "status",
        "subject",
        "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
        },
        "definitionUri":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "$ref":"#/definitions/ChargeItem_code"
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        },
        "context":{
            "$ref":"#/definitions/Account_coverage"
        },
        "occurrencePeriod":{
            "$ref":"#/definitions/Account_servicePeriod"
        },
        "performer":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ChargeItem_performer"
            },
            "minItems":1
        },
        "performingOrganization":{
            "$ref":"#/definitions/ChargeItem_performingOrganization"
        },
        "requestingOrganization":{
            "$ref":"#/definitions/ChargeItem_performingOrganization"
        },
        "quantity":{
            "$ref":"#/definitions/ChargeItem_quantity"
        },
        "factorOverride":{
            "type":"number"
        },
        "priceOverride":{
            "$ref":"#/definitions/ChargeItem_priceOverride"
        },
        "overrideReason":{
            "type":"string",
            "minLength":1
        },
        "enterer":{
            "$ref":"#/definitions/Account_coverage"
        },
        "enteredDate":{
            "type":"string",
            "minLength":1
        },
        "reason":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "service":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "account":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "note":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ChargeItem_note"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : account

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_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/Appointment_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 : definitionUri

Type: array

Show Source

Array of: object items

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

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ChargeItem_note

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ChargeItem_performer

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

Nested Schema : ChargeItem_performingOrganization

Type: object

Show Source

identifier: object Account_identifier

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

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

Type: object

Show Source

value: number

{
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"number"
        }
    }
}

Nested Schema : reason

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

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

Nested Schema : service

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Appointment_coding

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

Nested Schema : Appointment_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1

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

Nested Schema : items

Type: object

Show Source

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

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

Type: object

Show Source

authorReference(optional): object Account_coverage
text: string

Minimum Length: 1
time: string

Minimum Length: 1

{
    "required":[
        "text",
        "time"
    ],
    "properties":{
        "authorReference":{
            "$ref":"#/definitions/Account_coverage"
        },
        "time":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : ChargeItem_performer

Type: object

Show Source

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

{
    "properties":{
        "function":{
            "$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
}

Nested Schema : AdverseEvent_category

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

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