Data Model Libraries
    Preparing search index...

    Class TestScriptMetadataComponent

    TestScriptMetadataComponent Class

    FHIR Specification

    • Short: Required capability that is assumed to function correctly on the FHIR server being tested
    • Definition: The required capability must exist and are assumed to function correctly on the FHIR server being tested.

    FHIR TestScript

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    link? capability

    Methods

    parse getLink setLink addLink hasLink getCapability setCapability addCapability hasCapability fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initLink initCapability

    Constructors

    Properties

    link?: TestScriptMetadataLinkComponent[]

    TestScript.metadata.link Element

    FHIR Specification

    • Short: Links to the FHIR specification
    • Definition: A link to the FHIR specification that this test is covering.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    capability: null | TestScriptMetadataCapabilityComponent[]

    TestScript.metadata.capability Element

    FHIR Specification

    • Short: Capabilities that are assumed to function correctly on the FHIR server being tested
    • Definition: Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.
    • Comment: When the metadata capabilities section is defined at TestScript.metadata or at TestScript.setup.metadata, and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then all the tests in the TestScript are skipped. When the metadata capabilities section is defined at TestScript.test.metadata and the server's conformance statement does not contain the elements defined in the minimal conformance statement, then only that test is skipped. The "metadata.capabilities.required" and "metadata.capabilities.validated" elements only indicate whether the capabilities are the primary focus of the test script or not. They do not impact the skipping logic. Capabilities whose "metadata.capabilities.validated" flag is true are the primary focus of the test script.
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR TestScriptMetadataComponent

      • OptionaloptSourceField: string

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

      Returns undefined | TestScriptMetadataComponent

      TestScriptMetadataComponent data model or undefined for TestScriptMetadataComponent

      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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods