Data Model Libraries
    Preparing search index...

    Class ContractTermOfferComponent

    ContractTermOfferComponent Class

    FHIR Specification

    • Short: Context of the Contract term
    • Definition: The matter of concern in the context of this provision of the agrement.

    FHIR Contract

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? party? topic? type_? decision? decisionMode? answer? text? linkId? securityLabelNumber?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getParty setParty addParty hasParty getTopic setTopic hasTopic getType setType hasType getDecision setDecision hasDecision getDecisionMode setDecisionMode addDecisionMode hasDecisionMode getAnswer setAnswer addAnswer hasAnswer getTextElement setTextElement hasTextElement getText setText hasText 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 initIdentifier initParty initDecisionMode initAnswer initLinkId initSecurityLabelNumber

    Constructors

    Properties

    identifier?: Identifier[]

    Contract.term.offer.identifier Element

    FHIR Specification

    • Short: Offer business ID
    • Definition: Unique identifier for this particular Contract Provision.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    party?: ContractTermOfferPartyComponent[]

    Contract.term.offer.party Element

    FHIR Specification

    • Short: Offer Recipient
    • Definition: Offer Recipient.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    topic?: Reference

    Contract.term.offer.topic Element

    FHIR Specification

    • Short: Negotiable offer asset
    • Definition: The owner of an asset has the residual control rights over the asset: the right to decide all usages of the asset in any way not inconsistent with a prior contract, custom, or law (Hart, 1995, p. 30).
    • Comment: The Contract.topic may be an application for or offer of a policy or service (e.g., uri to a consent directive form or a health insurance policy), which becomes the Contract once accepted by both the grantor and grantee. The Contract Resource may function simply as the computable representation of the executed contract, which may be the attached to the Contract Resource as the "binding" or as the "friendly" electronic form. For example, a Contract Resource may be automatically populated with the values expressed in a related QuestionnaireResponse. However, the Contract Resource may be considered the legally binding contract if it is the only "executed" form of this contract, and includes the signatures as *The Contract Resource may function as the computable representation of an application or offer in a pre-executed Contract if the grantor has not entered any values. In this case, it is populated with values in a "legal" form of the application or offer or by the values in an associated Questionnaire. If the grantor has filled in the legal form or the associated Questionnaire Response, then these values are used to populate a pre-executed Contract Resource. If the Contract.topic is considered an application or offer, then the policy is often required to be attached as the "legal" basis for the application to ensure "informed consent" to the contract, and that any discrepancy between the application and the policy are interpreted against the policy. Implementers should check organizational and jurisdictional policies to determine the relationship among multiple representations of a contract pre- and post-execution.
    • Requirements: In the context of a contract, the topic is the matter under consideration in regards to which specific rights, privileges, obligations, restrictions, and prohibitions are binding on any grantor and grantee parties upon the execution of the contract. Given the wide range of contract topics, implementers need to be cognizant of the business use case for which they are designing a FHIR Contract, and narrowly specify the topic being represented with respect to the Contract.type and any specializing Contract.subtype. The same topic, e.g., an asset such as a good or service, such as a real property, medical supply, insurance, information, a procedure or employment, or a manner of conduct, such adherence to a privacy, trust, or security policy, may be the topic of multiple types of contracts. One way to determine the Contract.topic is to answer the question: "What is the object of negotiation?" Answer: The Contract.topic, which may be described with more detail in the [0..*]Contract.valuedItem @ [0..1] Contract.valuedItem.entity[x] Definition: Specific type of Contract Valued Item that may be priced. CodeableConcept|Reference(Any) Contract.topic is "the what" that a grantor is exchanging with a grantee in return for some benefit. Contract.topic is "the what" to which any Contract.action is being applied for any stipulated Contract.action.reason. AContract.topic is "the what" governed by the execution of the contract to which any party's rights, privileges, obligations, restrictions, and prohibitions apply.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Private Optionaltype_

    type_?: CodeableConcept

    Contract.term.offer.type Element

    FHIR Specification

    • Short: Contract Offer Type or Form
    • Definition: Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    decision?: CodeableConcept

    Contract.term.offer.decision Element

    FHIR Specification

    • Short: Accepting party choice
    • Definition: Type of choice made by accepting party with respect to an offer made by an offeror/ grantee.
    • Requirements: In some policy or contract contexts, the "offer" is made by an offeror wishing to be the "grantee" of the offer topic by the grantor. From this perspective, the grantor is the "offeree".
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    decisionMode?: CodeableConcept[]

    Contract.term.offer.decisionMode Element

    FHIR Specification

    • Short: How decision is conveyed
    • Definition: How the decision about a Contract was conveyed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    answer?: ContractTermOfferAnswerComponent[]

    Contract.term.offer.answer Element

    FHIR Specification

    • Short: Response to offer text
    • Definition: Response to offer text.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Private Optionaltext

    text?: StringType

    Contract.term.offer.text Element

    FHIR Specification

    • Short: Human readable offer text
    • Definition: Human readable form of this Contract Offer.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    linkId?: StringType[]

    Contract.term.offer.linkId Element

    FHIR Specification

    • Short: Pointer to text
    • Definition: The id of the clause or question text of the offer in the referenced questionnaire/response.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    securityLabelNumber?: UnsignedIntType[]

    Contract.term.offer.securityLabelNumber Element

    FHIR Specification

    • Short: Offer restriction numbers
    • Definition: Security labels that protects the offer.
    • FHIR Type: unsignedInt
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ContractTermOfferComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ContractTermOfferComponent

      ContractTermOfferComponent data model or undefined for ContractTermOfferComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetPartysetPartyaddPartyhasPartygetTopicsetTopichasTopicgetTypesetTypehasTypegetDecisionsetDecisionhasDecisiongetDecisionModesetDecisionModeaddDecisionModehasDecisionModegetAnswersetAnsweraddAnswerhasAnswergetTextElementsetTextElementhasTextElementgetTextsetTexthasTextgetLinkIdElementsetLinkIdElementaddLinkIdElementhasLinkIdElementgetLinkIdsetLinkIdaddLinkIdhasLinkIdgetSecurityLabelNumberElementsetSecurityLabelNumberElementaddSecurityLabelNumberElementhasSecurityLabelNumberElementgetSecurityLabelNumbersetSecurityLabelNumberaddSecurityLabelNumberhasSecurityLabelNumberfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitPartyinitDecisionModeinitAnswerinitLinkIdinitSecurityLabelNumber