Class ExampleScenario
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.ExampleScenario
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class ExampleScenario extends DomainResource
Example of workflow instance.Maturity level: FMM0 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ExampleScenario.Actor
Actor participating in the resource.static class
ExampleScenario.Builder
static class
ExampleScenario.Instance
Each resource and each version that is present in the workflow.static class
ExampleScenario.Process
Each major process - a group of operations.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static ExampleScenario.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<ExampleScenario.Actor>
getActor()
Actor participating in the resource.java.util.List<ContactDetail>
getContact()
Contact details to assist a user in finding and communicating with the publisher.Markdown
getCopyright()
A copyright statement relating to the example scenario and/or its contents.DateTime
getDate()
The date (and optionally time) when the example scenario was published.Boolean
getExperimental()
A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.java.util.List<Identifier>
getIdentifier()
A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.java.util.List<ExampleScenario.Instance>
getInstance()
Each resource and each version that is present in the workflow.java.util.List<CodeableConcept>
getJurisdiction()
A legal or geographic region in which the example scenario is intended to be used.String
getName()
A natural language name identifying the example scenario.java.util.List<ExampleScenario.Process>
getProcess()
Each major process - a group of operations.String
getPublisher()
The name of the organization or individual that published the example scenario.Markdown
getPurpose()
What the example scenario resource is created for.PublicationStatus
getStatus()
The status of this example scenario.Uri
getUrl()
An absolute URI that is used to identify this example scenario when it is referenced in a specification, model, design or an instance; also called its canonical identifier.java.util.List<UsageContext>
getUseContext()
The content was developed with a focus and intent of supporting the contexts that are listed.String
getVersion()
The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance.java.util.List<Canonical>
getWorkflow()
Another nested workflow.boolean
hasChildren()
int
hashCode()
ExampleScenario.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.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 example scenario 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 example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers.- Returns:
- An immutable object of type
Uri
that may be null.
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getVersion
public String getVersion()
The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario 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 example scenario. 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 may be null.
-
getStatus
public PublicationStatus getStatus()
The status of this example scenario. 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 example scenario 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 example scenario 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 example scenario changes. (e.g. the 'content logical definition').- 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 example scenario.- 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.
-
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 example scenario 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 example scenario is intended to be used.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getCopyright
public Markdown getCopyright()
A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getPurpose
public Markdown getPurpose()
What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getActor
public java.util.List<ExampleScenario.Actor> getActor()
Actor participating in the resource.- Returns:
- An unmodifiable list containing immutable objects of type
ExampleScenario.Actor
that may be empty.
-
getInstance
public java.util.List<ExampleScenario.Instance> getInstance()
Each resource and each version that is present in the workflow.- Returns:
- An unmodifiable list containing immutable objects of type
ExampleScenario.Instance
that may be empty.
-
getProcess
public java.util.List<ExampleScenario.Process> getProcess()
Each major process - a group of operations.- Returns:
- An unmodifiable list containing immutable objects of type
ExampleScenario.Process
that may be empty.
-
getWorkflow
public java.util.List<Canonical> getWorkflow()
Another nested workflow.- Returns:
- An unmodifiable list containing immutable objects of type
Canonical
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
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 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
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public ExampleScenario.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 ExampleScenario.Builder builder()
-
-