Account (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

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:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class Account
extends BaseResource
implements 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 Summary

Fields
Modifier and Type	Field and Description
`static QuantityClientParam`	`BALANCE` Fluent Client search parameter constant for balance
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_OWNER` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static StringClientParam`	`NAME` Fluent Client search parameter constant for name
`static ReferenceClientParam`	`OWNER` Fluent Client search parameter constant for owner
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static DateClientParam`	`PERIOD` Fluent Client search parameter constant for period
`static String`	`SP_BALANCE` Search parameter constant for balance
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_NAME` Search parameter constant for name
`static String`	`SP_OWNER` Search parameter constant for owner
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_PERIOD` Search parameter constant for period
`static String`	`SP_STATUS` Search parameter constant for status
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static String`	`SP_TYPE` Search parameter constant for type
`static TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

Account()

Constructors
Constructor and Description
`Account()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier ()
`Account`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier ()
`PeriodDt`	`getActivePeriod()` Gets the value(s) for activePeriod ().
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`MoneyDt`	`getBalance()` Gets the value(s) for balance ().
`PeriodDt`	`getCoveragePeriod()` Gets the value(s) for coveragePeriod ().
`CodingDt`	`getCurrency()` Gets the value(s) for currency ().
`String`	`getDescription()` Gets the value(s) for description ().
`StringDt`	`getDescriptionElement()` Gets the value(s) for description ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier ().
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (), creating it if it does not already exist.
`String`	`getName()` Gets the value(s) for name ().
`StringDt`	`getNameElement()` Gets the value(s) for name ().
`ResourceReferenceDt`	`getOwner()` Gets the value(s) for owner ().
`String`	`getResourceName()`
`String`	`getStatus()` Gets the value(s) for status ().
`BoundCodeDt<AccountStatusEnum>`	`getStatusElement()` Gets the value(s) for status ().
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject ().
`CodeableConceptDt`	`getType()` Gets the value(s) for type ().
`boolean`	`isEmpty()`
`Account`	`setActivePeriod(PeriodDt theValue)` Sets the value(s) for activePeriod ()
`Account`	`setBalance(MoneyDt theValue)` Sets the value(s) for balance ()
`Account`	`setCoveragePeriod(PeriodDt theValue)` Sets the value(s) for coveragePeriod ()
`Account`	`setCurrency(CodingDt theValue)` Sets the value(s) for currency ()
`Account`	`setDescription(String theString)` Sets the value for description ()
`Account`	`setDescription(StringDt theValue)` Sets the value(s) for description ()
`Account`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier ()
`Account`	`setName(String theString)` Sets the value for name ()
`Account`	`setName(StringDt theValue)` Sets the value(s) for name ()
`Account`	`setOwner(ResourceReferenceDt theValue)` Sets the value(s) for owner ()
`Account`	`setStatus(AccountStatusEnum theValue)` Sets the value(s) for status ()
`Account`	`setStatus(BoundCodeDt<AccountStatusEnum> theValue)` Sets the value(s) for status ()
`Account`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject ()
`Account`	`setType(CodeableConceptDt theValue)` Sets the value(s) for type ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId

- Field Detail
  - 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 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 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 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 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 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 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 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 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 ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description:
    Type: reference
    Path: Account.subject
  - INCLUDE_OWNER
```
public static final 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 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 Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Account:subject".
- Constructor Detail
  - Account
```
public Account()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getIdentifier
```
public List<IdentifierDt> 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
```
public IdentifierDt 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
```
public IdentifierDt 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 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. Will not return null.
    Definition: Name used for the account when displaying it to humans in reports, etc.
  - setName
```
public Account setName(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
```
public CodeableConceptDt 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 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. Will not return null.
    Definition: Indicates whether the account is presently used/useable or not
  - setStatus
```
public Account setStatus(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
```
public PeriodDt 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
```
public CodingDt 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
```
public PeriodDt 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
```
public ResourceReferenceDt 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
```
public ResourceReferenceDt 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 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
```
public String getDescription()
```
    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
  - setDescription
```
public Account setDescription(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
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class Account

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

SP_IDENTIFIER

IDENTIFIER

SP_NAME

NAME

SP_TYPE

TYPE

SP_STATUS

STATUS

SP_BALANCE

BALANCE

SP_PERIOD

PERIOD

SP_SUBJECT

SUBJECT

SP_OWNER

OWNER

SP_PATIENT

PATIENT

INCLUDE_OWNER

INCLUDE_PATIENT

INCLUDE_SUBJECT

Constructor Detail

Account

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getNameElement

getName

setName

setName

getType

setType

getStatusElement

getStatus

setStatus

setStatus

getActivePeriod

setActivePeriod

getCurrency

setCurrency

getBalance

setBalance

getCoveragePeriod

setCoveragePeriod

getSubject

setSubject

getOwner

setOwner

getDescriptionElement

getDescription

setDescription

setDescription

getResourceName

getStructureFhirVersionEnum