Data Model Libraries
    Preparing search index...

    TestReport Class

    A summary of information based on the results of executing a TestScript.

    FHIR Specification

    • Short: Describes the results of a TestScript execution
    • Definition: A summary of information based on the results of executing a TestScript.
    • FHIR Version: 4.0.1

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier hasIdentifier getNameElement setNameElement hasNameElement getName setName hasName getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getTestScript setTestScript hasTestScript getResultEnumType setResultEnumType hasResultEnumType getResultElement setResultElement hasResultElement getResult setResult hasResult getScoreElement setScoreElement hasScoreElement getScore setScore hasScore getTesterElement setTesterElement hasTesterElement getTester setTester hasTester getIssuedElement setIssuedElement hasIssuedElement getIssued setIssued hasIssued getParticipant setParticipant addParticipant hasParticipant getSetup setSetup hasSetup getTest setTest addTest hasTest getTeardown setTeardown hasTeardown fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initParticipant initTest

    Constructors

    Properties

    identifier?: Identifier

    TestReport.identifier Element

    FHIR Specification

    • Short: External identifier
    • Definition: Identifier for the TestScript assigned for external purposes outside the context of FHIR.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    FHIR Specification

    • Short: Informal name of the executed TestScript
    • Definition: A free text natural language name identifying the executed TestScript.
    • Comment: Not expected to be globally unique.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    reportStatusCodesEnum: ReportStatusCodesEnum

    FHIR CodeSystem: ReportStatusCodes

    status: null | EnumCodeType

    TestReport.status Element

    FHIR Specification

    • Short: completed | in-progress | waiting | stopped | entered-in-error
    • Definition: The current state of this test report.
    • Comment: The status represents where the execution is currently within the test script execution life cycle. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: ReportStatusCodesEnum

    testScript: null | Reference

    TestReport.testScript Element

    FHIR Specification

    • Short: Reference to the version-specific TestScript that was executed to produce this TestReport
    • Definition: Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the TestScript.url.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    reportResultCodesEnum: ReportResultCodesEnum

    FHIR CodeSystem: ReportResultCodes

    result: null | EnumCodeType

    TestReport.result Element

    FHIR Specification

    • Short: pass | fail | pending
    • Definition: The overall result from the execution of the TestScript.
    • Comment: The pass and fail result represents a completed test script execution. The pending result represents a test script execution that has not yet started or is currently in progress.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ReportResultCodesEnum

    score?: DecimalType

    TestReport.score Element

    FHIR Specification

    • Short: The final score (percentage of tests passed) resulting from the execution of the TestScript
    • Definition: The final score (percentage of tests passed) resulting from the execution of the TestScript.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    tester?: StringType

    TestReport.tester Element

    FHIR Specification

    • Short: Name of the tester producing this report (Organization or individual)
    • Definition: Name of the tester producing this report (Organization or individual).
    • Comment: Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.
    • Requirements: Helps establish the "authority/credibility" of the TestReport. May also allow for contact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    issued?: DateTimeType

    TestReport.issued Element

    FHIR Specification

    • Short: When the TestScript was executed and this TestReport was generated
    • Definition: When the TestScript was executed and this TestReport was generated.
    • Comment: Additional specific dates may be added as extensions.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    TestReport.participant Element

    FHIR Specification

    • Short: A participant in the test execution, either the execution engine, a client, or a server
    • Definition: A participant in the test execution, either the execution engine, a client, or a server.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    TestReport.setup Element

    FHIR Specification

    • Short: The results of the series of required setup operations before the tests were executed
    • Definition: The results of the series of required setup operations before the tests were executed.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    TestReport.test Element

    FHIR Specification

    • Short: A test executed from the test script
    • Definition: A test executed from the test script.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    TestReport.teardown Element

    FHIR Specification

    • Short: The results of running the series of required clean up steps
    • Definition: The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR TestReport

      • OptionaloptSourceField: string

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

      Returns undefined | TestReport

      TestReport data model or undefined for TestReport

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise