Data Model Libraries
    Preparing search index...

    ContractTermActionComponent Class

    FHIR Specification

    • Short: Entity being ascribed responsibility
    • Definition: An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
    • Comment: Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. For example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, software, or system process. However, only one user may be the initiator/requestor for the event.
    • Requirements: An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getDoNotPerformElement setDoNotPerformElement hasDoNotPerformElement getDoNotPerform setDoNotPerform hasDoNotPerform getType setType hasType getSubject setSubject addSubject hasSubject getIntent setIntent hasIntent getLinkIdElement setLinkIdElement addLinkIdElement hasLinkIdElement getLinkId setLinkId addLinkId hasLinkId getStatus setStatus hasStatus getContext setContext hasContext getContextLinkIdElement setContextLinkIdElement addContextLinkIdElement hasContextLinkIdElement getContextLinkId setContextLinkId addContextLinkId hasContextLinkId getOccurrence setOccurrence hasOccurrence getOccurrenceDateTimeType hasOccurrenceDateTimeType getOccurrencePeriod hasOccurrencePeriod getOccurrenceTiming hasOccurrenceTiming getRequester setRequester addRequester hasRequester getRequesterLinkIdElement setRequesterLinkIdElement addRequesterLinkIdElement hasRequesterLinkIdElement getRequesterLinkId setRequesterLinkId addRequesterLinkId hasRequesterLinkId getPerformerType setPerformerType addPerformerType hasPerformerType getPerformerRole setPerformerRole hasPerformerRole getPerformer setPerformer hasPerformer getPerformerLinkIdElement setPerformerLinkIdElement addPerformerLinkIdElement hasPerformerLinkIdElement getPerformerLinkId setPerformerLinkId addPerformerLinkId hasPerformerLinkId getReasonCode setReasonCode addReasonCode hasReasonCode getReasonReference setReasonReference addReasonReference hasReasonReference getReasonElement setReasonElement addReasonElement hasReasonElement getReason setReason addReason hasReason getReasonLinkIdElement setReasonLinkIdElement addReasonLinkIdElement hasReasonLinkIdElement getReasonLinkId setReasonLinkId addReasonLinkId hasReasonLinkId getNote setNote addNote hasNote getSecurityLabelNumberElement setSecurityLabelNumberElement addSecurityLabelNumberElement hasSecurityLabelNumberElement getSecurityLabelNumber setSecurityLabelNumber addSecurityLabelNumber hasSecurityLabelNumber fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initSubject initLinkId initContextLinkId initRequester initRequesterLinkId initPerformerType initPerformerLinkId initReasonCode initReasonReference initReason initReasonLinkId initNote initSecurityLabelNumber

    Constructors

    Properties

    doNotPerform?: BooleanType

    Contract.term.action.doNotPerform Element

    FHIR Specification

    • Short: True if the term prohibits the action
    • Definition: True if the term prohibits the action.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: If true this element negates the specified action. For Example, instead of a dictate to perform an action, it is a dictate not to perform the action.
    • isSummary: false
    type_: null | CodeableConcept

    Contract.term.action.type Element

    FHIR Specification

    • Short: Type or form of the action
    • Definition: Activity or service obligation to be done or not done, performed or not performed, effectuated or not by this Contract term.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Contract.term.action.subject Element

    FHIR Specification

    • Short: Entity of the action
    • Definition: Entity of the action.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    intent: null | CodeableConcept

    Contract.term.action.intent Element

    FHIR Specification

    • Short: Purpose for the Contract Term Action
    • Definition: Reason or purpose for the action stipulated by this Contract Provision.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    linkId?: StringType[]

    Contract.term.action.linkId Element

    FHIR Specification

    • Short: Pointer to specific item
    • Definition: Id [identifier??] of the clause or question text related to this action in the referenced form or QuestionnaireResponse.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    status: null | CodeableConcept

    Contract.term.action.status Element

    FHIR Specification

    • Short: State of the action
    • Definition: Current state of the term action.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    context?: Reference

    Contract.term.action.context Element

    FHIR Specification

    contextLinkId?: StringType[]

    Contract.term.action.contextLinkId Element

    FHIR Specification

    • Short: Pointer to specific item
    • Definition: Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    occurrence?: IDataType

    Contract.term.action.occurrence[x] Element

    @ChoiceDataTypesMeta('Contract.term.action.occurrence[x]', ['dateTime','Period','Timing',]

    FHIR Specification

    • Short: When action happens
    • Definition: When action happens.
    • FHIR Types: 'dateTime', 'Period', 'Timing',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    requester?: Reference[]

    Contract.term.action.requester Element

    FHIR Specification

    requesterLinkId?: StringType[]

    Contract.term.action.requesterLinkId Element

    FHIR Specification

    • Short: Pointer to specific item
    • Definition: Id [identifier??] of the clause or question text related to the requester of this action in the referenced form or QuestionnaireResponse.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    performerType?: CodeableConcept[]

    Contract.term.action.performerType Element

    FHIR Specification

    • Short: Kind of service performer
    • Definition: The type of individual that is desired or required to perform or not perform the action.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    performerRole?: CodeableConcept

    Contract.term.action.performerRole Element

    FHIR Specification

    • Short: Competency of the performer
    • Definition: The type of role or competency of an individual desired or required to perform or not perform the action.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    performer?: Reference

    Contract.term.action.performer Element

    performerLinkId?: StringType[]

    Contract.term.action.performerLinkId Element

    FHIR Specification

    • Short: Pointer to specific item
    • Definition: Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reasonCode?: CodeableConcept[]

    Contract.term.action.reasonCode Element

    FHIR Specification

    • Short: Why is action (not) needed?
    • Definition: Rationale for the action to be performed or not performed. Describes why the action is permitted or prohibited.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reasonReference?: Reference[]

    Contract.term.action.reasonReference Element

    FHIR Specification

    reason?: StringType[]

    Contract.term.action.reason Element

    FHIR Specification

    • Short: Why action is to be performed
    • Definition: Describes why the action is to be performed or not performed in textual form.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reasonLinkId?: StringType[]

    Contract.term.action.reasonLinkId Element

    FHIR Specification

    • Short: Pointer to specific item
    • Definition: Id [identifier??] of the clause or question text related to the reason type or reference of this action in the referenced form or QuestionnaireResponse.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    Contract.term.action.note Element

    FHIR Specification

    • Short: Comments about the action
    • Definition: Comments made about the term action made by the requester, performer, subject or other participants.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    securityLabelNumber?: UnsignedIntType[]

    Contract.term.action.securityLabelNumber Element

    FHIR Specification

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

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ContractTermActionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ContractTermActionComponent

      ContractTermActionComponent data model or undefined for ContractTermActionComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the requester property.

      Parameters

      • value: undefined | Reference[]

        the requester array value

      Returns this

      this

      @ReferenceTargets('Contract.term.action.requester', ['Patient','RelatedPerson','Practitioner','PractitionerRole','Device','Group','Organization',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the requester array property.

      Parameters

      • value: undefined | Reference

        the requester value

      Returns this

      this

      @ReferenceTargets('Contract.term.action.requester', ['Patient','RelatedPerson','Practitioner','PractitionerRole','Device','Group','Organization',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Performer object value to the performer property.

      Parameters

      • value: undefined | Reference

        the performer object value

      Returns this

      this

      @ReferenceTargets('Contract.term.action.performer', ['RelatedPerson','Patient','Practitioner','PractitionerRole','CareTeam','Device','Substance','Organization','Location',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Reference array value to the reasonReference property.

      Parameters

      • value: undefined | Reference[]

        the reasonReference array value

      Returns this

      this

      @ReferenceTargets('Contract.term.action.reasonReference', ['Condition','Observation','DiagnosticReport','DocumentReference','Questionnaire','QuestionnaireResponse',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the reasonReference array property.

      Parameters

      • value: undefined | Reference

        the reasonReference value

      Returns this

      this

      @ReferenceTargets('Contract.term.action.reasonReference', ['Condition','Observation','DiagnosticReport','DocumentReference','Questionnaire','QuestionnaireResponse',])

      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 the instance is a FHIR complex or primitive datatype; false otherwise