Data Model Libraries
    Preparing search index...

    Class ExampleScenarioInstanceVersionComponent

    ExampleScenarioInstanceVersionComponent Class

    FHIR Specification

    • Short: Snapshot of instance that changes
    • Definition: Represents the instance as it was at a specific time-point.
    • Comment: Not used if an instance doesn't change
    • Requirements: Allows representing the 'same' instance as it evolves throughout the scenario.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    key: null | StringType

    ExampleScenario.instance.version.key Element

    FHIR Specification

    • Short: ID or acronym of the version
    • Definition: A unique string within the instance that is used to reference the version of the instance.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    title: null | StringType

    ExampleScenario.instance.version.title Element

    FHIR Specification

    • Short: Label for instance version
    • Definition: A short descriptive label the version to be used in tables or diagrams.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    ExampleScenario.instance.version.description Element

    FHIR Specification

    • Short: Details about version
    • Definition: An explanation of what this specific version of the instance contains and represents.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    content?: Reference

    ExampleScenario.instance.version.content Element

    FHIR Specification

    • Short: Example instance version data
    • Definition: Points to an instance (typically an example) that shows the data that would flow at this point in the scenario.
    • Comment: If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be to a Binary.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ExampleScenarioInstanceVersionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ExampleScenarioInstanceVersionComponent

      ExampleScenarioInstanceVersionComponent data model or undefined for ExampleScenarioInstanceVersionComponent

      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