Data Model Libraries
    Preparing search index...

    ExampleScenarioActorComponent Class

    FHIR Specification

    • Short: Actor participating in the resource
    • Definition: Actor participating in the resource.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    actorId: null | StringType

    ExampleScenario.actor.actorId Element

    FHIR Specification

    • Short: ID or acronym of the actor
    • Definition: ID or acronym of actor.
    • Comment: should this be called ID or acronym?
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    examplescenarioActorTypeEnum: ExamplescenarioActorTypeEnum

    FHIR CodeSystem: ExamplescenarioActorType

    type_: null | EnumCodeType

    ExampleScenario.actor.type Element

    FHIR Specification

    • Short: person | entity
    • Definition: The type of actor - person or system.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ExamplescenarioActorTypeEnum

    name?: StringType

    FHIR Specification

    • Short: The name of the actor as shown in the page
    • Definition: The name of the actor as shown in the page.
    • Comment: Cardinality: is name and description 1..1?
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    ExampleScenario.actor.description Element

    FHIR Specification

    • Short: The description of the actor
    • Definition: The description of the actor.
    • Comment: Cardinality: is name and description 1..1?
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExampleScenarioActorComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ExampleScenarioActorComponent

      ExampleScenarioActorComponent data model or undefined for ExampleScenarioActorComponent

      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