Package org.hl7.fhir.dstu2016may.model

Class Account

  • 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 Account
extends DomainResource
    A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centres, etc.
    See Also:
    Serialized Form

    • Field Detail

      • identifier

        protected List<Identifier> identifier
        Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).

      • name

        protected StringType name
        Name used for the account when displaying it to humans in reports, etc.

      • type

        protected CodeableConcept type
        Categorizes the account for reporting and searching purposes.

      • activePeriod

        protected Period activePeriod
        Indicates the period of time over which the account is allowed.

      • currency

        protected Coding currency
        Identifies the currency to which transactions must be converted when crediting or debiting the account.

      • balance

        protected Money balance
        Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.

      • coveragePeriod

        protected Period coveragePeriod
        Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.

      • subject

        protected Reference subject
        Identifies the patient, device, practitioner, location or other object the account is associated with.

      • subjectTarget

        protected Resource subjectTarget
        The actual object that is the target of the reference (Identifies the patient, device, practitioner, location or other object the account is associated with.)

      • owner

        protected Reference owner
        Indicates the organization, department, etc. with responsibility for the account.

      • ownerTarget

        protected Organization ownerTarget
        The actual object that is the target of the reference (Indicates the organization, department, etc. with responsibility for the account.)

      • description

        protected StringType description
        Provides additional information about what the account tracks and how it is used.

      • BALANCE

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

        Description: How much is in account?
        Type: quantity
        Path: Account.balance

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: What is account tied to?
        Type: reference
        Path: Account.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: What is account tied to?
        Type: reference
        Path: Account.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 "Account:patient".

      • STATUS

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

        Description: active | inactive
        Type: token
        Path: Account.status

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: What is account tied to?
        Type: reference
        Path: Account.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: What is account tied to?
        Type: reference
        Path: Account.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 "Account:subject".

      • NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
        Fluent Client search parameter constant for name

        Description: Human-readable label
        Type: string
        Path: Account.name

      • OWNER

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

        Description: Who is responsible?
        Type: reference
        Path: Account.owner

      • INCLUDE_OWNER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_OWNER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Account:owner".

      • PERIOD

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

        Description: Transaction window
        Type: date
        Path: Account.coveragePeriod

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: E.g. patient, expense, depreciation
        Type: token
        Path: Account.type

        See Also:
        Constant Field Values

      • TYPE

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

        Description: E.g. patient, expense, depreciation
        Type: token
        Path: Account.type

      • IDENTIFIER

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

        Description: Account number
        Type: token
        Path: Account.identifier

    • Constructor Detail

      • Account

        public Account()
        Constructor

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        Returns:
        identifier (Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).)

      • addIdentifier

        public Identifier addIdentifier()
        Returns:
        identifier (Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).)

      • getNameElement

        public StringType getNameElement()
        Returns:
        name (Name used for the account when displaying it to humans in reports, etc.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

      • hasName

        public boolean hasName()

      • setNameElement

        public Account setNameElement​(StringType value)
        Parameters:
        value - name (Name used for the account when displaying it to humans in reports, etc.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

      • getName

        public String getName()
        Returns:
        Name used for the account when displaying it to humans in reports, etc.

      • setName

        public Account setName​(String value)
        Parameters:
        value - Name used for the account when displaying it to humans in reports, etc.

      • hasType

        public boolean hasType()

      • getStatusElement

        public Enumeration<Account.AccountStatus> getStatusElement()
        Returns:
        status (Indicates whether the account is presently used/useable or not.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

      • setStatusElement

        public Account setStatusElement​(Enumeration<Account.AccountStatus> value)
        Parameters:
        value - status (Indicates whether the account is presently used/useable or not.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

      • getCurrency

        public Coding getCurrency()
        Returns:
        currency (Identifies the currency to which transactions must be converted when crediting or debiting the account.)

      • setCurrency

        public Account setCurrency​(Coding value)
        Parameters:
        value - currency (Identifies the currency to which transactions must be converted when crediting or debiting the account.)

      • getBalance

        public Money getBalance()
        Returns:
        balance (Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.)

      • setBalance

        public Account setBalance​(Money value)
        Parameters:
        value - balance (Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.)

      • getCoveragePeriod

        public Period getCoveragePeriod()
        Returns:
        coveragePeriod (Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.)

      • getSubject

        public Reference getSubject()
        Returns:
        subject (Identifies the patient, device, practitioner, location or other object the account is associated with.)

      • setSubject

        public Account setSubject​(Reference value)
        Parameters:
        value - subject (Identifies the patient, device, practitioner, location or other object the account is associated with.)

      • getSubjectTarget

        public Resource getSubjectTarget()
        Returns:
        subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Identifies the patient, device, practitioner, location or other object the account is associated with.)

      • setSubjectTarget

        public Account setSubjectTarget​(Resource value)
        Parameters:
        value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Identifies the patient, device, practitioner, location or other object the account is associated with.)

      • getOwner

        public Reference getOwner()
        Returns:
        owner (Indicates the organization, department, etc. with responsibility for the account.)

      • setOwner

        public Account setOwner​(Reference value)
        Parameters:
        value - owner (Indicates the organization, department, etc. with responsibility for the account.)

      • getOwnerTarget

        public Organization getOwnerTarget()
        Returns:
        owner The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Indicates the organization, department, etc. with responsibility for the account.)

      • setOwnerTarget

        public Account setOwnerTarget​(Organization value)
        Parameters:
        value - owner The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Indicates the organization, department, etc. with responsibility for the account.)

      • getDescriptionElement

        public StringType getDescriptionElement()
        Returns:
        description (Provides additional information about what the account tracks and how it is used.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

      • setDescriptionElement

        public Account setDescriptionElement​(StringType value)
        Parameters:
        value - description (Provides additional information about what the account tracks and how it is used.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

      • getDescription

        public String getDescription()
        Returns:
        Provides additional information about what the account tracks and how it is used.

      • setDescription

        public Account setDescription​(String value)
        Parameters:
        value - Provides additional information about what the account tracks and how it is used.

      • getProperty

        public Base[] getProperty​(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • makeProperty

        public Base makeProperty​(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource