Package com.ibm.fhir.model.resource
Class TestScript
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.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)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TestScript.Builder
static class
TestScript.Destination
An abstract server used in operations within this test script in the destination element.static class
TestScript.Fixture
Fixture in the test script - by reference (uri).static class
TestScript.Metadata
The required capability must exist and are assumed to function correctly on the FHIR server being tested.static class
TestScript.Origin
An abstract server used in operations within this test script in the origin element.static class
TestScript.Setup
A series of required setup operations before tests are executed.static class
TestScript.Teardown
A series of operations required to clean up after all the tests are executed (successfully or otherwise).static class
TestScript.Test
A test in this script.static class
TestScript.Variable
Variable is set based either on element value in response body or on header field value in the response headers.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource
id, implicitRules, language, meta
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static TestScript.Builder
builder()
boolean
equals(Object obj)
List<ContactDetail>
getContact()
Contact details to assist a user in finding and communicating with the publisher.Markdown
getCopyright()
A copyright statement relating to the test script and/or its contents.DateTime
getDate()
The date (and optionally time) when the test script was published.Markdown
getDescription()
A free text natural language description of the test script from a consumer's perspective.List<TestScript.Destination>
getDestination()
An abstract server used in operations within this test script in the destination element.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.List<TestScript.Fixture>
getFixture()
Fixture in the test script - by reference (uri).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.List<CodeableConcept>
getJurisdiction()
A legal or geographic region in which the test script is intended to be used.TestScript.Metadata
getMetadata()
The required capability must exist and are assumed to function correctly on the FHIR server being tested.String
getName()
A natural language name identifying the test script.List<TestScript.Origin>
getOrigin()
An abstract server used in operations within this test script in the origin element.List<Reference>
getProfile()
Reference to the profile to be used for validation.String
getPublisher()
The name of the organization or individual that published the test script.Markdown
getPurpose()
Explanation of why this test script is needed and why it has been designed as it has.TestScript.Setup
getSetup()
A series of required setup operations before tests are executed.PublicationStatus
getStatus()
The status of this test script.TestScript.Teardown
getTeardown()
A series of operations required to clean up after all the tests are executed (successfully or otherwise).List<TestScript.Test>
getTest()
A test in this script.String
getTitle()
A short, descriptive, user-friendly title for the test script.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.List<UsageContext>
getUseContext()
The content was developed with a focus and intent of supporting the contexts that are listed.List<TestScript.Variable>
getVariable()
Variable is set based either on element value in response body or on header field value in the response headers.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.boolean
hasChildren()
int
hashCode()
TestScript.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
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 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 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 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 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 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 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 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 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 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.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(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 interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
toBuilder
public TestScript.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static TestScript.Builder builder()
-
-