Data Model Libraries
    Preparing search index...

    Class TestScriptMetadataCapabilityComponent

    TestScriptMetadataCapabilityComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    required: null | BooleanType

    TestScript.metadata.capability.required Element

    FHIR Specification

    • Short: Are the capabilities required?
    • Definition: Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.
    • FHIR Type: boolean
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    validated: null | BooleanType

    TestScript.metadata.capability.validated Element

    FHIR Specification

    • Short: Are the capabilities validated?
    • Definition: Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.
    • FHIR Type: boolean
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    description?: StringType

    TestScript.metadata.capability.description Element

    FHIR Specification

    • Short: The expected capabilities of the server
    • Definition: Description of the capabilities that this test script is requiring the server to support.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    origin?: IntegerType[]

    TestScript.metadata.capability.origin Element

    FHIR Specification

    • Short: Which origin server these requirements apply to
    • Definition: Which origin server these requirements apply to.
    • FHIR Type: integer
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    destination?: IntegerType

    TestScript.metadata.capability.destination Element

    FHIR Specification

    • Short: Which server these requirements apply to
    • Definition: Which server these requirements apply to.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    link?: UriType[]

    TestScript.metadata.capability.link Element

    FHIR Specification

    • Short: Links to the FHIR specification
    • Definition: Links to the FHIR specification that describes this interaction and the resources involved in more detail.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    capabilities: null | CanonicalType

    TestScript.metadata.capability.capabilities Element

    FHIR Specification

    • Short: Required Capability Statement
    • Definition: Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped.
    • Comment: The conformance statement of the server has to contain at a minimum the contents of the reference pointed to by this element.
    • FHIR Type: canonical
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR TestScriptMetadataCapabilityComponent

      • OptionaloptSourceField: string

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

      Returns undefined | TestScriptMetadataCapabilityComponent

      TestScriptMetadataCapabilityComponent data model or undefined for TestScriptMetadataCapabilityComponent

      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