Class TestScript

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class TestScript
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR TestScript Resource ()

    Definition: TestScript is a resource that specifies a suite of tests against a FHIR server implementation to determine compliance against the FHIR specification.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/TestScript

    See Also:
    Serialized Form
    • Field Detail

      • URL

        public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
        Fluent Client search parameter constant for url

        Description:
        Type: uri
        Path: TestScript.url

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description:
        Type: token
        Path: TestScript.identifier

      • NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
        Fluent Client search parameter constant for name

        Description:
        Type: string
        Path: TestScript.name

      • DESCRIPTION

        public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
        Fluent Client search parameter constant for description

        Description:
        Type: string
        Path: TestScript.description

      • SP_TESTSCRIPT_CAPABILITY

        public static final String SP_TESTSCRIPT_CAPABILITY
        Search parameter constant for testscript-capability

        Description: TestScript required and validated capability
        Type: string
        Path: TestScript.metadata.capability.description

        See Also:
        Constant Field Values
      • TESTSCRIPT_CAPABILITY

        public static final ca.uhn.fhir.rest.gclient.StringClientParam TESTSCRIPT_CAPABILITY
        Fluent Client search parameter constant for testscript-capability

        Description: TestScript required and validated capability
        Type: string
        Path: TestScript.metadata.capability.description

      • SP_TESTSCRIPT_SETUP_CAPABILITY

        public static final String SP_TESTSCRIPT_SETUP_CAPABILITY
        Search parameter constant for testscript-setup-capability

        Description: TestScript setup required and validated capability
        Type: string
        Path: TestScript.setup.metadata.capability.description

        See Also:
        Constant Field Values
      • TESTSCRIPT_SETUP_CAPABILITY

        public static final ca.uhn.fhir.rest.gclient.StringClientParam TESTSCRIPT_SETUP_CAPABILITY
        Fluent Client search parameter constant for testscript-setup-capability

        Description: TestScript setup required and validated capability
        Type: string
        Path: TestScript.setup.metadata.capability.description

      • SP_TESTSCRIPT_TEST_CAPABILITY

        public static final String SP_TESTSCRIPT_TEST_CAPABILITY
        Search parameter constant for testscript-test-capability

        Description: TestScript test required and validated capability
        Type: string
        Path: TestScript.test.metadata.capability.description

        See Also:
        Constant Field Values
      • TESTSCRIPT_TEST_CAPABILITY

        public static final ca.uhn.fhir.rest.gclient.StringClientParam TESTSCRIPT_TEST_CAPABILITY
        Fluent Client search parameter constant for testscript-test-capability

        Description: TestScript test required and validated capability
        Type: string
        Path: TestScript.test.metadata.capability.description

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getUrlElement

        public ca.uhn.fhir.model.primitive.UriDt getUrlElement()
        Gets the value(s) for url (). creating it if it does not exist. Will not return null.

        Definition: An absolute URL that is used to identify this Test Script. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Test Script is (or will be) published

      • getUrl

        public String getUrl()
        Gets the value(s) for url (). creating it if it does not exist. This method may return null.

        Definition: An absolute URL that is used to identify this Test Script. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Test Script is (or will be) published

      • setUrl

        public TestScript setUrl​(ca.uhn.fhir.model.primitive.UriDt theValue)
        Sets the value(s) for url ()

        Definition: An absolute URL that is used to identify this Test Script. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Test Script is (or will be) published

      • setUrl

        public TestScript setUrl​(String theUri)
        Sets the value for url ()

        Definition: An absolute URL that is used to identify this Test Script. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Test Script is (or will be) published

      • getVersionElement

        public ca.uhn.fhir.model.primitive.StringDt getVersionElement()
        Gets the value(s) for version (). creating it if it does not exist. Will not return null.

        Definition: The identifier that is used to identify this version of the TestScript. This is an arbitrary value managed by the TestScript author manually

      • getVersion

        public String getVersion()
        Gets the value(s) for version (). creating it if it does not exist. This method may return null.

        Definition: The identifier that is used to identify this version of the TestScript. This is an arbitrary value managed by the TestScript author manually

      • setVersion

        public TestScript setVersion​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for version ()

        Definition: The identifier that is used to identify this version of the TestScript. This is an arbitrary value managed by the TestScript author manually

      • setVersion

        public TestScript setVersion​(String theString)
        Sets the value for version ()

        Definition: The identifier that is used to identify this version of the TestScript. This is an arbitrary value managed by the TestScript author manually

      • getNameElement

        public ca.uhn.fhir.model.primitive.StringDt getNameElement()
        Gets the value(s) for name (). creating it if it does not exist. Will not return null.

        Definition: A free text natural language name identifying the TestScript

      • getName

        public String getName()
        Gets the value(s) for name (). creating it if it does not exist. This method may return null.

        Definition: A free text natural language name identifying the TestScript

      • setName

        public TestScript setName​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for name ()

        Definition: A free text natural language name identifying the TestScript

      • setName

        public TestScript setName​(String theString)
        Sets the value for name ()

        Definition: A free text natural language name identifying the TestScript

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnumgetStatusElement()
        Gets the value(s) for status (). creating it if it does not exist. Will not return null.

        Definition: The status of the TestScript

      • getStatus

        public String getStatus()
        Gets the value(s) for status (). creating it if it does not exist. This method may return null.

        Definition: The status of the TestScript

      • getIdentifier

        public IdentifierDt getIdentifier()
        Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

        Definition: Identifier for the TestScript assigned for external purposes outside the context of FHIR.

      • setIdentifier

        public TestScript setIdentifier​(IdentifierDt theValue)
        Sets the value(s) for identifier ()

        Definition: Identifier for the TestScript assigned for external purposes outside the context of FHIR.

      • getExperimentalElement

        public ca.uhn.fhir.model.primitive.BooleanDt getExperimentalElement()
        Gets the value(s) for experimental (). creating it if it does not exist. Will not return null.

        Definition: This TestScript was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage

      • getExperimental

        public Boolean getExperimental()
        Gets the value(s) for experimental (). creating it if it does not exist. This method may return null.

        Definition: This TestScript was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage

      • setExperimental

        public TestScript setExperimental​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for experimental ()

        Definition: This TestScript was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage

      • setExperimental

        public TestScript setExperimental​(boolean theBoolean)
        Sets the value for experimental ()

        Definition: This TestScript was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage

      • getPublisherElement

        public ca.uhn.fhir.model.primitive.StringDt getPublisherElement()
        Gets the value(s) for publisher (). creating it if it does not exist. Will not return null.

        Definition: The name of the individual or organization that published the Test Script

      • getPublisher

        public String getPublisher()
        Gets the value(s) for publisher (). creating it if it does not exist. This method may return null.

        Definition: The name of the individual or organization that published the Test Script

      • setPublisher

        public TestScript setPublisher​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for publisher ()

        Definition: The name of the individual or organization that published the Test Script

      • setPublisher

        public TestScript setPublisher​(String theString)
        Sets the value for publisher ()

        Definition: The name of the individual or organization that published the Test Script

      • getContact

        public List<TestScript.ContactgetContact()
        Gets the value(s) for contact (). creating it if it does not exist. Will not return null.

        Definition: Contacts to assist a user in finding and communicating with the publisher

      • addContact

        public TestScript.Contact addContact()
        Adds and returns a new value for contact ()

        Definition: Contacts to assist a user in finding and communicating with the publisher

      • addContact

        public TestScript addContact​(TestScript.Contact theValue)
        Adds a given new value for contact ()

        Definition: Contacts to assist a user in finding and communicating with the publisher

        Parameters:
        theValue - The contact to add (must not be null)
      • getContactFirstRep

        public TestScript.Contact getContactFirstRep()
        Gets the first repetition for contact (), creating it if it does not already exist.

        Definition: Contacts to assist a user in finding and communicating with the publisher

      • getDateElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
        Gets the value(s) for date (). creating it if it does not exist. Will not return null.

        Definition: The date this version of the test tcript was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the test cases change

      • getDate

        public Date getDate()
        Gets the value(s) for date (). creating it if it does not exist. This method may return null.

        Definition: The date this version of the test tcript was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the test cases change

      • setDate

        public TestScript setDate​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for date ()

        Definition: The date this version of the test tcript was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the test cases change

      • setDate

        public TestScript setDate​(Date theDate,
                                  ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for date ()

        Definition: The date this version of the test tcript was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the test cases change

      • setDateWithSecondsPrecision

        public TestScript setDateWithSecondsPrecision​(Date theDate)
        Sets the value for date ()

        Definition: The date this version of the test tcript was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the test cases change

      • getDescriptionElement

        public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
        Gets the value(s) for description (). creating it if it does not exist. Will not return null.

        Definition: A free text natural language description of the TestScript and its use

      • getDescription

        public String getDescription()
        Gets the value(s) for description (). creating it if it does not exist. This method may return null.

        Definition: A free text natural language description of the TestScript and its use

      • setDescription

        public TestScript setDescription​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for description ()

        Definition: A free text natural language description of the TestScript and its use

      • setDescription

        public TestScript setDescription​(String theString)
        Sets the value for description ()

        Definition: A free text natural language description of the TestScript and its use

      • getUseContext

        public List<CodeableConceptDtgetUseContext()
        Gets the value(s) for useContext (). creating it if it does not exist. Will not return null.

        Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of Test Scripts.

      • setUseContext

        public TestScript setUseContext​(List<CodeableConceptDt> theValue)
        Sets the value(s) for useContext ()

        Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of Test Scripts.

      • addUseContext

        public CodeableConceptDt addUseContext()
        Adds and returns a new value for useContext ()

        Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of Test Scripts.

      • addUseContext

        public TestScript addUseContext​(CodeableConceptDt theValue)
        Adds a given new value for useContext ()

        Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of Test Scripts.

        Parameters:
        theValue - The useContext to add (must not be null)
      • getUseContextFirstRep

        public CodeableConceptDt getUseContextFirstRep()
        Gets the first repetition for useContext (), creating it if it does not already exist.

        Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of Test Scripts.

      • getRequirementsElement

        public ca.uhn.fhir.model.primitive.StringDt getRequirementsElement()
        Gets the value(s) for requirements (). creating it if it does not exist. Will not return null.

        Definition: Explains why this Test Script is needed and why it's been constrained as it has

      • getRequirements

        public String getRequirements()
        Gets the value(s) for requirements (). creating it if it does not exist. This method may return null.

        Definition: Explains why this Test Script is needed and why it's been constrained as it has

      • setRequirements

        public TestScript setRequirements​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for requirements ()

        Definition: Explains why this Test Script is needed and why it's been constrained as it has

      • setRequirements

        public TestScript setRequirements​(String theString)
        Sets the value for requirements ()

        Definition: Explains why this Test Script is needed and why it's been constrained as it has

      • getCopyrightElement

        public ca.uhn.fhir.model.primitive.StringDt getCopyrightElement()
        Gets the value(s) for copyright (). creating it if it does not exist. Will not return null.

        Definition: 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 details of the constraints and mappings

      • getCopyright

        public String getCopyright()
        Gets the value(s) for copyright (). creating it if it does not exist. This method may return null.

        Definition: 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 details of the constraints and mappings

      • setCopyright

        public TestScript setCopyright​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for copyright ()

        Definition: 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 details of the constraints and mappings

      • setCopyright

        public TestScript setCopyright​(String theString)
        Sets the value for copyright ()

        Definition: 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 details of the constraints and mappings

      • getMetadata

        public TestScript.Metadata getMetadata()
        Gets the value(s) for metadata (). creating it if it does not exist. Will not return null.

        Definition: The required capability must exist and are assumed to function correctly on the FHIR server being tested.

      • setMetadata

        public TestScript setMetadata​(TestScript.Metadata theValue)
        Sets the value(s) for metadata ()

        Definition: The required capability must exist and are assumed to function correctly on the FHIR server being tested.

      • getMultiserverElement

        public ca.uhn.fhir.model.primitive.BooleanDt getMultiserverElement()
        Gets the value(s) for multiserver (). creating it if it does not exist. Will not return null.

        Definition: If the tests apply to more than one FHIR server (e.g. cross-server interoperability tests) then multiserver=true. Defaults to false if value is unspecified.

      • getMultiserver

        public Boolean getMultiserver()
        Gets the value(s) for multiserver (). creating it if it does not exist. This method may return null.

        Definition: If the tests apply to more than one FHIR server (e.g. cross-server interoperability tests) then multiserver=true. Defaults to false if value is unspecified.

      • setMultiserver

        public TestScript setMultiserver​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for multiserver ()

        Definition: If the tests apply to more than one FHIR server (e.g. cross-server interoperability tests) then multiserver=true. Defaults to false if value is unspecified.

      • setMultiserver

        public TestScript setMultiserver​(boolean theBoolean)
        Sets the value for multiserver ()

        Definition: If the tests apply to more than one FHIR server (e.g. cross-server interoperability tests) then multiserver=true. Defaults to false if value is unspecified.

      • getFixture

        public List<TestScript.FixturegetFixture()
        Gets the value(s) for fixture (). creating it if it does not exist. Will not return null.

        Definition: Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.

      • setFixture

        public TestScript setFixture​(List<TestScript.Fixture> theValue)
        Sets the value(s) for fixture ()

        Definition: Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.

      • addFixture

        public TestScript.Fixture addFixture()
        Adds and returns a new value for fixture ()

        Definition: Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.

      • addFixture

        public TestScript addFixture​(TestScript.Fixture theValue)
        Adds a given new value for fixture ()

        Definition: Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.

        Parameters:
        theValue - The fixture to add (must not be null)
      • getFixtureFirstRep

        public TestScript.Fixture getFixtureFirstRep()
        Gets the first repetition for fixture (), creating it if it does not already exist.

        Definition: Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.

      • getProfile

        public List<ResourceReferenceDtgetProfile()
        Gets the value(s) for profile (). creating it if it does not exist. Will not return null.

        Definition: Reference to the profile to be used for validation.

      • addProfile

        public ResourceReferenceDt addProfile()
        Adds and returns a new value for profile ()

        Definition: Reference to the profile to be used for validation.

      • getVariable

        public List<TestScript.VariablegetVariable()
        Gets the value(s) for variable (). creating it if it does not exist. Will not return null.

        Definition: Variable is set based either on element value in response body or on header field value in the response headers.

      • setVariable

        public TestScript setVariable​(List<TestScript.Variable> theValue)
        Sets the value(s) for variable ()

        Definition: Variable is set based either on element value in response body or on header field value in the response headers.

      • addVariable

        public TestScript.Variable addVariable()
        Adds and returns a new value for variable ()

        Definition: Variable is set based either on element value in response body or on header field value in the response headers.

      • addVariable

        public TestScript addVariable​(TestScript.Variable theValue)
        Adds a given new value for variable ()

        Definition: Variable is set based either on element value in response body or on header field value in the response headers.

        Parameters:
        theValue - The variable to add (must not be null)
      • getVariableFirstRep

        public TestScript.Variable getVariableFirstRep()
        Gets the first repetition for variable (), creating it if it does not already exist.

        Definition: Variable is set based either on element value in response body or on header field value in the response headers.

      • getSetup

        public TestScript.Setup getSetup()
        Gets the value(s) for setup (). creating it if it does not exist. Will not return null.

        Definition: A series of required setup operations before tests are executed.

      • setSetup

        public TestScript setSetup​(TestScript.Setup theValue)
        Sets the value(s) for setup ()

        Definition: A series of required setup operations before tests are executed.

      • getTest

        public List<TestScript.TestgetTest()
        Gets the value(s) for test (). creating it if it does not exist. Will not return null.

        Definition: A test in this script.

      • addTest

        public TestScript.Test addTest()
        Adds and returns a new value for test ()

        Definition: A test in this script.

      • addTest

        public TestScript addTest​(TestScript.Test theValue)
        Adds a given new value for test ()

        Definition: A test in this script.

        Parameters:
        theValue - The test to add (must not be null)
      • getTestFirstRep

        public TestScript.Test getTestFirstRep()
        Gets the first repetition for test (), creating it if it does not already exist.

        Definition: A test in this script.

      • getTeardown

        public TestScript.Teardown getTeardown()
        Gets the value(s) for teardown (). creating it if it does not exist. Will not return null.

        Definition: A series of operations required to clean up after the all the tests are executed (successfully or otherwise).

      • setTeardown

        public TestScript setTeardown​(TestScript.Teardown theValue)
        Sets the value(s) for teardown ()

        Definition: A series of operations required to clean up after the all the tests are executed (successfully or otherwise).

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource