Data Model Libraries
    Preparing search index...

    Class PlanDefinitionActionRelatedActionComponent

    PlanDefinitionActionRelatedActionComponent Class

    FHIR Specification

    • Short: Relationship to another action
    • Definition: A relationship to another action such as "before" or "30-60 minutes after start of".
    • Comment: When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    actionId: null | IdType

    PlanDefinition.action.relatedAction.actionId Element

    FHIR Specification

    • Short: What action is this related to
    • Definition: The element id of the related action.
    • FHIR Type: id
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    actionRelationshipTypeEnum: ActionRelationshipTypeEnum

    FHIR CodeSystem: ActionRelationshipType

    relationship: null | EnumCodeType

    PlanDefinition.action.relatedAction.relationship Element

    FHIR Specification

    • Short: before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
    • Definition: The relationship of this action to the related action.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ActionRelationshipTypeEnum

    offset?: IDataType

    PlanDefinition.action.relatedAction.offset[x] Element

    @ChoiceDataTypesMeta('PlanDefinition.action.relatedAction.offset[x]', ['Duration','Range',]

    FHIR Specification

    • Short: Time offset for the relationship
    • Definition: A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
    • FHIR Types: 'Duration', 'Range',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR PlanDefinitionActionRelatedActionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | PlanDefinitionActionRelatedActionComponent

      PlanDefinitionActionRelatedActionComponent data model or undefined for PlanDefinitionActionRelatedActionComponent

      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