Class Account

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.Account
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class Account
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR Account Resource ()

Definition: 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.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Account

See Also:
Serialized Form
  • Field Details

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description:
      Type: token
      Path: Account.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:
      Type: token
      Path: Account.identifier

    • SP_NAME

      public static final String SP_NAME
      Search parameter constant for name

      Description:
      Type: string
      Path: Account.name

      See Also:
      Constant Field Values
    • NAME

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

      Description:
      Type: string
      Path: Account.name

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter constant for type

      Description:
      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:
      Type: token
      Path: Account.type

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter constant for status

      Description:
      Type: token
      Path: Account.status

      See Also:
      Constant Field Values
    • STATUS

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

      Description:
      Type: token
      Path: Account.status

    • SP_BALANCE

      public static final String SP_BALANCE
      Search parameter constant for balance

      Description:
      Type: quantity
      Path: Account.balance

      See Also:
      Constant Field Values
    • BALANCE

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

      Description:
      Type: quantity
      Path: Account.balance

    • SP_PERIOD

      public static final String SP_PERIOD
      Search parameter constant for period

      Description:
      Type: date
      Path: Account.coveragePeriod

      See Also:
      Constant Field Values
    • PERIOD

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

      Description:
      Type: date
      Path: Account.coveragePeriod

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter constant for subject

      Description:
      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:
      Type: reference
      Path: Account.subject

    • SP_OWNER

      public static final String SP_OWNER
      Search parameter constant for owner

      Description:
      Type: reference
      Path: Account.owner

      See Also:
      Constant Field Values
    • OWNER

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

      Description:
      Type: reference
      Path: Account.owner

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter constant for patient

      Description:
      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:
      Type: reference
      Path: Account.subject

    • 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".
    • 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".
    • 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".
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getIdentifier

      Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

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

    • setIdentifier

      public Account setIdentifier​(List<IdentifierDt> theValue)
      Sets the value(s) for identifier ()

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

    • addIdentifier

      Adds and returns a new value for identifier ()

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

    • addIdentifier

      public Account addIdentifier​(IdentifierDt theValue)
      Adds a given new value for identifier ()

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

      Parameters:
      theValue - The identifier to add (must not be null)
    • getIdentifierFirstRep

      Gets the first repetition for identifier (), creating it if it does not already exist.

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

    • getNameElement

      public ca.uhn.fhir.model.primitive.StringDt getNameElement()
      Gets the value(s) for name (). creating it if it does not exist. Will not return null.

      Definition: Name used for the account when displaying it to humans in reports, etc.

    • getName

      public String getName()
      Gets the value(s) for name (). creating it if it does not exist. This method may return null.

      Definition: Name used for the account when displaying it to humans in reports, etc.

    • setName

      public Account setName​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for name ()

      Definition: Name used for the account when displaying it to humans in reports, etc.

    • setName

      public Account setName​(String theString)
      Sets the value for name ()

      Definition: Name used for the account when displaying it to humans in reports, etc.

    • getType

      Gets the value(s) for type (). creating it if it does not exist. Will not return null.

      Definition: Categorizes the account for reporting and searching purposes

    • setType

      public Account setType​(CodeableConceptDt theValue)
      Sets the value(s) for type ()

      Definition: Categorizes the account for reporting and searching purposes

    • getStatusElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<AccountStatusEnum> getStatusElement()
      Gets the value(s) for status (). creating it if it does not exist. Will not return null.

      Definition: Indicates whether the account is presently used/useable or not

    • getStatus

      public String getStatus()
      Gets the value(s) for status (). creating it if it does not exist. This method may return null.

      Definition: Indicates whether the account is presently used/useable or not

    • setStatus

      public Account setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<AccountStatusEnum> theValue)
      Sets the value(s) for status ()

      Definition: Indicates whether the account is presently used/useable or not

    • setStatus

      public Account setStatus​(AccountStatusEnum theValue)
      Sets the value(s) for status ()

      Definition: Indicates whether the account is presently used/useable or not

    • getActivePeriod

      Gets the value(s) for activePeriod (). creating it if it does not exist. Will not return null.

      Definition: Indicates the period of time over which the account is allowed

    • setActivePeriod

      public Account setActivePeriod​(PeriodDt theValue)
      Sets the value(s) for activePeriod ()

      Definition: Indicates the period of time over which the account is allowed

    • getCurrency

      Gets the value(s) for currency (). creating it if it does not exist. Will not return null.

      Definition: Identifies the currency to which transactions must be converted when crediting or debiting the account.

    • setCurrency

      public Account setCurrency​(CodingDt theValue)
      Sets the value(s) for currency ()

      Definition: Identifies the currency to which transactions must be converted when crediting or debiting the account.

    • getBalance

      public MoneyDt getBalance()
      Gets the value(s) for balance (). creating it if it does not exist. Will not return null.

      Definition: Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.

    • setBalance

      public Account setBalance​(MoneyDt theValue)
      Sets the value(s) for balance ()

      Definition: Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.

    • getCoveragePeriod

      Gets the value(s) for coveragePeriod (). creating it if it does not exist. Will not return null.

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

    • setCoveragePeriod

      public Account setCoveragePeriod​(PeriodDt theValue)
      Sets the value(s) for coveragePeriod ()

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

    • getSubject

      Gets the value(s) for subject (). creating it if it does not exist. Will not return null.

      Definition: Identifies the patient, device, practitioner, location or other object the account is associated with

    • setSubject

      public Account setSubject​(ResourceReferenceDt theValue)
      Sets the value(s) for subject ()

      Definition: Identifies the patient, device, practitioner, location or other object the account is associated with

    • getOwner

      Gets the value(s) for owner (). creating it if it does not exist. Will not return null.

      Definition: Indicates the organization, department, etc. with responsibility for the account.

    • setOwner

      public Account setOwner​(ResourceReferenceDt theValue)
      Sets the value(s) for owner ()

      Definition: Indicates the organization, department, etc. with responsibility for the account.

    • getDescriptionElement

      public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
      Gets the value(s) for description (). creating it if it does not exist. Will not return null.

      Definition: Provides additional information about what the account tracks and how it is used

    • getDescription

      Gets the value(s) for description (). creating it if it does not exist. This method may return null.

      Definition: Provides additional information about what the account tracks and how it is used

    • setDescription

      public Account setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for description ()

      Definition: Provides additional information about what the account tracks and how it is used

    • setDescription

      public Account setDescription​(String theString)
      Sets the value for description ()

      Definition: Provides additional information about what the account tracks and how it is used

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource