Data Model Libraries
    Preparing search index...

    Class PlanDefinitionActionInputComponent

    PlanDefinitionActionInputComponent Class

    FHIR Specification

    • Short: Input data requirements
    • Definition: Defines input data requirements for the action.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    title?: StringType

    PlanDefinition.action.input.title Element

    FHIR Specification

    • Short: User-visible title
    • Definition: A human-readable label for the data requirement used to label data flows in BPMN or similar diagrams. Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    requirement?: DataRequirement

    PlanDefinition.action.input.requirement Element

    FHIR Specification

    • Short: What data is provided
    • Definition: Defines the data that is to be provided as input to the action.
    • FHIR Type: DataRequirement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    relatedData?: IdType

    PlanDefinition.action.input.relatedData Element

    FHIR Specification

    • Short: What data is provided
    • Definition: Points to an existing input or output element that provides data to this input.
    • Comment: The relatedData element allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action
    • FHIR Type: id
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR PlanDefinitionActionInputComponent

      • OptionaloptSourceField: string

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

      Returns undefined | PlanDefinitionActionInputComponent

      PlanDefinitionActionInputComponent data model or undefined for PlanDefinitionActionInputComponent

      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