Data Model Libraries
    Preparing search index...

    Class TestScriptSetupActionOperationRequestHeaderComponent

    TestScriptSetupActionOperationRequestHeaderComponent Class

    FHIR Specification

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    field: null | StringType

    TestScript.setup.action.operation.requestHeader.field Element

    FHIR Specification

    • Short: HTTP header field name
    • Definition: The HTTP header field e.g. "Accept".
    • Comment: If header element is specified, then field is required.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    value: null | StringType

    TestScript.setup.action.operation.requestHeader.value Element

    FHIR Specification

    • Short: HTTP headerfield value
    • Definition: The value of the header e.g. "application/fhir+xml".
    • Comment: If header element is specified, then value is required. No conversions will be done by the test engine e.g. "xml" to "application/fhir+xml". The values will be set in HTTP headers "as-is". Test engines do have to look for placeholders (${}) and replace the variable placeholders with the variable values at runtime before sending the request.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR TestScriptSetupActionOperationRequestHeaderComponent

      • OptionaloptSourceField: string

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

      Returns undefined | TestScriptSetupActionOperationRequestHeaderComponent

      TestScriptSetupActionOperationRequestHeaderComponent data model or undefined for TestScriptSetupActionOperationRequestHeaderComponent

      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