Class ExampleScenario
- java.lang.Object
-
- org.hl7.fhir.r4b.model.Base
-
- org.hl7.fhir.r4b.model.BaseResource
-
- org.hl7.fhir.r4b.model.Resource
-
- org.hl7.fhir.r4b.model.DomainResource
-
- org.hl7.fhir.r4b.model.CanonicalResource
-
- org.hl7.fhir.r4b.model.ExampleScenario
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
public class ExampleScenario extends CanonicalResource
Example of workflow instance.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classExampleScenario.ExampleScenarioActorComponentstatic classExampleScenario.ExampleScenarioActorTypestatic classExampleScenario.ExampleScenarioActorTypeEnumFactorystatic classExampleScenario.ExampleScenarioInstanceComponentstatic classExampleScenario.ExampleScenarioInstanceContainedInstanceComponentstatic classExampleScenario.ExampleScenarioInstanceVersionComponentstatic classExampleScenario.ExampleScenarioProcessComponentstatic classExampleScenario.ExampleScenarioProcessStepAlternativeComponentstatic classExampleScenario.ExampleScenarioProcessStepComponentstatic classExampleScenario.ExampleScenarioProcessStepOperationComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<ExampleScenario.ExampleScenarioActorComponent>actorActor participating in the resource.protected List<ContactDetail>contactContact details to assist a user in finding and communicating with the publisher.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamCONTEXT_QUANTITYFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXT_TYPEFluent Client search parameter constant for context-typestatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantitystatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueprotected MarkdownTypecopyrightA copyright statement relating to the example scenario and/or its contents.protected DateTimeTypedateThe date (and optionally time) when the example scenario was published.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected BooleanTypeexperimentalA 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.protected List<Identifier>identifierA 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.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierprotected List<ExampleScenario.ExampleScenarioInstanceComponent>instanceEach resource and each version that is present in the workflow.protected List<CodeableConcept>jurisdictionA legal or geographic region in which the example scenario is intended to be used.static ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionprotected StringTypenameA natural language name identifying the example scenario.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected List<ExampleScenario.ExampleScenarioProcessComponent>processEach major process - a group of operations.protected StringTypepublisherThe name of the organization or individual that published the example scenario.static ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected MarkdownTypepurposeWhat the example scenario resource is created for.static StringSP_CONTEXTSearch parameter: contextstatic StringSP_CONTEXT_QUANTITYSearch parameter: context-quantitystatic StringSP_CONTEXT_TYPESearch parameter: context-typestatic StringSP_CONTEXT_TYPE_QUANTITYSearch parameter: context-type-quantitystatic StringSP_CONTEXT_TYPE_VALUESearch parameter: context-type-valuestatic StringSP_DATESearch parameter: datestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_NAMESearch parameter: namestatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_STATUSSearch parameter: statusstatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionprotected Enumeration<Enumerations.PublicationStatus>statusThe status of this example scenario.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected UriTypeurlAn 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.static ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected List<UsageContext>useContextThe content was developed with a focus and intent of supporting the contexts that are listed.protected StringTypeversionThe identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance.static ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for versionprotected List<CanonicalType>workflowAnother nested workflow.-
Fields inherited from class org.hl7.fhir.r4b.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r4b.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ExampleScenario()ConstructorExampleScenario(Enumerations.PublicationStatus status)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4b.model.CanonicalResource
copyValues, getContactMax, getCopyrightMax, getDateMax, getDescriptionMax, getExperimentalMax, getIdentifierMax, getJurisdictionMax, getNameMax, getPublisherMax, getPurposeMax, getStatusMax, getTitleMax, getUrlMax, getUseContextMax, getVersionedUrl, getVersionMax, getVUrl, present, supportsCopyright, toString
-
Methods inherited from class org.hl7.fhir.r4b.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4b.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4b.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4b.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
url
protected UriType url
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.
-
identifier
protected List<Identifier> identifier
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.
-
version
protected StringType version
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.
-
name
protected StringType name
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.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
The status of this example scenario. Enables tracking the life-cycle of the content.
-
experimental
protected BooleanType experimental
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.
-
date
protected DateTimeType date
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').
-
publisher
protected StringType publisher
The name of the organization or individual that published the example scenario.
-
contact
protected List<ContactDetail> contact
Contact details to assist a user in finding and communicating with the publisher.
-
useContext
protected List<UsageContext> useContext
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.
-
jurisdiction
protected List<CodeableConcept> jurisdiction
A legal or geographic region in which the example scenario is intended to be used.
-
copyright
protected MarkdownType copyright
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.
-
purpose
protected MarkdownType purpose
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.
-
actor
protected List<ExampleScenario.ExampleScenarioActorComponent> actor
Actor participating in the resource.
-
instance
protected List<ExampleScenario.ExampleScenarioInstanceComponent> instance
Each resource and each version that is present in the workflow.
-
process
protected List<ExampleScenario.ExampleScenarioProcessComponent> process
Each major process - a group of operations.
-
workflow
protected List<CanonicalType> workflow
Another nested workflow.
-
SP_CONTEXT_QUANTITY
public static final String SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the example scenario
Type: quantity
Path: (ExampleScenario.useContext.value as Quantity) | (ExampleScenario.useContext.value as Range)
- See Also:
- Constant Field Values
-
CONTEXT_QUANTITY
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the example scenario
Type: quantity
Path: (ExampleScenario.useContext.value as Quantity) | (ExampleScenario.useContext.value as Range)
-
SP_CONTEXT_TYPE_QUANTITY
public static final String SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the example scenario
Type: composite
Path: ExampleScenario.useContext
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_QUANTITY
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
Fluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the example scenario
Type: composite
Path: ExampleScenario.useContext
-
SP_CONTEXT_TYPE_VALUE
public static final String SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the example scenario
Type: composite
Path: ExampleScenario.useContext
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_VALUE
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
Fluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the example scenario
Type: composite
Path: ExampleScenario.useContext
-
SP_CONTEXT_TYPE
public static final String SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the example scenario
Type: token
Path: ExampleScenario.useContext.code
- See Also:
- Constant Field Values
-
CONTEXT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the example scenario
Type: token
Path: ExampleScenario.useContext.code
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the example scenario
Type: token
Path: (ExampleScenario.useContext.value as CodeableConcept)
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the example scenario
Type: token
Path: (ExampleScenario.useContext.value as CodeableConcept)
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: The example scenario publication date
Type: date
Path: ExampleScenario.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: The example scenario publication date
Type: date
Path: ExampleScenario.date
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the example scenario
Type: token
Path: ExampleScenario.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the example scenario
Type: token
Path: ExampleScenario.identifier
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the example scenario
Type: token
Path: ExampleScenario.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the example scenario
Type: token
Path: ExampleScenario.jurisdiction
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Computationally friendly name of the example scenario
Type: string
Path: ExampleScenario.name
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the example scenario
Type: string
Path: ExampleScenario.name
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the example scenario
Type: string
Path: ExampleScenario.publisher
- See Also:
- Constant Field Values
-
PUBLISHER
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the example scenario
Type: string
Path: ExampleScenario.publisher
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The current status of the example scenario
Type: token
Path: ExampleScenario.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: The current status of the example scenario
Type: token
Path: ExampleScenario.status
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The uri that identifies the example scenario
Type: uri
Path: ExampleScenario.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the example scenario
Type: uri
Path: ExampleScenario.url
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: The business version of the example scenario
Type: token
Path: ExampleScenario.version
- See Also:
- Constant Field Values
-
VERSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Fluent Client search parameter constant for versionDescription: The business version of the example scenario
Type: token
Path: ExampleScenario.version
-
-
Constructor Detail
-
ExampleScenario
public ExampleScenario()
Constructor
-
ExampleScenario
public ExampleScenario(Enumerations.PublicationStatus status)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Specified by:
getUrlElementin classCanonicalResource- Returns:
url(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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
- Specified by:
hasUrlElementin classCanonicalResource
-
hasUrl
public boolean hasUrl()
- Specified by:
hasUrlin classCanonicalResource
-
setUrlElement
public ExampleScenario setUrlElement(UriType value)
- Specified by:
setUrlElementin classCanonicalResource- Parameters:
value-url(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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Specified by:
getUrlin classCanonicalResource- Returns:
- 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.
-
setUrl
public ExampleScenario setUrl(String value)
- Specified by:
setUrlin classCanonicalResource- Parameters:
value- 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.
-
getIdentifier
public List<Identifier> getIdentifier()
- Specified by:
getIdentifierin classCanonicalResource- Returns:
identifier(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.)
-
setIdentifier
public ExampleScenario setIdentifier(List<Identifier> theIdentifier)
- Specified by:
setIdentifierin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
- Specified by:
hasIdentifierin classCanonicalResource
-
addIdentifier
public Identifier addIdentifier()
- Specified by:
addIdentifierin classCanonicalResource
-
addIdentifier
public ExampleScenario addIdentifier(Identifier t)
- Specified by:
addIdentifierin classCanonicalResource
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Specified by:
getIdentifierFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getVersionElement
public StringType getVersionElement()
- Specified by:
getVersionElementin classCanonicalResource- Returns:
version(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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
public boolean hasVersionElement()
- Specified by:
hasVersionElementin classCanonicalResource
-
hasVersion
public boolean hasVersion()
- Specified by:
hasVersionin classCanonicalResource
-
setVersionElement
public ExampleScenario setVersionElement(StringType value)
- Specified by:
setVersionElementin classCanonicalResource- Parameters:
value-version(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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
public String getVersion()
- Specified by:
getVersionin classCanonicalResource- Returns:
- 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.
-
setVersion
public ExampleScenario setVersion(String value)
- Specified by:
setVersionin classCanonicalResource- Parameters:
value- 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.
-
getNameElement
public StringType getNameElement()
- Specified by:
getNameElementin classCanonicalResource- Returns:
name(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.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
public boolean hasNameElement()
- Specified by:
hasNameElementin classCanonicalResource
-
hasName
public boolean hasName()
- Specified by:
hasNamein classCanonicalResource
-
setNameElement
public ExampleScenario setNameElement(StringType value)
- Specified by:
setNameElementin classCanonicalResource- Parameters:
value-name(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.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
public String getName()
- Specified by:
getNamein classCanonicalResource- Returns:
- 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.
-
setName
public ExampleScenario setName(String value)
- Specified by:
setNamein classCanonicalResource- Parameters:
value- 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.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Specified by:
getStatusElementin classCanonicalResource- Returns:
status(The status of this example scenario. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
- Specified by:
hasStatusElementin classCanonicalResource
-
hasStatus
public boolean hasStatus()
- Specified by:
hasStatusin classCanonicalResource
-
setStatusElement
public ExampleScenario setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Specified by:
setStatusElementin classCanonicalResource- Parameters:
value-status(The status of this example scenario. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Specified by:
getStatusin classCanonicalResource- Returns:
- The status of this example scenario. Enables tracking the life-cycle of the content.
-
setStatus
public ExampleScenario setStatus(Enumerations.PublicationStatus value)
- Specified by:
setStatusin classCanonicalResource- Parameters:
value- The status of this example scenario. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Specified by:
getExperimentalElementin classCanonicalResource- Returns:
experimental(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.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
hasExperimentalElement
public boolean hasExperimentalElement()
- Specified by:
hasExperimentalElementin classCanonicalResource
-
hasExperimental
public boolean hasExperimental()
- Specified by:
hasExperimentalin classCanonicalResource
-
setExperimentalElement
public ExampleScenario setExperimentalElement(BooleanType value)
- Specified by:
setExperimentalElementin classCanonicalResource- Parameters:
value-experimental(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.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
getExperimental
public boolean getExperimental()
- Specified by:
getExperimentalin classCanonicalResource- Returns:
- 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.
-
setExperimental
public ExampleScenario setExperimental(boolean value)
- Specified by:
setExperimentalin classCanonicalResource- Parameters:
value- 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.
-
getDateElement
public DateTimeType getDateElement()
- Specified by:
getDateElementin classCanonicalResource- Returns:
date(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').). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
- Specified by:
hasDateElementin classCanonicalResource
-
hasDate
public boolean hasDate()
- Specified by:
hasDatein classCanonicalResource
-
setDateElement
public ExampleScenario setDateElement(DateTimeType value)
- Specified by:
setDateElementin classCanonicalResource- Parameters:
value-date(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').). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Specified by:
getDatein classCanonicalResource- Returns:
- 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').
-
setDate
public ExampleScenario setDate(Date value)
- Specified by:
setDatein classCanonicalResource- Parameters:
value- 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').
-
getPublisherElement
public StringType getPublisherElement()
- Specified by:
getPublisherElementin classCanonicalResource- Returns:
publisher(The name of the organization or individual that published the example scenario.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
public boolean hasPublisherElement()
- Specified by:
hasPublisherElementin classCanonicalResource
-
hasPublisher
public boolean hasPublisher()
- Specified by:
hasPublisherin classCanonicalResource
-
setPublisherElement
public ExampleScenario setPublisherElement(StringType value)
- Specified by:
setPublisherElementin classCanonicalResource- Parameters:
value-publisher(The name of the organization or individual that published the example scenario.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
public String getPublisher()
- Specified by:
getPublisherin classCanonicalResource- Returns:
- The name of the organization or individual that published the example scenario.
-
setPublisher
public ExampleScenario setPublisher(String value)
- Specified by:
setPublisherin classCanonicalResource- Parameters:
value- The name of the organization or individual that published the example scenario.
-
getContact
public List<ContactDetail> getContact()
- Specified by:
getContactin classCanonicalResource- Returns:
contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public ExampleScenario setContact(List<ContactDetail> theContact)
- Specified by:
setContactin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
- Specified by:
hasContactin classCanonicalResource
-
addContact
public ContactDetail addContact()
- Specified by:
addContactin classCanonicalResource
-
addContact
public ExampleScenario addContact(ContactDetail t)
- Specified by:
addContactin classCanonicalResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Specified by:
getContactFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist {3}
-
getUseContext
public List<UsageContext> getUseContext()
- Specified by:
getUseContextin classCanonicalResource- Returns:
useContext(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.)
-
setUseContext
public ExampleScenario setUseContext(List<UsageContext> theUseContext)
- Specified by:
setUseContextin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Specified by:
hasUseContextin classCanonicalResource
-
addUseContext
public UsageContext addUseContext()
- Specified by:
addUseContextin classCanonicalResource
-
addUseContext
public ExampleScenario addUseContext(UsageContext t)
- Specified by:
addUseContextin classCanonicalResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Specified by:
getUseContextFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
useContext, creating it if it does not already exist {3}
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Specified by:
getJurisdictionin classCanonicalResource- Returns:
jurisdiction(A legal or geographic region in which the example scenario is intended to be used.)
-
setJurisdiction
public ExampleScenario setJurisdiction(List<CodeableConcept> theJurisdiction)
- Specified by:
setJurisdictionin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Specified by:
hasJurisdictionin classCanonicalResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Specified by:
addJurisdictionin classCanonicalResource
-
addJurisdiction
public ExampleScenario addJurisdiction(CodeableConcept t)
- Specified by:
addJurisdictionin classCanonicalResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Specified by:
getJurisdictionFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
jurisdiction, creating it if it does not already exist {3}
-
getCopyrightElement
public MarkdownType getCopyrightElement()
- Specified by:
getCopyrightElementin classCanonicalResource- Returns:
copyright(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.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
public boolean hasCopyrightElement()
- Specified by:
hasCopyrightElementin classCanonicalResource
-
hasCopyright
public boolean hasCopyright()
- Specified by:
hasCopyrightin classCanonicalResource
-
setCopyrightElement
public ExampleScenario setCopyrightElement(MarkdownType value)
- Specified by:
setCopyrightElementin classCanonicalResource- Parameters:
value-copyright(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.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
public String getCopyright()
- Specified by:
getCopyrightin classCanonicalResource- Returns:
- 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.
-
setCopyright
public ExampleScenario setCopyright(String value)
- Specified by:
setCopyrightin classCanonicalResource- Parameters:
value- 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.
-
getPurposeElement
public MarkdownType getPurposeElement()
- Specified by:
getPurposeElementin classCanonicalResource- Returns:
purpose(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.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
hasPurposeElement
public boolean hasPurposeElement()
- Specified by:
hasPurposeElementin classCanonicalResource
-
hasPurpose
public boolean hasPurpose()
- Specified by:
hasPurposein classCanonicalResource
-
setPurposeElement
public ExampleScenario setPurposeElement(MarkdownType value)
- Specified by:
setPurposeElementin classCanonicalResource- Parameters:
value-purpose(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.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
getPurpose
public String getPurpose()
- Specified by:
getPurposein classCanonicalResource- Returns:
- 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.
-
setPurpose
public ExampleScenario setPurpose(String value)
- Specified by:
setPurposein classCanonicalResource- Parameters:
value- 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.
-
getActor
public List<ExampleScenario.ExampleScenarioActorComponent> getActor()
- Returns:
actor(Actor participating in the resource.)
-
setActor
public ExampleScenario setActor(List<ExampleScenario.ExampleScenarioActorComponent> theActor)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasActor
public boolean hasActor()
-
addActor
public ExampleScenario.ExampleScenarioActorComponent addActor()
-
addActor
public ExampleScenario addActor(ExampleScenario.ExampleScenarioActorComponent t)
-
getActorFirstRep
public ExampleScenario.ExampleScenarioActorComponent getActorFirstRep()
- Returns:
- The first repetition of repeating field
actor, creating it if it does not already exist {3}
-
getInstance
public List<ExampleScenario.ExampleScenarioInstanceComponent> getInstance()
- Returns:
instance(Each resource and each version that is present in the workflow.)
-
setInstance
public ExampleScenario setInstance(List<ExampleScenario.ExampleScenarioInstanceComponent> theInstance)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInstance
public boolean hasInstance()
-
addInstance
public ExampleScenario.ExampleScenarioInstanceComponent addInstance()
-
addInstance
public ExampleScenario addInstance(ExampleScenario.ExampleScenarioInstanceComponent t)
-
getInstanceFirstRep
public ExampleScenario.ExampleScenarioInstanceComponent getInstanceFirstRep()
- Returns:
- The first repetition of repeating field
instance, creating it if it does not already exist {3}
-
getProcess
public List<ExampleScenario.ExampleScenarioProcessComponent> getProcess()
- Returns:
process(Each major process - a group of operations.)
-
setProcess
public ExampleScenario setProcess(List<ExampleScenario.ExampleScenarioProcessComponent> theProcess)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProcess
public boolean hasProcess()
-
addProcess
public ExampleScenario.ExampleScenarioProcessComponent addProcess()
-
addProcess
public ExampleScenario addProcess(ExampleScenario.ExampleScenarioProcessComponent t)
-
getProcessFirstRep
public ExampleScenario.ExampleScenarioProcessComponent getProcessFirstRep()
- Returns:
- The first repetition of repeating field
process, creating it if it does not already exist {3}
-
getWorkflow
public List<CanonicalType> getWorkflow()
- Returns:
workflow(Another nested workflow.)
-
setWorkflow
public ExampleScenario setWorkflow(List<CanonicalType> theWorkflow)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasWorkflow
public boolean hasWorkflow()
-
addWorkflowElement
public CanonicalType addWorkflowElement()
- Returns:
workflow(Another nested workflow.)
-
addWorkflow
public ExampleScenario addWorkflow(String value)
- Parameters:
value-workflow(Another nested workflow.)
-
hasWorkflow
public boolean hasWorkflow(String value)
- Parameters:
value-workflow(Another nested workflow.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classCanonicalResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classCanonicalResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classCanonicalResource
-
copy
public ExampleScenario copy()
- Specified by:
copyin classCanonicalResource
-
copyValues
public void copyValues(ExampleScenario dst)
-
typedCopy
protected ExampleScenario typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classCanonicalResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classCanonicalResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classCanonicalResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
getTitleElement
public StringType getTitleElement()
- Specified by:
getTitleElementin classCanonicalResource- Returns:
#title(A short, descriptive, user-friendly title for the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
public boolean hasTitleElement()
- Specified by:
hasTitleElementin classCanonicalResource
-
hasTitle
public boolean hasTitle()
- Specified by:
hasTitlein classCanonicalResource
-
setTitleElement
public CanonicalResource setTitleElement(StringType value)
- Specified by:
setTitleElementin classCanonicalResource- Parameters:
value-#title(A short, descriptive, user-friendly title for the canonical resource.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
public String getTitle()
- Specified by:
getTitlein classCanonicalResource- Returns:
- A short, descriptive, user-friendly title for the canonical resource.
-
setTitle
public CanonicalResource setTitle(String value)
- Specified by:
setTitlein classCanonicalResource- Parameters:
value- A short, descriptive, user-friendly title for the canonical resource.
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Specified by:
getDescriptionElementin classCanonicalResource- Returns:
#description(A free text natural language description of the canonical resource from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
- Specified by:
hasDescriptionElementin classCanonicalResource
-
hasDescription
public boolean hasDescription()
- Specified by:
hasDescriptionin classCanonicalResource
-
setDescriptionElement
public CanonicalResource setDescriptionElement(MarkdownType value)
- Specified by:
setDescriptionElementin classCanonicalResource- Parameters:
value-#description(A free text natural language description of the canonical resource from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Specified by:
getDescriptionin classCanonicalResource- Returns:
- A free text natural language description of the canonical resource from a consumer's perspective.
-
setDescription
public CanonicalResource setDescription(String value)
- Specified by:
setDescriptionin classCanonicalResource- Parameters:
value- A free text natural language description of the canonical resource from a consumer's perspective.
-
-