Data Model Libraries
    Preparing search index...

    TestScriptScopeComponent Class

    FHIR Specification

    • Short: Indication of the artifact(s) that are tested by this test case
    • Definition: The scope indicates a conformance artifact that is tested by the test(s) within this test case and the expectation of the test outcome(s) as well as the intended test phase inclusion.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    artifact: null | CanonicalType

    TestScript.scope.artifact Element

    FHIR Specification

    • Short: The specific conformance artifact being tested
    • Definition: The specific conformance artifact being tested. The canonical reference can be version-specific.
    • FHIR Type: canonical
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    conformance?: CodeableConcept

    TestScript.scope.conformance Element

    FHIR Specification

    • Short: required | optional | strict
    • Definition: The expectation of whether the test must pass for the system to be considered conformant with the artifact: required - all tests are expected to pass, optional - all test are expected to pass but non-pass status may be allowed, strict - all tests are expected to pass and warnings are treated as a failure.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    TestScript.scope.phase Element

    FHIR Specification

    • Short: unit | integration | production
    • Definition: The phase of testing for this artifact: unit - development / implementation phase, integration - internal system to system phase, production - live system to system phase (Note, this may involve pii/phi data).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR TestScriptScopeComponent

      • OptionaloptSourceField: string

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

      Returns undefined | TestScriptScopeComponent

      TestScriptScopeComponent data model or undefined for TestScriptScopeComponent

      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