Package com.ibm.fhir.model.resource

Class ChargeItemDefinition

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class ChargeItemDefinition
extends DomainResource
    The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.

    Maturity level: FMM0 (Trial Use)

    • Method Detail

      • getUrl

        public Uri getUrl()
        An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.
        Returns:
        An immutable object of type Uri that is non-null.

      • getIdentifier

        public List<Identifier> getIdentifier()
        A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getVersion

        public String getVersion()
        The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
        Returns:
        An immutable object of type String that may be null.

      • getTitle

        public String getTitle()
        A short, descriptive, user-friendly title for the charge item definition.
        Returns:
        An immutable object of type String that may be null.

      • getDerivedFromUri

        public List<Uri> getDerivedFromUri()
        The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.
        Returns:
        An unmodifiable list containing immutable objects of type Uri that may be empty.

      • getPartOf

        public List<Canonical> getPartOf()
        A larger definition of which this particular definition is a component or step.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getReplaces

        public List<Canonical> getReplaces()
        As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getStatus

        public PublicationStatus getStatus()
        The current state of the ChargeItemDefinition.
        Returns:
        An immutable object of type PublicationStatus that is non-null.

      • getExperimental

        public Boolean getExperimental()
        A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        Returns:
        An immutable object of type Boolean that may be null.

      • getDate

        public DateTime getDate()
        The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.
        Returns:
        An immutable object of type DateTime that may be null.

      • getPublisher

        public String getPublisher()
        The name of the organization or individual that published the charge item definition.
        Returns:
        An immutable object of type String that may be null.

      • getContact

        public List<ContactDetail> getContact()
        Contact details to assist a user in finding and communicating with the publisher.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getDescription

        public Markdown getDescription()
        A free text natural language description of the charge item definition from a consumer's perspective.
        Returns:
        An immutable object of type Markdown that may be null.

      • getUseContext

        public List<UsageContext> getUseContext()
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.
        Returns:
        An unmodifiable list containing immutable objects of type UsageContext that may be empty.

      • getJurisdiction

        public List<CodeableConcept> getJurisdiction()
        A legal or geographic region in which the charge item definition is intended to be used.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getCopyright

        public Markdown getCopyright()
        A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.
        Returns:
        An immutable object of type Markdown that may be null.

      • getApprovalDate

        public Date getApprovalDate()
        The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
        Returns:
        An immutable object of type Date that may be null.

      • getLastReviewDate

        public Date getLastReviewDate()
        The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
        Returns:
        An immutable object of type Date that may be null.

      • getEffectivePeriod

        public Period getEffectivePeriod()
        The period during which the charge item definition content was or is planned to be in active use.
        Returns:
        An immutable object of type Period that may be null.

      • getCode

        public CodeableConcept getCode()
        The defined billing details in this resource pertain to the given billing code.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getInstance

        public List<Reference> getInstance()
        The defined billing details in this resource pertain to the given product instance(s).
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getPropertyGroup

        public List<ChargeItemDefinition.PropertyGroup> getPropertyGroup()
        Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.
        Returns:
        An unmodifiable list containing immutable objects of type ChargeItemDefinition.PropertyGroup that may be empty.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object