Data Model Libraries
    Preparing search index...

    ExampleScenarioInstanceComponent Class

    FHIR Specification

    • Short: Each resource and each version that is present in the workflow
    • Definition: Each resource and each version that is present in the workflow.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    resourceId: null | StringType

    ExampleScenario.instance.resourceId Element

    FHIR Specification

    • Short: The id of the resource for referencing
    • Definition: The id of the resource for referencing.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    resourceTypesEnum: ResourceTypesEnum

    FHIR CodeSystem: ResourceTypes

    resourceType: null | EnumCodeType

    ExampleScenario.instance.resourceType Element

    FHIR Specification

    • Short: The type of the resource
    • Definition: The type of the resource.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ResourceTypesEnum

    name?: StringType

    FHIR Specification

    • Short: A short name for the resource instance
    • Definition: A short name for the resource instance.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    ExampleScenario.instance.description Element

    FHIR Specification

    • Short: Human-friendly description of the resource instance
    • Definition: Human-friendly description of the resource instance.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    ExampleScenario.instance.version Element

    FHIR Specification

    • Short: A specific version of the resource
    • Definition: A specific version of the resource.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    ExampleScenario.instance.containedInstance Element

    FHIR Specification

    • Short: Resources contained in the instance
    • Definition: Resources contained in the instance (e.g. the observations contained in a bundle).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExampleScenarioInstanceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ExampleScenarioInstanceComponent

      ExampleScenarioInstanceComponent data model or undefined for ExampleScenarioInstanceComponent

      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