Data Model Libraries
    Preparing search index...

    Class ExampleScenarioInstanceContainedInstanceComponent

    ExampleScenarioInstanceContainedInstanceComponent Class

    FHIR Specification

    • Short: Resources contained in the instance
    • Definition: References to other instances that can be found within this instance (e.g. the observations contained in a bundle).

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    instanceReference: null | StringType

    ExampleScenario.instance.containedInstance.instanceReference Element

    FHIR Specification

    • Short: Key of contained instance
    • Definition: A reference to the key of an instance found within this one.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    versionReference?: StringType

    ExampleScenario.instance.containedInstance.versionReference Element

    FHIR Specification

    • Short: Key of contained instance version
    • Definition: A reference to the key of a specific version of an instance in this instance.
    • Comment: Required if the referenced instance has versions
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExampleScenarioInstanceContainedInstanceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ExampleScenarioInstanceContainedInstanceComponent

      ExampleScenarioInstanceContainedInstanceComponent data model or undefined for ExampleScenarioInstanceContainedInstanceComponent

      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