Private OptionalurlChargeItemDefinition.url Element
FHIR Specification
uriPrivate OptionalidentifierChargeItemDefinition.identifier Element
FHIR Specification
IdentifierPrivate OptionalversionChargeItemDefinition.version Element
FHIR Specification
stringPrivate OptionalversionChargeItemDefinition.versionAlgorithm[x] Element
FHIR Specification
Private OptionalnameChargeItemDefinition.name Element
FHIR Specification
stringPrivate OptionaltitleChargeItemDefinition.title Element
FHIR Specification
stringPrivate OptionalderivedChargeItemDefinition.derivedFromUri Element
Private OptionalpartChargeItemDefinition.partOf Element
FHIR Specification
canonical
Private OptionalreplacesChargeItemDefinition.replaces Element
FHIR Specification
canonical
Private ReadonlypublicationFHIR CodeSystem: PublicationStatus
PrivatestatusChargeItemDefinition.status Element
FHIR Specification
codeCodeSystem Enumeration: PublicationStatusEnum
Private OptionalexperimentalChargeItemDefinition.experimental Element
FHIR Specification
booleanPrivate OptionaldateChargeItemDefinition.date Element
FHIR Specification
dateTimePrivate OptionalpublisherChargeItemDefinition.publisher Element
FHIR Specification
stringPrivate OptionalcontactChargeItemDefinition.contact Element
FHIR Specification
ContactDetailPrivate OptionaldescriptionChargeItemDefinition.description Element
FHIR Specification
markdownPrivate OptionaluseChargeItemDefinition.useContext Element
FHIR Specification
UsageContextPrivate OptionaljurisdictionChargeItemDefinition.jurisdiction Element
FHIR Specification
CodeableConceptPrivate OptionalpurposeChargeItemDefinition.purpose Element
FHIR Specification
markdownPrivate OptionalcopyrightChargeItemDefinition.copyright Element
FHIR Specification
markdownPrivate OptionalcopyrightChargeItemDefinition.copyrightLabel Element
FHIR Specification
stringPrivate OptionalapprovalChargeItemDefinition.approvalDate Element
FHIR Specification
datePrivate OptionallastChargeItemDefinition.lastReviewDate Element
FHIR Specification
datePrivate OptionalcodeChargeItemDefinition.code Element
Private Optionalinstance_ChargeItemDefinition.instance Element
FHIR Specification
Reference
Private OptionalapplicabilityChargeItemDefinition.applicability Element
FHIR Specification
BackboneElementPrivate OptionalpropertyChargeItemDefinition.propertyGroup Element
FHIR Specification
BackboneElementStaticparseParse the provided ChargeItemDefinition JSON to instantiate the ChargeItemDefinition data model.
JSON representing FHIR ChargeItemDefinition
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ChargeItemDefinition
ChargeItemDefinition data model or undefined for ChargeItemDefinition
JsonError if the provided JSON is not a valid JSON object
the url property value as a UriType object if defined; else an empty UriType object
Assigns the provided PrimitiveType value to the url property.
the url value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the url property value as a fhirUri if defined; else undefined
Assigns the provided primitive value to the url property.
the url value
this
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the version property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the version property.
the version value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the version property exists and has a value; false otherwise
the version property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the version property.
the version value
this
PrimitiveTypeError for invalid primitive types
true if the version property exists and has a value; false otherwise
the versionAlgorithm property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the versionAlgorithm property.
the versionAlgorithm object value
this
InvalidTypeError for invalid data types
true if the versionAlgorithm property exists and has a value; false otherwise
the versionAlgorithm property value as a StringType object if defined; else undefined
true if the versionAlgorithm property exists as a StringType and has a value; false otherwise
the versionAlgorithm property value as a Coding object if defined; else undefined
true if the versionAlgorithm property exists as a Coding and has a value; false otherwise
the name property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the name property.
the name value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the name property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the name property.
the name value
this
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the title property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the title property.
the title value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the title property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the title property.
the title value
this
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the derivedFromUri property value as a UriType array
Assigns the provided UriType array value to the derivedFromUri property.
the derivedFromUri array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided UriType value to the derivedFromUri array property.
the derivedFromUri value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the derivedFromUri property exists and has a value; false otherwise
the derivedFromUri property value as a fhirUri array
Assigns the provided primitive value array to the derivedFromUri property.
the derivedFromUri value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the derivedFromUri array property.
the derivedFromUri value
this
PrimitiveTypeError for invalid primitive types
true if the derivedFromUri property exists and has a value; false otherwise
the partOf property value as a CanonicalType array
Assigns the provided CanonicalType array value to the partOf property.
the partOf array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the partOf array property.
the partOf value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the partOf property exists and has a value; false otherwise
the partOf property value as a fhirCanonical array
Assigns the provided primitive value array to the partOf property.
the partOf value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the partOf array property.
the partOf value
this
PrimitiveTypeError for invalid primitive types
true if the partOf property exists and has a value; false otherwise
the replaces property value as a CanonicalType array
Assigns the provided CanonicalType array value to the replaces property.
the replaces array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the replaces array property.
the replaces value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the replaces property exists and has a value; false otherwise
the replaces property value as a fhirCanonical array
Assigns the provided primitive value array to the replaces property.
the replaces value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the replaces array property.
the replaces value
this
PrimitiveTypeError for invalid primitive types
true if the replaces property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the experimental property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the experimental property.
the experimental value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the experimental property exists and has a value; false otherwise
the experimental property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the experimental property.
the experimental value
this
PrimitiveTypeError for invalid primitive types
true if the experimental property exists and has a value; false otherwise
the date property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the date property.
the date value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the date property exists and has a value; false otherwise
the date property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the date property.
the date value
this
PrimitiveTypeError for invalid primitive types
true if the date property exists and has a value; false otherwise
the publisher property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the publisher property.
the publisher value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the publisher property exists and has a value; false otherwise
the publisher property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the publisher property.
the publisher value
this
PrimitiveTypeError for invalid primitive types
true if the publisher property exists and has a value; false otherwise
the contact property value as a ContactDetail array
Assigns the provided ContactDetail array value to the contact property.
the contact array value
this
InvalidTypeError for invalid data types
Add the provided ContactDetail value to the contact array property.
the contact value
this
InvalidTypeError for invalid data types
true if the contact property exists and has a value; false otherwise
the description property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the description property.
the description value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the description property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the description property.
the description value
this
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the useContext property value as a UsageContext array
Assigns the provided UsageContext array value to the useContext property.
the useContext array value
this
InvalidTypeError for invalid data types
Add the provided UsageContext value to the useContext array property.
the useContext value
this
InvalidTypeError for invalid data types
true if the useContext property exists and has a value; false otherwise
the jurisdiction property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the jurisdiction property.
the jurisdiction array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the jurisdiction array property.
the jurisdiction value
this
InvalidTypeError for invalid data types
true if the jurisdiction property exists and has a value; false otherwise
the purpose property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the purpose property.
the purpose value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the purpose property exists and has a value; false otherwise
the purpose property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the purpose property.
the purpose value
this
PrimitiveTypeError for invalid primitive types
true if the purpose property exists and has a value; false otherwise
the copyright property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the copyright property.
the copyright value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the copyright property exists and has a value; false otherwise
the copyright property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the copyright property.
the copyright value
this
PrimitiveTypeError for invalid primitive types
true if the copyright property exists and has a value; false otherwise
the copyrightLabel property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the copyrightLabel property.
the copyrightLabel value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the copyrightLabel property exists and has a value; false otherwise
the copyrightLabel property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the copyrightLabel property.
the copyrightLabel value
this
PrimitiveTypeError for invalid primitive types
true if the copyrightLabel property exists and has a value; false otherwise
the approvalDate property value as a DateType object if defined; else an empty DateType object
Assigns the provided PrimitiveType value to the approvalDate property.
the approvalDate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the approvalDate property exists and has a value; false otherwise
the approvalDate property value as a fhirDate if defined; else undefined
Assigns the provided primitive value to the approvalDate property.
the approvalDate value
this
PrimitiveTypeError for invalid primitive types
true if the approvalDate property exists and has a value; false otherwise
the lastReviewDate property value as a DateType object if defined; else an empty DateType object
Assigns the provided PrimitiveType value to the lastReviewDate property.
the lastReviewDate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the lastReviewDate property exists and has a value; false otherwise
the lastReviewDate property value as a fhirDate if defined; else undefined
Assigns the provided primitive value to the lastReviewDate property.
the lastReviewDate value
this
PrimitiveTypeError for invalid primitive types
true if the lastReviewDate property exists and has a value; false otherwise
the code property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Code object value to the code property.
the code object value
this
InvalidTypeError for invalid data types
true if the code property exists and has a value; false otherwise
the instance_ property value as a Reference array
Assigns the provided Reference array value to the instance_ property.
the instance array value
this
@ReferenceTargets('ChargeItemDefinition.instance', ['Medication','Substance','Device','DeviceDefinition','ActivityDefinition','PlanDefinition','HealthcareService',])
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the instance_ array property.
the instance_ value
this
@ReferenceTargets('ChargeItemDefinition.instance', ['Medication','Substance','Device','DeviceDefinition','ActivityDefinition','PlanDefinition','HealthcareService',])
InvalidTypeError for invalid data type or reference value
true if the instance_ property exists and has a value; false otherwise
the applicability property value as a ChargeItemDefinitionApplicabilityComponent array
Assigns the provided ChargeItemDefinitionApplicabilityComponent array value to the applicability property.
the applicability array value
this
InvalidTypeError for invalid data types
Add the provided ChargeItemDefinitionApplicabilityComponent value to the applicability array property.
the applicability value
this
InvalidTypeError for invalid data types
true if the applicability property exists and has a value; false otherwise
the propertyGroup property value as a ChargeItemDefinitionPropertyGroupComponent array
Assigns the provided ChargeItemDefinitionPropertyGroupComponent array value to the propertyGroup property.
the propertyGroup array value
this
InvalidTypeError for invalid data types
Add the provided ChargeItemDefinitionPropertyGroupComponent value to the propertyGroup array property.
the propertyGroup value
this
InvalidTypeError for invalid data types
true if the propertyGroup property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the derivedFromUri property
PrivateinitInitialize the partOf property
PrivateinitInitialize the replaces property
PrivateinitInitialize the contact property
PrivateinitInitialize the useContext property
PrivateinitInitialize the jurisdiction property
PrivateinitInitialize the instance_ property
PrivateinitInitialize the applicability property
PrivateinitInitialize the propertyGroup property
ChargeItemDefinition Class
Remarks
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.
FHIR Specification
See
FHIR ChargeItemDefinition