
Class Account
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.model.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 centers, etc.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Account.AccountStatus
static class
Account.AccountStatusEnumFactory
static class
Account.CoverageComponent
static class
Account.GuarantorComponent
-
Field Summary
Fields Modifier and Type Field Description protected Period
active
Indicates the period of time over which the account is allowed to have transactions posted to it.protected Money
balance
Represents the sum of all credits less all debits associated with the account.static ca.uhn.fhir.rest.gclient.QuantityClientParam
BALANCE
Fluent Client search parameter constant for balanceprotected List<Account.CoverageComponent>
coverage
The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.protected StringType
description
Provides additional information about what the account tracks and how it is used.protected List<Account.GuarantorComponent>
guarantor
Parties financially responsible for the account.protected List<Identifier>
identifier
Unique identifier used to reference the account.static ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_OWNER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.protected StringType
name
Name used for the account when displaying it to humans in reports, etc.static ca.uhn.fhir.rest.gclient.StringClientParam
NAME
Fluent Client search parameter constant for nameprotected Reference
owner
Indicates the organization, department, etc.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
OWNER
Fluent Client search parameter constant for ownerprotected Organization
ownerTarget
The actual object that is the target of the reference (Indicates the organization, department, etc.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientprotected Period
period
Identifies the period of time the account applies to; e.g.static ca.uhn.fhir.rest.gclient.DateClientParam
PERIOD
Fluent Client search parameter constant for periodstatic String
SP_BALANCE
Search parameter: balancestatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_NAME
Search parameter: namestatic String
SP_OWNER
Search parameter: ownerstatic String
SP_PATIENT
Search parameter: patientstatic String
SP_PERIOD
Search parameter: periodstatic String
SP_STATUS
Search parameter: statusstatic String
SP_SUBJECT
Search parameter: subjectstatic String
SP_TYPE
Search parameter: typeprotected Enumeration<Account.AccountStatus>
status
Indicates whether the account is presently used/usable or not.static ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusprotected Reference
subject
Identifies the patient, device, practitioner, location or other object the account is associated with.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUBJECT
Fluent Client search parameter constant for subjectprotected 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.)protected CodeableConcept
type
Categorizes the account for reporting and searching purposes.static ca.uhn.fhir.rest.gclient.TokenClientParam
TYPE
Fluent Client search parameter constant for type-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Account()
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
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).
-
status
protected Enumeration<Account.AccountStatus> status
Indicates whether the account is presently used/usable or not.
-
type
protected CodeableConcept type
Categorizes the account for reporting and searching purposes.
-
name
protected StringType name
Name used for the account when displaying it to humans in reports, 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.)
-
period
protected Period period
Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.
-
active
protected Period active
Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur.
-
balance
protected Money balance
Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.
-
coverage
protected List<Account.CoverageComponent> coverage
The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.
-
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.
-
guarantor
protected List<Account.GuarantorComponent> guarantor
Parties financially responsible for the account.
-
SP_OWNER
public static final String SP_OWNER
Search parameter: ownerDescription: Who is responsible?
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 ownerDescription: 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".
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Account number
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 identifierDescription: Account number
Type: token
Path: Account.identifier
-
SP_PERIOD
public static final String SP_PERIOD
Search parameter: periodDescription: Transaction window
Type: date
Path: Account.period
- See Also:
- Constant Field Values
-
PERIOD
public static final ca.uhn.fhir.rest.gclient.DateClientParam PERIOD
Fluent Client search parameter constant for periodDescription: Transaction window
Type: date
Path: Account.period
-
SP_BALANCE
public static final String SP_BALANCE
Search parameter: balanceDescription: How much is in account?
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 balanceDescription: How much is in account?
Type: quantity
Path: Account.balance
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: 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 subjectDescription: 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".
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: 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 patientDescription: 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".
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Human-readable label
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 nameDescription: Human-readable label
Type: string
Path: Account.name
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: 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 typeDescription: E.g. patient, expense, depreciation
Type: token
Path: Account.type
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: active | inactive | entered-in-error
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 statusDescription: active | inactive | entered-in-error
Type: token
Path: Account.status
-
-
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).)
-
setIdentifier
public Account setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public Account addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getStatusElement
public Enumeration<Account.AccountStatus> getStatusElement()
- Returns:
status
(Indicates whether the account is presently used/usable or not.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public Account setStatusElement(Enumeration<Account.AccountStatus> value)
- Parameters:
value
-status
(Indicates whether the account is presently used/usable or not.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Account.AccountStatus getStatus()
- Returns:
- Indicates whether the account is presently used/usable or not.
-
setStatus
public Account setStatus(Account.AccountStatus value)
- Parameters:
value
- Indicates whether the account is presently used/usable or not.
-
getType
public CodeableConcept getType()
- Returns:
type
(Categorizes the account for reporting and searching purposes.)
-
hasType
public boolean hasType()
-
setType
public Account setType(CodeableConcept value)
- Parameters:
value
-type
(Categorizes the account for reporting and searching purposes.)
-
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
-
hasNameElement
public boolean hasNameElement()
-
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.
-
getSubject
public Reference getSubject()
- Returns:
subject
(Identifies the patient, device, practitioner, location or other object the account is associated with.)
-
hasSubject
public boolean hasSubject()
-
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.)
-
getPeriod
public Period getPeriod()
- Returns:
period
(Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.)
-
hasPeriod
public boolean hasPeriod()
-
setPeriod
public Account setPeriod(Period value)
- Parameters:
value
-period
(Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.)
-
getActive
public Period getActive()
- Returns:
active
(Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur.)
-
hasActive
public boolean hasActive()
-
setActive
public Account setActive(Period value)
- Parameters:
value
-active
(Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur.)
-
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.)
-
hasBalance
public boolean hasBalance()
-
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.)
-
getCoverage
public List<Account.CoverageComponent> getCoverage()
- Returns:
coverage
(The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.)
-
setCoverage
public Account setCoverage(List<Account.CoverageComponent> theCoverage)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCoverage
public boolean hasCoverage()
-
addCoverage
public Account.CoverageComponent addCoverage()
-
addCoverage
public Account addCoverage(Account.CoverageComponent t)
-
getCoverageFirstRep
public Account.CoverageComponent getCoverageFirstRep()
- Returns:
- The first repetition of repeating field
coverage
, creating it if it does not already exist
-
getOwner
public Reference getOwner()
- Returns:
owner
(Indicates the organization, department, etc. with responsibility for the account.)
-
hasOwner
public boolean hasOwner()
-
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
-
hasDescriptionElement
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
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.
-
getGuarantor
public List<Account.GuarantorComponent> getGuarantor()
- Returns:
guarantor
(Parties financially responsible for the account.)
-
setGuarantor
public Account setGuarantor(List<Account.GuarantorComponent> theGuarantor)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasGuarantor
public boolean hasGuarantor()
-
addGuarantor
public Account.GuarantorComponent addGuarantor()
-
addGuarantor
public Account addGuarantor(Account.GuarantorComponent t)
-
getGuarantorFirstRep
public Account.GuarantorComponent getGuarantorFirstRep()
- Returns:
- The first repetition of repeating field
guarantor
, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public Account copy()
- Specified by:
copy
in classDomainResource
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-