Data Model Libraries
    Preparing search index...

    PlanDefinitionActorComponent Class

    FHIR Specification

    • Short: Actors within the plan
    • Definition: Actors represent the individuals or groups involved in the execution of the defined set of activities.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    title?: StringType

    PlanDefinition.actor.title Element

    FHIR Specification

    • Short: User-visible title
    • Definition: A descriptive label for the actor.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    PlanDefinition.actor.description Element

    FHIR Specification

    • Short: Describes the actor
    • Definition: A description of how the actor fits into the overall actions of the plan definition.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    PlanDefinition.actor.option Element

    FHIR Specification

    • Short: Who or what can be this actor
    • Definition: The characteristics of the candidates that could serve as the actor.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR PlanDefinitionActorComponent

      • OptionaloptSourceField: string

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

      Returns undefined | PlanDefinitionActorComponent

      PlanDefinitionActorComponent data model or undefined for PlanDefinitionActorComponent

      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