Class Account
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.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 classAccount.AccountStatusstatic classAccount.AccountStatusEnumFactorystatic classAccount.CoverageComponentstatic classAccount.GuarantorComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<Account.CoverageComponent>coverageThe party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.protected StringTypedescriptionProvides additional information about what the account tracks and how it is used.protected List<Account.GuarantorComponent>guarantorThe parties responsible for balancing the account if other payment options fall short.protected List<Identifier>identifierUnique identifier used to reference the account.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_OWNERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.protected StringTypenameName used for the account when displaying it to humans in reports, etc.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected ReferenceownerIndicates the service area, hospital, department, etc.static ca.uhn.fhir.rest.gclient.ReferenceClientParamOWNERFluent Client search parameter constant for ownerprotected OrganizationownerTargetThe actual object that is the target of the reference (Indicates the service area, hospital, department, etc.protected ReferencepartOfReference to a parent Account.protected AccountpartOfTargetThe actual object that is the target of the reference (Reference to a parent Account.)static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientstatic ca.uhn.fhir.rest.gclient.DateClientParamPERIODFluent Client search parameter constant for periodprotected PeriodservicePeriodThe date range of services associated with this account.static StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_NAMESearch parameter: namestatic StringSP_OWNERSearch parameter: ownerstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PERIODSearch parameter: periodstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectstatic StringSP_TYPESearch parameter: typeprotected Enumeration<Account.AccountStatus>statusIndicates whether the account is presently used/usable or not.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected List<Reference>subjectIdentifies the entity which incurs the expenses.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected List<Resource>subjectTargetThe actual objects that are the target of the reference (Identifies the entity which incurs the expenses.protected CodeableConcepttypeCategorizes the account for reporting and searching purposes.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for type-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Account()ConstructorAccount(Enumeration<Account.AccountStatus> status)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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. Might or might 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 List<Reference> subject
Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.
-
subjectTarget
protected List<Resource> subjectTarget
The actual objects that are the target of the reference (Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.)
-
servicePeriod
protected Period servicePeriod
The date range of services associated with this account.
-
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 service area, hospital, department, etc. with responsibility for managing the Account.
-
ownerTarget
protected Organization ownerTarget
The actual object that is the target of the reference (Indicates the service area, hospital, department, etc. with responsibility for managing 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
The parties responsible for balancing the account if other payment options fall short.
-
partOfTarget
protected Account partOfTarget
The actual object that is the target of the reference (Reference to a parent Account.)
-
SP_OWNER
public static final String SP_OWNER
Search parameter: ownerDescription: Entity managing the Account
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: Entity managing the Account
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.servicePeriod
- 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.servicePeriod
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: The entity that caused the expenses
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: The entity that caused the expenses
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: The entity that caused the expenses
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: The entity that caused the expenses
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 | on-hold | unknown
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 | on-hold | unknown
Type: token
Path: Account.status
-
-
Constructor Detail
-
Account
public Account()
Constructor
-
Account
public Account(Enumeration<Account.AccountStatus> status)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).)
-
setIdentifier
public Account setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor 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 List<Reference> getSubject()
- Returns:
subject(Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.)
-
setSubject
public Account setSubject(List<Reference> theSubject)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSubject
public boolean hasSubject()
-
addSubject
public Reference addSubject()
-
addSubject
public Account addSubject(Reference t)
-
getSubjectFirstRep
public Reference getSubjectFirstRep()
- Returns:
- The first repetition of repeating field
subject, creating it if it does not already exist
-
getSubjectTarget
@Deprecated public List<Resource> getSubjectTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getServicePeriod
public Period getServicePeriod()
- Returns:
servicePeriod(The date range of services associated with this account.)
-
hasServicePeriod
public boolean hasServicePeriod()
-
setServicePeriod
public Account setServicePeriod(Period value)
- Parameters:
value-servicePeriod(The date range of services associated with this account.)
-
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
thisfor 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 service area, hospital, department, etc. with responsibility for managing the Account.)
-
hasOwner
public boolean hasOwner()
-
setOwner
public Account setOwner(Reference value)
- Parameters:
value-owner(Indicates the service area, hospital, department, etc. with responsibility for managing the Account.)
-
getOwnerTarget
public Organization getOwnerTarget()
- Returns:
ownerThe 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 service area, hospital, department, etc. with responsibility for managing the Account.)
-
setOwnerTarget
public Account setOwnerTarget(Organization value)
- Parameters:
value-ownerThe 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 service area, hospital, department, etc. with responsibility for managing 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(The parties responsible for balancing the account if other payment options fall short.)
-
setGuarantor
public Account setGuarantor(List<Account.GuarantorComponent> theGuarantor)
- Returns:
- Returns a reference to
thisfor 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
-
hasPartOf
public boolean hasPartOf()
-
setPartOf
public Account setPartOf(Reference value)
- Parameters:
value-partOf(Reference to a parent Account.)
-
getPartOfTarget
public Account getPartOfTarget()
- Returns:
partOfThe 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. (Reference to a parent Account.)
-
setPartOfTarget
public Account setPartOfTarget(Account value)
- Parameters:
value-partOfThe 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. (Reference to a parent Account.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Account copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Account dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-