Data Model Libraries
    Preparing search index...

    TaskInputComponent Class

    FHIR Specification

    • Short: Information used to perform task
    • Definition: Additional information that may be needed in the execution of the task.
    • Requirements: Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getType setType hasType getValue setValue hasValue getValueBase64BinaryType hasValueBase64BinaryType getValueBooleanType hasValueBooleanType getValueCanonicalType hasValueCanonicalType getValueCodeType hasValueCodeType getValueDateType hasValueDateType getValueDateTimeType hasValueDateTimeType getValueDecimalType hasValueDecimalType getValueIdType hasValueIdType getValueInstantType hasValueInstantType getValueIntegerType hasValueIntegerType getValueMarkdownType hasValueMarkdownType getValueOidType hasValueOidType getValuePositiveIntType hasValuePositiveIntType getValueStringType hasValueStringType getValueTimeType hasValueTimeType getValueUnsignedIntType hasValueUnsignedIntType getValueUriType hasValueUriType getValueUrlType hasValueUrlType getValueUuidType hasValueUuidType getValueAddress hasValueAddress getValueAge hasValueAge getValueAnnotation hasValueAnnotation getValueAttachment hasValueAttachment getValueCodeableConcept hasValueCodeableConcept getValueCoding hasValueCoding getValueContactPoint hasValueContactPoint getValueCount hasValueCount getValueDistance hasValueDistance getValueDuration hasValueDuration getValueHumanName hasValueHumanName getValueIdentifier hasValueIdentifier getValueMoney hasValueMoney getValuePeriod hasValuePeriod getValueQuantity hasValueQuantity getValueRange hasValueRange getValueRatio hasValueRatio getValueReference hasValueReference getValueSampledData hasValueSampledData getValueSignature hasValueSignature getValueTiming hasValueTiming getValueContactDetail hasValueContactDetail getValueContributor hasValueContributor getValueDataRequirement hasValueDataRequirement getValueExpression hasValueExpression getValueParameterDefinition hasValueParameterDefinition getValueRelatedArtifact hasValueRelatedArtifact getValueTriggerDefinition hasValueTriggerDefinition getValueUsageContext hasValueUsageContext getValueDosage hasValueDosage getValueMeta hasValueMeta 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

    Constructors

    Properties

    type_: null | CodeableConcept

    Task.input.type Element

    FHIR Specification

    • Short: Label for the input
    • Definition: A code or description indicating how the input is intended to be used as part of the task execution.
    • Comment: If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.
    • Requirements: Inputs are named to enable task automation to bind data and pass it from one task to the next.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    value: null | IDataType

    Task.input.value[x] Element

    @ChoiceDataTypesMeta('Task.input.value[x]', ['base64Binary','boolean','canonical','code','date','dateTime','decimal','id','instant','integer','markdown','oid','positiveInt','string','time','unsignedInt','uri','url','uuid','Address','Age','Annotation','Attachment','CodeableConcept','Coding','ContactPoint','Count','Distance','Duration','HumanName','Identifier','Money','Period','Quantity','Range','Ratio','Reference','SampledData','Signature','Timing','ContactDetail','Contributor','DataRequirement','Expression','ParameterDefinition','RelatedArtifact','TriggerDefinition','UsageContext','Dosage','Meta',]

    FHIR Specification

    • Short: Content to use in performing the task
    • Definition: The value of the input parameter as a basic type.
    • FHIR Types: 'base64Binary', 'boolean', 'canonical', 'code', 'date', 'dateTime', 'decimal', 'id', 'instant', 'integer', 'markdown', 'oid', 'positiveInt', 'string', 'time', 'unsignedInt', 'uri', 'url', 'uuid', 'Address', 'Age', 'Annotation', 'Attachment', 'CodeableConcept', 'Coding', 'ContactPoint', 'Count', 'Distance', 'Duration', 'HumanName', 'Identifier', 'Money', 'Period', 'Quantity', 'Range', 'Ratio', 'Reference', 'SampledData', 'Signature', 'Timing', 'ContactDetail', 'Contributor', 'DataRequirement', 'Expression', 'ParameterDefinition', 'RelatedArtifact', 'TriggerDefinition', 'UsageContext', 'Dosage', 'Meta',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR TaskInputComponent

      • OptionaloptSourceField: string

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

      Returns undefined | TaskInputComponent

      TaskInputComponent data model or undefined for TaskInputComponent

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