Data Model Libraries
    Preparing search index...

    TestScriptDestinationComponent Class

    FHIR Specification

    • Short: An abstract server representing a destination or receiver in a message exchange
    • Definition: An abstract server used in operations within this test script in the destination element.
    • Comment: The purpose of this element is to define the profile of a destination element used elsewhere in the script. Test engines could then use the destination-profile mapping to offer a filtered list of test systems that can serve as the receiver for the interaction.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    index: null | IntegerType

    TestScript.destination.index Element

    FHIR Specification

    • Short: The index of the abstract destination server starting at 1
    • Definition: Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.
    • Comment: A given destination index (e.g. 1) can appear only once in the list (e.g. Destination 1 cannot be specified twice ... once as Form-Manager and again as Form-Processor within the same script as that could get confusing during test configuration). Different destination indices could play the same actor in the same test script (e.g. You could have two different test systems acting as Form-Manager). The destination indices provided elsewhere in the test script must be one of these destination indices.
    • FHIR Type: integer
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    profile: null | Coding

    TestScript.destination.profile Element

    FHIR Specification

    • Short: FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor
    • Definition: The type of destination profile the test system supports.
    • Comment: Must be a "receiver"/"server" profile.
    • FHIR Type: Coding
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    url?: UrlType

    TestScript.destination.url Element

    FHIR Specification

    • Short: The url path of the destination server
    • Definition: The explicit url path of the destination server used in this test script.
    • Comment: If provided, the test engine is not expected to prompt for or accept external input of this value.
    • FHIR Type: url
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR TestScriptDestinationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | TestScriptDestinationComponent

      TestScriptDestinationComponent data model or undefined for TestScriptDestinationComponent

      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