Package com.ibm.fhir.model.resource

Class TestScript

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class TestScript
extends DomainResource
    A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getUrl

        public Uri getUrl()
        An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers.
        Returns:
        An immutable object of type Uri that is non-null.

      • getIdentifier

        public Identifier getIdentifier()
        A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.
        Returns:
        An immutable object of type Identifier that may be null.

      • getVersion

        public String getVersion()
        The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
        Returns:
        An immutable object of type String that may be null.

      • getName

        public String getName()
        A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        Returns:
        An immutable object of type String that is non-null.

      • getTitle

        public String getTitle()
        A short, descriptive, user-friendly title for the test script.
        Returns:
        An immutable object of type String that may be null.

      • getStatus

        public PublicationStatus getStatus()
        The status of this test script. Enables tracking the life-cycle of the content.
        Returns:
        An immutable object of type PublicationStatus that is non-null.

      • getExperimental

        public Boolean getExperimental()
        A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        Returns:
        An immutable object of type Boolean that may be null.

      • getDate

        public DateTime getDate()
        The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.
        Returns:
        An immutable object of type DateTime that may be null.

      • getPublisher

        public String getPublisher()
        The name of the organization or individual that published the test script.
        Returns:
        An immutable object of type String that may be null.

      • getContact

        public java.util.List<ContactDetail> getContact()
        Contact details to assist a user in finding and communicating with the publisher.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getDescription

        public Markdown getDescription()
        A free text natural language description of the test script from a consumer's perspective.
        Returns:
        An immutable object of type Markdown that may be null.

      • getUseContext

        public java.util.List<UsageContext> getUseContext()
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances.
        Returns:
        An unmodifiable list containing immutable objects of type UsageContext that may be empty.

      • getJurisdiction

        public java.util.List<CodeableConcept> getJurisdiction()
        A legal or geographic region in which the test script is intended to be used.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getPurpose

        public Markdown getPurpose()
        Explanation of why this test script is needed and why it has been designed as it has.
        Returns:
        An immutable object of type Markdown that may be null.

      • getCopyright

        public Markdown getCopyright()
        A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.
        Returns:
        An immutable object of type Markdown that may be null.

      • getOrigin

        public java.util.List<TestScript.Origin> getOrigin()
        An abstract server used in operations within this test script in the origin element.
        Returns:
        An unmodifiable list containing immutable objects of type TestScript.Origin that may be empty.

      • getDestination

        public java.util.List<TestScript.Destination> getDestination()
        An abstract server used in operations within this test script in the destination element.
        Returns:
        An unmodifiable list containing immutable objects of type TestScript.Destination that may be empty.

      • getMetadata

        public TestScript.Metadata getMetadata()
        The required capability must exist and are assumed to function correctly on the FHIR server being tested.
        Returns:
        An immutable object of type TestScript.Metadata that may be null.

      • getFixture

        public java.util.List<TestScript.Fixture> getFixture()
        Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
        Returns:
        An unmodifiable list containing immutable objects of type TestScript.Fixture that may be empty.

      • getProfile

        public java.util.List<Reference> getProfile()
        Reference to the profile to be used for validation.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getVariable

        public java.util.List<TestScript.Variable> getVariable()
        Variable is set based either on element value in response body or on header field value in the response headers.
        Returns:
        An unmodifiable list containing immutable objects of type TestScript.Variable that may be empty.

      • getSetup

        public TestScript.Setup getSetup()
        A series of required setup operations before tests are executed.
        Returns:
        An immutable object of type TestScript.Setup that may be null.

      • getTest

        public java.util.List<TestScript.Test> getTest()
        A test in this script.
        Returns:
        An unmodifiable list containing immutable objects of type TestScript.Test that may be empty.

      • getTeardown

        public TestScript.Teardown getTeardown()
        A series of operations required to clean up after all the tests are executed (successfully or otherwise).
        Returns:
        An immutable object of type TestScript.Teardown that may be null.

      • accept

        public void accept​(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object