Skip to main content

ChargeItem

Draft Financial

The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/ChargeItem
InteractionMethodPath
ReadGET/fhir/R4/ChargeItem/[id]
VreadGET/fhir/R4/ChargeItem/[id]/_history/[vid]
UpdatePUT/fhir/R4/ChargeItem/[id]
PatchPATCH/fhir/R4/ChargeItem/[id]
DeleteDELETE/fhir/R4/ChargeItem/[id]
CreatePOST/fhir/R4/ChargeItem
SearchGET/fhir/R4/ChargeItem
HistoryGET/fhir/R4/ChargeItem/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*Business Identifier for item
definitionUriuri0..*Defining information about the code of this charge item
definitionCanonicalcanonical0..*Resource defining the code of this ChargeItem
statuscode1..1planned | billable | not-billable | aborted | billed | entered-in-error | unknown modifier
partOfReference0..*Part of referenced ChargeItem
codeCodeableConcept1..1A code that identifies the charge, like a billing code
subjectReference1..1Individual service was done for/to
contextReference0..1Encounter / Episode associated with event
occurrence[x]dateTime / Period / Timing0..1When the charged service was applied
performerBackboneElement0..*Who performed charged service
performingOrganizationReference0..1Organization providing the charged service
requestingOrganizationReference0..1Organization requesting the charged service
costCenterReference0..1Organization that has ownership of the (potential, future) revenue
quantityQuantity0..1Quantity of which the charge item has been serviced
bodysiteCodeableConcept0..*Anatomical location, if relevant
factorOverridedecimal0..1Factor overriding the associated rules
priceOverrideMoney0..1Price overriding the associated rules
overrideReasonstring0..1Reason for overriding the list price/factor
entererReference0..1Individual who was entering
enteredDatedateTime0..1Date the charge item was entered
reasonCodeableConcept0..*Why was the charged service rendered?
serviceReference0..*Which rendered service is being charged?
product[x]Reference / CodeableConcept0..1Product charged
accountReference0..*Account to place this charge
noteAnnotation0..*Comments made about the ChargeItem
supportingInformationReference0..*Further information supporting this charge

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
accountstringhttp://hl7.org/fhir/SearchParameter/ChargeItem-account
codestringhttp://hl7.org/fhir/SearchParameter/ChargeItem-code
contextstringhttp://hl7.org/fhir/SearchParameter/ChargeItem-context
entered-datestringhttp://hl7.org/fhir/SearchParameter/ChargeItem-entered-date
entererstringhttp://hl7.org/fhir/SearchParameter/ChargeItem-enterer
factor-overridestringhttp://hl7.org/fhir/SearchParameter/ChargeItem-factor-override
identifierstringhttp://hl7.org/fhir/SearchParameter/ChargeItem-identifier
occurrencestringhttp://hl7.org/fhir/SearchParameter/ChargeItem-occurrence
patientstringhttp://hl7.org/fhir/SearchParameter/ChargeItem-patient
performer-actorstringhttp://hl7.org/fhir/SearchParameter/ChargeItem-performer-actor
performer-functionstringhttp://hl7.org/fhir/SearchParameter/ChargeItem-performer-function
performing-organizationstringhttp://hl7.org/fhir/SearchParameter/ChargeItem-performing-organization
price-overridestringhttp://hl7.org/fhir/SearchParameter/ChargeItem-price-override
quantitystringhttp://hl7.org/fhir/SearchParameter/ChargeItem-quantity
requesting-organizationstringhttp://hl7.org/fhir/SearchParameter/ChargeItem-requesting-organization
servicestringhttp://hl7.org/fhir/SearchParameter/ChargeItem-service
subjectstringhttp://hl7.org/fhir/SearchParameter/ChargeItem-subject

Reference​

  • Official FHIR R4 spec: ChargeItem
  • Maturity: Draft (FMM 0).