Data Model Libraries
    Preparing search index...

    Class ContractTermAssetValuedItemComponent

    ContractTermAssetValuedItemComponent Class

    FHIR Specification

    • Short: Contract Valued Item List
    • Definition: Contract Valued Item List.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getEntity setEntity hasEntity getEntityCodeableConcept hasEntityCodeableConcept getEntityReference hasEntityReference getIdentifier setIdentifier hasIdentifier getEffectiveTimeElement setEffectiveTimeElement hasEffectiveTimeElement getEffectiveTime setEffectiveTime hasEffectiveTime getQuantity setQuantity hasQuantity getUnitPrice setUnitPrice hasUnitPrice getFactorElement setFactorElement hasFactorElement getFactor setFactor hasFactor getPointsElement setPointsElement hasPointsElement getPoints setPoints hasPoints getNet setNet hasNet getPaymentElement setPaymentElement hasPaymentElement getPayment setPayment hasPayment getPaymentDateElement setPaymentDateElement hasPaymentDateElement getPaymentDate setPaymentDate hasPaymentDate getResponsible setResponsible hasResponsible getRecipient setRecipient hasRecipient getLinkIdElement setLinkIdElement addLinkIdElement hasLinkIdElement getLinkId setLinkId addLinkId hasLinkId getSecurityLabelNumberElement setSecurityLabelNumberElement addSecurityLabelNumberElement hasSecurityLabelNumberElement getSecurityLabelNumber setSecurityLabelNumber addSecurityLabelNumber hasSecurityLabelNumber fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initLinkId initSecurityLabelNumber

    Constructors

    Properties

    entity?: IDataType

    Contract.term.asset.valuedItem.entity[x] Element

    @ChoiceDataTypesMeta('Contract.term.asset.valuedItem.entity[x]', ['CodeableConcept','Reference',]

    FHIR Specification

    • Short: Contract Valued Item Type
    • Definition: Specific type of Contract Valued Item that may be priced.
    • FHIR Types: 'CodeableConcept', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    identifier?: Identifier

    Contract.term.asset.valuedItem.identifier Element

    FHIR Specification

    • Short: Contract Valued Item Number
    • Definition: Identifies a Contract Valued Item instance.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    effectiveTime?: DateTimeType

    Contract.term.asset.valuedItem.effectiveTime Element

    FHIR Specification

    • Short: Contract Valued Item Effective Tiem
    • Definition: Indicates the time during which this Contract ValuedItem information is effective.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    quantity?: Quantity

    Contract.term.asset.valuedItem.quantity Element

    FHIR Specification

    • Short: Count of Contract Valued Items
    • Definition: Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    unitPrice?: Money

    Contract.term.asset.valuedItem.unitPrice Element

    FHIR Specification

    • Short: Contract Valued Item fee, charge, or cost
    • Definition: A Contract Valued Item unit valuation measure.
    • FHIR Type: Money
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    factor?: DecimalType

    Contract.term.asset.valuedItem.factor Element

    FHIR Specification

    • Short: Contract Valued Item Price Scaling Factor
    • Definition: A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    points?: DecimalType

    Contract.term.asset.valuedItem.points Element

    FHIR Specification

    • Short: Contract Valued Item Difficulty Scaling Factor
    • Definition: An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    net?: Money

    FHIR Specification

    • Short: Total Contract Valued Item Value
    • Definition: Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
    • FHIR Type: Money
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    payment?: StringType

    Contract.term.asset.valuedItem.payment Element

    FHIR Specification

    • Short: Terms of valuation
    • Definition: Terms of valuation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    paymentDate?: DateTimeType

    Contract.term.asset.valuedItem.paymentDate Element

    FHIR Specification

    • Short: When payment is due
    • Definition: When payment is due.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    responsible?: Reference

    Contract.term.asset.valuedItem.responsible Element

    FHIR Specification

    recipient?: Reference

    Contract.term.asset.valuedItem.recipient Element

    FHIR Specification

    linkId?: StringType[]

    Contract.term.asset.valuedItem.linkId Element

    FHIR Specification

    • Short: Pointer to specific item
    • Definition: Id of the clause or question text related to the context of this valuedItem in the referenced form or QuestionnaireResponse.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    securityLabelNumber?: UnsignedIntType[]

    Contract.term.asset.valuedItem.securityLabelNumber Element

    FHIR Specification

    • Short: Security Labels that define affected terms
    • Definition: A set of security labels that define which terms are controlled by this condition.
    • FHIR Type: unsignedInt
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided ContractTermAssetValuedItemComponent JSON to instantiate the ContractTermAssetValuedItemComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ContractTermAssetValuedItemComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ContractTermAssetValuedItemComponent

      Returns undefined | ContractTermAssetValuedItemComponent

      ContractTermAssetValuedItemComponent data model or undefined for ContractTermAssetValuedItemComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Responsible object value to the responsible property.

      Parameters

      • value: undefined | Reference

        the responsible object value

      Returns this

      this

      @ReferenceTargets('Contract.term.asset.valuedItem.responsible', ['Organization','Patient','Practitioner','PractitionerRole','RelatedPerson',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Recipient object value to the recipient property.

      Parameters

      • value: undefined | Reference

        the recipient object value

      Returns this

      this

      @ReferenceTargets('Contract.term.asset.valuedItem.recipient', ['Organization','Patient','Practitioner','PractitionerRole','RelatedPerson',])

      InvalidTypeError for invalid data type or reference value

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      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

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having 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 extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      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

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise