Class ChargeItem

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class ChargeItem extends DomainResource
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.
See Also:
Serialized Form
  • Field Details

    • identifier

      Identifiers assigned to this event performer or other systems.
    • definition

      protected List<UriType> definition
      References the source of pricing information, rules of application for the code this ChargeItem uses.
    • status

      The current state of the ChargeItem.
    • partOf

      protected List<Reference> partOf
      ChargeItems can be grouped to larger ChargeItems covering the whole set.
    • partOfTarget

      The actual objects that are the target of the reference (ChargeItems can be grouped to larger ChargeItems covering the whole set.)
    • code

      protected CodeableConcept code
      A code that identifies the charge, like a billing code.
    • subject

      protected Reference subject
      The individual or set of individuals the action is being or was performed on.
    • subjectTarget

      The actual object that is the target of the reference (The individual or set of individuals the action is being or was performed on.)
    • context

      protected Reference context
      The encounter or episode of care that establishes the context for this event.
    • contextTarget

      The actual object that is the target of the reference (The encounter or episode of care that establishes the context for this event.)
    • occurrence

      protected Type occurrence
      Date/time(s) or duration when the charged service was applied.
    • participant

      Indicates who or what performed or participated in the charged service.
    • performingOrganization

      The organization requesting the service.
    • performingOrganizationTarget

      The actual object that is the target of the reference (The organization requesting the service.)
    • requestingOrganization

      The organization performing the service.
    • requestingOrganizationTarget

      The actual object that is the target of the reference (The organization performing the service.)
    • quantity

      protected Quantity quantity
      Quantity of which the charge item has been serviced.
    • bodysite

      The anatomical location where the related service has been applied.
    • factorOverride

      Factor overriding the factor determined by the rules associated with the code.
    • priceOverride

      protected Money priceOverride
      Total price of the charge overriding the list price associated with the code.
    • overrideReason

      If the list price or the rule based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.
    • enterer

      protected Reference enterer
      The device, practitioner, etc. who entered the charge item.
    • entererTarget

      The actual object that is the target of the reference (The device, practitioner, etc. who entered the charge item.)
    • enteredDate

      Date the charge item was entered.
    • reason

      Describes why the event occurred in coded or textual form.
    • service

      protected List<Reference> service
      Indicated the rendered service that caused this charge.
    • serviceTarget

      The actual objects that are the target of the reference (Indicated the rendered service that caused this charge.)
    • account

      protected List<Reference> account
      Account into which this ChargeItems belongs.
    • accountTarget

      The actual objects that are the target of the reference (Account into which this ChargeItems belongs.)
    • note

      protected List<Annotation> note
      Comments made about the event by the performer, subject or other participants.
    • supportingInformation

      Further information supporting the this charge.
    • supportingInformationTarget

      The actual objects that are the target of the reference (Further information supporting the this charge.)
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Business Identifier for item
      Type: token
      Path: ChargeItem.identifier

      See Also:
      Constant Field Values
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: Business Identifier for item
      Type: token
      Path: ChargeItem.identifier

    • SP_PERFORMING_ORGANIZATION

      public static final String SP_PERFORMING_ORGANIZATION
      Search parameter: performing-organization

      Description: Organization providing the charged sevice
      Type: reference
      Path: ChargeItem.performingOrganization

      See Also:
      Constant Field Values
    • PERFORMING_ORGANIZATION

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMING_ORGANIZATION
      Fluent Client search parameter constant for performing-organization

      Description: Organization providing the charged sevice
      Type: reference
      Path: ChargeItem.performingOrganization

    • INCLUDE_PERFORMING_ORGANIZATION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMING_ORGANIZATION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:performing-organization".
    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

      Description: A code that identifies the charge, like a billing code
      Type: token
      Path: ChargeItem.code

      See Also:
      Constant Field Values
    • CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
      Fluent Client search parameter constant for code

      Description: A code that identifies the charge, like a billing code
      Type: token
      Path: ChargeItem.code

    • SP_QUANTITY

      public static final String SP_QUANTITY
      Search parameter: quantity

      Description: Quantity of which the charge item has been serviced
      Type: quantity
      Path: ChargeItem.quantity

      See Also:
      Constant Field Values
    • QUANTITY

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam QUANTITY
      Fluent Client search parameter constant for quantity

      Description: Quantity of which the charge item has been serviced
      Type: quantity
      Path: ChargeItem.quantity

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: Individual service was done for/to
      Type: reference
      Path: ChargeItem.subject

      See Also:
      Constant Field Values
    • SUBJECT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
      Fluent Client search parameter constant for subject

      Description: Individual service was done for/to
      Type: reference
      Path: ChargeItem.subject

    • INCLUDE_SUBJECT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:subject".
    • SP_PARTICIPANT_ROLE

      public static final String SP_PARTICIPANT_ROLE
      Search parameter: participant-role

      Description: What type of performance was done
      Type: token
      Path: ChargeItem.participant.role

      See Also:
      Constant Field Values
    • PARTICIPANT_ROLE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam PARTICIPANT_ROLE
      Fluent Client search parameter constant for participant-role

      Description: What type of performance was done
      Type: token
      Path: ChargeItem.participant.role

    • SP_PARTICIPANT_ACTOR

      public static final String SP_PARTICIPANT_ACTOR
      Search parameter: participant-actor

      Description: Individual who was performing
      Type: reference
      Path: ChargeItem.participant.actor

      See Also:
      Constant Field Values
    • PARTICIPANT_ACTOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARTICIPANT_ACTOR
      Fluent Client search parameter constant for participant-actor

      Description: Individual who was performing
      Type: reference
      Path: ChargeItem.participant.actor

    • INCLUDE_PARTICIPANT_ACTOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PARTICIPANT_ACTOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:participant-actor".
    • SP_OCCURRENCE

      public static final String SP_OCCURRENCE
      Search parameter: occurrence

      Description: When the charged service was applied
      Type: date
      Path: ChargeItem.occurrence[x]

      See Also:
      Constant Field Values
    • OCCURRENCE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam OCCURRENCE
      Fluent Client search parameter constant for occurrence

      Description: When the charged service was applied
      Type: date
      Path: ChargeItem.occurrence[x]

    • SP_ENTERED_DATE

      public static final String SP_ENTERED_DATE
      Search parameter: entered-date

      Description: Date the charge item was entered
      Type: date
      Path: ChargeItem.enteredDate

      See Also:
      Constant Field Values
    • ENTERED_DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam ENTERED_DATE
      Fluent Client search parameter constant for entered-date

      Description: Date the charge item was entered
      Type: date
      Path: ChargeItem.enteredDate

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Individual service was done for/to
      Type: reference
      Path: ChargeItem.subject

      See Also:
      Constant Field Values
    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

      Description: Individual service was done for/to
      Type: reference
      Path: ChargeItem.subject

    • INCLUDE_PATIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:patient".
    • SP_FACTOR_OVERRIDE

      public static final String SP_FACTOR_OVERRIDE
      Search parameter: factor-override

      Description: Factor overriding the associated rules
      Type: number
      Path: ChargeItem.factorOverride

      See Also:
      Constant Field Values
    • FACTOR_OVERRIDE

      public static final ca.uhn.fhir.rest.gclient.NumberClientParam FACTOR_OVERRIDE
      Fluent Client search parameter constant for factor-override

      Description: Factor overriding the associated rules
      Type: number
      Path: ChargeItem.factorOverride

    • SP_SERVICE

      public static final String SP_SERVICE
      Search parameter: service

      Description: Which rendered service is being charged?
      Type: reference
      Path: ChargeItem.service

      See Also:
      Constant Field Values
    • SERVICE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SERVICE
      Fluent Client search parameter constant for service

      Description: Which rendered service is being charged?
      Type: reference
      Path: ChargeItem.service

    • INCLUDE_SERVICE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SERVICE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:service".
    • SP_PRICE_OVERRIDE

      public static final String SP_PRICE_OVERRIDE
      Search parameter: price-override

      Description: Price overriding the associated rules
      Type: quantity
      Path: ChargeItem.priceOverride

      See Also:
      Constant Field Values
    • PRICE_OVERRIDE

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam PRICE_OVERRIDE
      Fluent Client search parameter constant for price-override

      Description: Price overriding the associated rules
      Type: quantity
      Path: ChargeItem.priceOverride

    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: Encounter / Episode associated with event
      Type: reference
      Path: ChargeItem.context

      See Also:
      Constant Field Values
    • CONTEXT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTEXT
      Fluent Client search parameter constant for context

      Description: Encounter / Episode associated with event
      Type: reference
      Path: ChargeItem.context

    • INCLUDE_CONTEXT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:context".
    • SP_ENTERER

      public static final String SP_ENTERER
      Search parameter: enterer

      Description: Individual who was entering
      Type: reference
      Path: ChargeItem.enterer

      See Also:
      Constant Field Values
    • ENTERER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENTERER
      Fluent Client search parameter constant for enterer

      Description: Individual who was entering
      Type: reference
      Path: ChargeItem.enterer

    • INCLUDE_ENTERER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTERER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:enterer".
    • SP_ACCOUNT

      public static final String SP_ACCOUNT
      Search parameter: account

      Description: Account to place this charge
      Type: reference
      Path: ChargeItem.account

      See Also:
      Constant Field Values
    • ACCOUNT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ACCOUNT
      Fluent Client search parameter constant for account

      Description: Account to place this charge
      Type: reference
      Path: ChargeItem.account

    • INCLUDE_ACCOUNT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ACCOUNT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:account".
    • SP_REQUESTING_ORGANIZATION

      public static final String SP_REQUESTING_ORGANIZATION
      Search parameter: requesting-organization

      Description: Organization requesting the charged service
      Type: reference
      Path: ChargeItem.requestingOrganization

      See Also:
      Constant Field Values
    • REQUESTING_ORGANIZATION

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUESTING_ORGANIZATION
      Fluent Client search parameter constant for requesting-organization

      Description: Organization requesting the charged service
      Type: reference
      Path: ChargeItem.requestingOrganization

    • INCLUDE_REQUESTING_ORGANIZATION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTING_ORGANIZATION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ChargeItem:requesting-organization".
  • Constructor Details

  • Method Details