Class ChargeItemDefinition
- java.lang.Object
-
- org.hl7.fhir.r4b.model.Base
-
- org.hl7.fhir.r4b.model.BaseResource
-
- org.hl7.fhir.r4b.model.Resource
-
- org.hl7.fhir.r4b.model.DomainResource
-
- org.hl7.fhir.r4b.model.ChargeItemDefinition
-
- 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 ChargeItemDefinition extends DomainResource
The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classChargeItemDefinition.ChargeItemDefinitionApplicabilityComponentstatic classChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponentstatic classChargeItemDefinition.ChargeItemDefinitionPropertyGroupPriceComponentComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent>applicabilityExpressions that describe applicability criteria for the billing code.protected DateTypeapprovalDateThe date on which the resource content was approved by the publisher.protected CodeableConceptcodeThe defined billing details in this resource pertain to the given billing code.protected List<ContactDetail>contactContact details to assist a user in finding and communicating with the publisher.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamCONTEXT_QUANTITYFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXT_TYPEFluent Client search parameter constant for context-typestatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantitystatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueprotected MarkdownTypecopyrightA copyright statement relating to the charge item definition and/or its contents.protected DateTimeTypedateThe date (and optionally time) when the charge item definition was published.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected List<UriType>derivedFromUriThe URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.protected MarkdownTypedescriptionA free text natural language description of the charge item definition from a consumer's perspective.static ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionstatic ca.uhn.fhir.rest.gclient.DateClientParamEFFECTIVEFluent Client search parameter constant for effectiveprotected PeriodeffectivePeriodThe period during which the charge item definition content was or is planned to be in active use.protected BooleanTypeexperimentalA Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.protected List<Identifier>identifierA formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierprotected List<Reference>instanceThe defined billing details in this resource pertain to the given product instance(s).protected List<CodeableConcept>jurisdictionA legal or geographic region in which the charge item definition is intended to be used.static ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionprotected DateTypelastReviewDateThe date on which the resource content was last reviewed.protected List<CanonicalType>partOfA larger definition of which this particular definition is a component or step.protected List<ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent>propertyGroupGroup of properties which are applicable under the same conditions.protected StringTypepublisherThe name of the organization or individual that published the charge item definition.static ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected List<CanonicalType>replacesAs new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.static StringSP_CONTEXTSearch parameter: contextstatic StringSP_CONTEXT_QUANTITYSearch parameter: context-quantitystatic StringSP_CONTEXT_TYPESearch parameter: context-typestatic StringSP_CONTEXT_TYPE_QUANTITYSearch parameter: context-type-quantitystatic StringSP_CONTEXT_TYPE_VALUESearch parameter: context-type-valuestatic StringSP_DATESearch parameter: datestatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_EFFECTIVESearch parameter: effectivestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_STATUSSearch parameter: statusstatic StringSP_TITLESearch parameter: titlestatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionprotected Enumeration<Enumerations.PublicationStatus>statusThe current state of the ChargeItemDefinition.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected StringTypetitleA short, descriptive, user-friendly title for the charge item definition.static ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titleprotected UriTypeurlAn absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier.static ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected List<UsageContext>useContextThe content was developed with a focus and intent of supporting the contexts that are listed.protected StringTypeversionThe identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance.static ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.r4b.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r4b.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ChargeItemDefinition()ConstructorChargeItemDefinition(String url, Enumerations.PublicationStatus status)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4b.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4b.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.r4b.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4b.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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
-
url
protected UriType url
An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.
-
identifier
protected List<Identifier> identifier
A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version
protected StringType version
The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
-
title
protected StringType title
A short, descriptive, user-friendly title for the charge item definition.
-
derivedFromUri
protected List<UriType> derivedFromUri
The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.
-
partOf
protected List<CanonicalType> partOf
A larger definition of which this particular definition is a component or step.
-
replaces
protected List<CanonicalType> replaces
As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
The current state of the ChargeItemDefinition.
-
experimental
protected BooleanType experimental
A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
date
protected DateTimeType date
The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.
-
publisher
protected StringType publisher
The name of the organization or individual that published the charge item definition.
-
contact
protected List<ContactDetail> contact
Contact details to assist a user in finding and communicating with the publisher.
-
description
protected MarkdownType description
A free text natural language description of the charge item definition from a consumer's perspective.
-
useContext
protected List<UsageContext> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.
-
jurisdiction
protected List<CodeableConcept> jurisdiction
A legal or geographic region in which the charge item definition is intended to be used.
-
copyright
protected MarkdownType copyright
A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.
-
approvalDate
protected DateType approvalDate
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate
protected DateType lastReviewDate
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
effectivePeriod
protected Period effectivePeriod
The period during which the charge item definition content was or is planned to be in active use.
-
code
protected CodeableConcept code
The defined billing details in this resource pertain to the given billing code.
-
instance
protected List<Reference> instance
The defined billing details in this resource pertain to the given product instance(s).
-
applicability
protected List<ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent> applicability
Expressions that describe applicability criteria for the billing code.
-
propertyGroup
protected List<ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent> propertyGroup
Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.
-
SP_CONTEXT_QUANTITY
public static final String SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the charge item definition
Type: quantity
Path: (ChargeItemDefinition.useContext.value as Quantity) | (ChargeItemDefinition.useContext.value as Range)
- See Also:
- Constant Field Values
-
CONTEXT_QUANTITY
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the charge item definition
Type: quantity
Path: (ChargeItemDefinition.useContext.value as Quantity) | (ChargeItemDefinition.useContext.value as Range)
-
SP_CONTEXT_TYPE_QUANTITY
public static final String SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the charge item definition
Type: composite
Path: ChargeItemDefinition.useContext
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_QUANTITY
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
Fluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the charge item definition
Type: composite
Path: ChargeItemDefinition.useContext
-
SP_CONTEXT_TYPE_VALUE
public static final String SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the charge item definition
Type: composite
Path: ChargeItemDefinition.useContext
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_VALUE
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
Fluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the charge item definition
Type: composite
Path: ChargeItemDefinition.useContext
-
SP_CONTEXT_TYPE
public static final String SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the charge item definition
Type: token
Path: ChargeItemDefinition.useContext.code
- See Also:
- Constant Field Values
-
CONTEXT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the charge item definition
Type: token
Path: ChargeItemDefinition.useContext.code
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the charge item definition
Type: token
Path: (ChargeItemDefinition.useContext.value as CodeableConcept)
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the charge item definition
Type: token
Path: (ChargeItemDefinition.useContext.value as CodeableConcept)
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: The charge item definition publication date
Type: date
Path: ChargeItemDefinition.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: The charge item definition publication date
Type: date
Path: ChargeItemDefinition.date
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the charge item definition
Type: string
Path: ChargeItemDefinition.description
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the charge item definition
Type: string
Path: ChargeItemDefinition.description
-
SP_EFFECTIVE
public static final String SP_EFFECTIVE
Search parameter: effectiveDescription: The time during which the charge item definition is intended to be in use
Type: date
Path: ChargeItemDefinition.effectivePeriod
- See Also:
- Constant Field Values
-
EFFECTIVE
public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE
Fluent Client search parameter constant for effectiveDescription: The time during which the charge item definition is intended to be in use
Type: date
Path: ChargeItemDefinition.effectivePeriod
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the charge item definition
Type: token
Path: ChargeItemDefinition.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the charge item definition
Type: token
Path: ChargeItemDefinition.identifier
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the charge item definition
Type: token
Path: ChargeItemDefinition.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the charge item definition
Type: token
Path: ChargeItemDefinition.jurisdiction
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the charge item definition
Type: string
Path: ChargeItemDefinition.publisher
- See Also:
- Constant Field Values
-
PUBLISHER
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the charge item definition
Type: string
Path: ChargeItemDefinition.publisher
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The current status of the charge item definition
Type: token
Path: ChargeItemDefinition.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: The current status of the charge item definition
Type: token
Path: ChargeItemDefinition.status
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: The human-friendly name of the charge item definition
Type: string
Path: ChargeItemDefinition.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the charge item definition
Type: string
Path: ChargeItemDefinition.title
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The uri that identifies the charge item definition
Type: uri
Path: ChargeItemDefinition.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the charge item definition
Type: uri
Path: ChargeItemDefinition.url
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: The business version of the charge item definition
Type: token
Path: ChargeItemDefinition.version
- See Also:
- Constant Field Values
-
VERSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Fluent Client search parameter constant for versionDescription: The business version of the charge item definition
Type: token
Path: ChargeItemDefinition.version
-
-
Constructor Detail
-
ChargeItemDefinition
public ChargeItemDefinition()
Constructor
-
ChargeItemDefinition
public ChargeItemDefinition(String url, Enumerations.PublicationStatus status)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Returns:
url(An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
-
hasUrl
public boolean hasUrl()
-
setUrlElement
public ChargeItemDefinition setUrlElement(UriType value)
- Parameters:
value-url(An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Returns:
- An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.
-
setUrl
public ChargeItemDefinition setUrl(String value)
- Parameters:
value- An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.)
-
setIdentifier
public ChargeItemDefinition setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public ChargeItemDefinition addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getVersionElement
public StringType getVersionElement()
- Returns:
version(The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
public boolean hasVersionElement()
-
hasVersion
public boolean hasVersion()
-
setVersionElement
public ChargeItemDefinition setVersionElement(StringType value)
- Parameters:
value-version(The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
public String getVersion()
- Returns:
- The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
-
setVersion
public ChargeItemDefinition setVersion(String value)
- Parameters:
value- The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
-
getTitleElement
public StringType getTitleElement()
- Returns:
title(A short, descriptive, user-friendly title for the charge item definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
public boolean hasTitleElement()
-
hasTitle
public boolean hasTitle()
-
setTitleElement
public ChargeItemDefinition setTitleElement(StringType value)
- Parameters:
value-title(A short, descriptive, user-friendly title for the charge item definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
public String getTitle()
- Returns:
- A short, descriptive, user-friendly title for the charge item definition.
-
setTitle
public ChargeItemDefinition setTitle(String value)
- Parameters:
value- A short, descriptive, user-friendly title for the charge item definition.
-
getDerivedFromUri
public List<UriType> getDerivedFromUri()
- Returns:
derivedFromUri(The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.)
-
setDerivedFromUri
public ChargeItemDefinition setDerivedFromUri(List<UriType> theDerivedFromUri)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDerivedFromUri
public boolean hasDerivedFromUri()
-
addDerivedFromUriElement
public UriType addDerivedFromUriElement()
- Returns:
derivedFromUri(The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.)
-
addDerivedFromUri
public ChargeItemDefinition addDerivedFromUri(String value)
- Parameters:
value-derivedFromUri(The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.)
-
hasDerivedFromUri
public boolean hasDerivedFromUri(String value)
- Parameters:
value-derivedFromUri(The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.)
-
getPartOf
public List<CanonicalType> getPartOf()
- Returns:
partOf(A larger definition of which this particular definition is a component or step.)
-
setPartOf
public ChargeItemDefinition setPartOf(List<CanonicalType> thePartOf)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPartOf
public boolean hasPartOf()
-
addPartOfElement
public CanonicalType addPartOfElement()
- Returns:
partOf(A larger definition of which this particular definition is a component or step.)
-
addPartOf
public ChargeItemDefinition addPartOf(String value)
- Parameters:
value-partOf(A larger definition of which this particular definition is a component or step.)
-
hasPartOf
public boolean hasPartOf(String value)
- Parameters:
value-partOf(A larger definition of which this particular definition is a component or step.)
-
getReplaces
public List<CanonicalType> getReplaces()
- Returns:
replaces(As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.)
-
setReplaces
public ChargeItemDefinition setReplaces(List<CanonicalType> theReplaces)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReplaces
public boolean hasReplaces()
-
addReplacesElement
public CanonicalType addReplacesElement()
- Returns:
replaces(As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.)
-
addReplaces
public ChargeItemDefinition addReplaces(String value)
- Parameters:
value-replaces(As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.)
-
hasReplaces
public boolean hasReplaces(String value)
- Parameters:
value-replaces(As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.)
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Returns:
status(The current state of the ChargeItemDefinition.). 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 ChargeItemDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Parameters:
value-status(The current state of the ChargeItemDefinition.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Returns:
- The current state of the ChargeItemDefinition.
-
setStatus
public ChargeItemDefinition setStatus(Enumerations.PublicationStatus value)
- Parameters:
value- The current state of the ChargeItemDefinition.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Returns:
experimental(A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
hasExperimentalElement
public boolean hasExperimentalElement()
-
hasExperimental
public boolean hasExperimental()
-
setExperimentalElement
public ChargeItemDefinition setExperimentalElement(BooleanType value)
- Parameters:
value-experimental(A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
getExperimental
public boolean getExperimental()
- Returns:
- A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
setExperimental
public ChargeItemDefinition setExperimental(boolean value)
- Parameters:
value- A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
getDateElement
public DateTimeType getDateElement()
- Returns:
date(The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
-
hasDate
public boolean hasDate()
-
setDateElement
public ChargeItemDefinition setDateElement(DateTimeType value)
- Parameters:
value-date(The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Returns:
- The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.
-
setDate
public ChargeItemDefinition setDate(Date value)
- Parameters:
value- The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.
-
getPublisherElement
public StringType getPublisherElement()
- Returns:
publisher(The name of the organization or individual that published the charge item definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
public boolean hasPublisherElement()
-
hasPublisher
public boolean hasPublisher()
-
setPublisherElement
public ChargeItemDefinition setPublisherElement(StringType value)
- Parameters:
value-publisher(The name of the organization or individual that published the charge item definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
public String getPublisher()
- Returns:
- The name of the organization or individual that published the charge item definition.
-
setPublisher
public ChargeItemDefinition setPublisher(String value)
- Parameters:
value- The name of the organization or individual that published the charge item definition.
-
getContact
public List<ContactDetail> getContact()
- Returns:
contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public ChargeItemDefinition setContact(List<ContactDetail> theContact)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
-
addContact
public ContactDetail addContact()
-
addContact
public ChargeItemDefinition addContact(ContactDetail t)
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist {3}
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Returns:
description(A free text natural language description of the charge item definition from a consumer's perspective.). 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 ChargeItemDefinition setDescriptionElement(MarkdownType value)
- Parameters:
value-description(A free text natural language description of the charge item definition from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Returns:
- A free text natural language description of the charge item definition from a consumer's perspective.
-
setDescription
public ChargeItemDefinition setDescription(String value)
- Parameters:
value- A free text natural language description of the charge item definition from a consumer's perspective.
-
getUseContext
public List<UsageContext> getUseContext()
- Returns:
useContext(The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.)
-
setUseContext
public ChargeItemDefinition setUseContext(List<UsageContext> theUseContext)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
-
addUseContext
public UsageContext addUseContext()
-
addUseContext
public ChargeItemDefinition addUseContext(UsageContext t)
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Returns:
- The first repetition of repeating field
useContext, creating it if it does not already exist {3}
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Returns:
jurisdiction(A legal or geographic region in which the charge item definition is intended to be used.)
-
setJurisdiction
public ChargeItemDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
-
addJurisdiction
public CodeableConcept addJurisdiction()
-
addJurisdiction
public ChargeItemDefinition addJurisdiction(CodeableConcept t)
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Returns:
- The first repetition of repeating field
jurisdiction, creating it if it does not already exist {3}
-
getCopyrightElement
public MarkdownType getCopyrightElement()
- Returns:
copyright(A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
public boolean hasCopyrightElement()
-
hasCopyright
public boolean hasCopyright()
-
setCopyrightElement
public ChargeItemDefinition setCopyrightElement(MarkdownType value)
- Parameters:
value-copyright(A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
public String getCopyright()
- Returns:
- A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.
-
setCopyright
public ChargeItemDefinition setCopyright(String value)
- Parameters:
value- A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.
-
getApprovalDateElement
public DateType getApprovalDateElement()
- Returns:
approvalDate(The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
hasApprovalDateElement
public boolean hasApprovalDateElement()
-
hasApprovalDate
public boolean hasApprovalDate()
-
setApprovalDateElement
public ChargeItemDefinition setApprovalDateElement(DateType value)
- Parameters:
value-approvalDate(The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
getApprovalDate
public Date getApprovalDate()
- Returns:
- The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
setApprovalDate
public ChargeItemDefinition setApprovalDate(Date value)
- Parameters:
value- The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
getLastReviewDateElement
public DateType getLastReviewDateElement()
- Returns:
lastReviewDate(The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
hasLastReviewDateElement
public boolean hasLastReviewDateElement()
-
hasLastReviewDate
public boolean hasLastReviewDate()
-
setLastReviewDateElement
public ChargeItemDefinition setLastReviewDateElement(DateType value)
- Parameters:
value-lastReviewDate(The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
getLastReviewDate
public Date getLastReviewDate()
- Returns:
- The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
setLastReviewDate
public ChargeItemDefinition setLastReviewDate(Date value)
- Parameters:
value- The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
getEffectivePeriod
public Period getEffectivePeriod()
- Returns:
effectivePeriod(The period during which the charge item definition content was or is planned to be in active use.)
-
hasEffectivePeriod
public boolean hasEffectivePeriod()
-
setEffectivePeriod
public ChargeItemDefinition setEffectivePeriod(Period value)
- Parameters:
value-effectivePeriod(The period during which the charge item definition content was or is planned to be in active use.)
-
getCode
public CodeableConcept getCode()
- Returns:
code(The defined billing details in this resource pertain to the given billing code.)
-
hasCode
public boolean hasCode()
-
setCode
public ChargeItemDefinition setCode(CodeableConcept value)
- Parameters:
value-code(The defined billing details in this resource pertain to the given billing code.)
-
getInstance
public List<Reference> getInstance()
- Returns:
instance(The defined billing details in this resource pertain to the given product instance(s).)
-
setInstance
public ChargeItemDefinition setInstance(List<Reference> theInstance)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInstance
public boolean hasInstance()
-
addInstance
public Reference addInstance()
-
addInstance
public ChargeItemDefinition addInstance(Reference t)
-
getInstanceFirstRep
public Reference getInstanceFirstRep()
- Returns:
- The first repetition of repeating field
instance, creating it if it does not already exist {3}
-
getApplicability
public List<ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent> getApplicability()
- Returns:
applicability(Expressions that describe applicability criteria for the billing code.)
-
setApplicability
public ChargeItemDefinition setApplicability(List<ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent> theApplicability)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasApplicability
public boolean hasApplicability()
-
addApplicability
public ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent addApplicability()
-
addApplicability
public ChargeItemDefinition addApplicability(ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent t)
-
getApplicabilityFirstRep
public ChargeItemDefinition.ChargeItemDefinitionApplicabilityComponent getApplicabilityFirstRep()
- Returns:
- The first repetition of repeating field
applicability, creating it if it does not already exist {3}
-
getPropertyGroup
public List<ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent> getPropertyGroup()
- Returns:
propertyGroup(Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.)
-
setPropertyGroup
public ChargeItemDefinition setPropertyGroup(List<ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent> thePropertyGroup)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPropertyGroup
public boolean hasPropertyGroup()
-
addPropertyGroup
public ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent addPropertyGroup()
-
addPropertyGroup
public ChargeItemDefinition addPropertyGroup(ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent t)
-
getPropertyGroupFirstRep
public ChargeItemDefinition.ChargeItemDefinitionPropertyGroupComponent getPropertyGroupFirstRep()
- Returns:
- The first repetition of repeating field
propertyGroup, creating it if it does not already exist {3}
-
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 ChargeItemDefinition copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(ChargeItemDefinition dst)
-
typedCopy
protected ChargeItemDefinition typedCopy()
-
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
-
-