Package org.hl7.fhir.r4.model

Class ExampleScenario

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.MetadataResource

org.hl7.fhir.r4.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 MetadataResource

Example of workflow instance.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExampleScenario.ExampleScenarioActorComponent
static enum	ExampleScenario.ExampleScenarioActorType
static class	ExampleScenario.ExampleScenarioActorTypeEnumFactory
static class	ExampleScenario.ExampleScenarioInstanceComponent
static class	ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent
static class	ExampleScenario.ExampleScenarioInstanceVersionComponent
static class	ExampleScenario.ExampleScenarioProcessComponent
static class	ExampleScenario.ExampleScenarioProcessStepAlternativeComponent
static class	ExampleScenario.ExampleScenarioProcessStepComponent
static class	ExampleScenario.ExampleScenarioProcessStepOperationComponent
static enum	ExampleScenario.FHIRResourceType
static class	ExampleScenario.FHIRResourceTypeEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ExampleScenario.ExampleScenarioActorComponent>	actor	Actor participating in the resource.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT	Fluent Client search parameter constant for context
static final ca.uhn.fhir.rest.gclient.QuantityClientParam	CONTEXT_QUANTITY	Fluent Client search parameter constant for context-quantity
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT_TYPE	Fluent Client search parameter constant for context-type
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-quantity
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-value
protected MarkdownType	copyright	A copyright statement relating to the example scenario and/or its contents.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
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.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
protected List<ExampleScenario.ExampleScenarioInstanceComponent>	instance	Each resource and each version that is present in the workflow.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	JURISDICTION	Fluent Client search parameter constant for jurisdiction
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
protected List<ExampleScenario.ExampleScenarioProcessComponent>	process	Each major process - a group of operations.
static final ca.uhn.fhir.rest.gclient.StringClientParam	PUBLISHER	Fluent Client search parameter constant for publisher
protected MarkdownType	purpose	What the example scenario resource is created for.
static final String	SP_CONTEXT	Search parameter: context
static final String	SP_CONTEXT_QUANTITY	Search parameter: context-quantity
static final String	SP_CONTEXT_TYPE	Search parameter: context-type
static final String	SP_CONTEXT_TYPE_QUANTITY	Search parameter: context-type-quantity
static final String	SP_CONTEXT_TYPE_VALUE	Search parameter: context-type-value
static final String	SP_DATE	Search parameter: date
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_JURISDICTION	Search parameter: jurisdiction
static final String	SP_NAME	Search parameter: name
static final String	SP_PUBLISHER	Search parameter: publisher
static final String	SP_STATUS	Search parameter: status
static final String	SP_URL	Search parameter: url
static final String	SP_VERSION	Search parameter: version
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
static final ca.uhn.fhir.rest.gclient.UriClientParam	URL	Fluent Client search parameter constant for url
static final ca.uhn.fhir.rest.gclient.TokenClientParam	VERSION	Fluent Client search parameter constant for version
protected List<CanonicalType>	workflow	Another nested workflow.

Fields inherited from class org.hl7.fhir.r4.model.MetadataResource

contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
ExampleScenario()	Constructor
ExampleScenario(Enumeration<Enumerations.PublicationStatus> status)	Constructor

Method Summary

Modifier and Type	Method	Description
ExampleScenario.ExampleScenarioActorComponent	addActor()
ExampleScenario	addActor(ExampleScenario.ExampleScenarioActorComponent t)
Base	addChild(String name)
ContactDetail	addContact()
ExampleScenario	addContact(ContactDetail t)
Identifier	addIdentifier()
ExampleScenario	addIdentifier(Identifier t)
ExampleScenario.ExampleScenarioInstanceComponent	addInstance()
ExampleScenario	addInstance(ExampleScenario.ExampleScenarioInstanceComponent t)
CodeableConcept	addJurisdiction()
ExampleScenario	addJurisdiction(CodeableConcept t)
ExampleScenario.ExampleScenarioProcessComponent	addProcess()
ExampleScenario	addProcess(ExampleScenario.ExampleScenarioProcessComponent t)
UsageContext	addUseContext()
ExampleScenario	addUseContext(UsageContext t)
ExampleScenario	addWorkflow(String value)
CanonicalType	addWorkflowElement()
ExampleScenario	copy()
void	copyValues(ExampleScenario dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<ExampleScenario.ExampleScenarioActorComponent>	getActor()
ExampleScenario.ExampleScenarioActorComponent	getActorFirstRep()
List<ContactDetail>	getContact()
ContactDetail	getContactFirstRep()
String	getCopyright()
MarkdownType	getCopyrightElement()
Date	getDate()
DateTimeType	getDateElement()
boolean	getExperimental()
BooleanType	getExperimentalElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<ExampleScenario.ExampleScenarioInstanceComponent>	getInstance()
ExampleScenario.ExampleScenarioInstanceComponent	getInstanceFirstRep()
List<CodeableConcept>	getJurisdiction()
CodeableConcept	getJurisdictionFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
List<ExampleScenario.ExampleScenarioProcessComponent>	getProcess()
ExampleScenario.ExampleScenarioProcessComponent	getProcessFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getPublisher()
StringType	getPublisherElement()
String	getPurpose()
MarkdownType	getPurposeElement()
ResourceType	getResourceType()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
String	getUrl()
UriType	getUrlElement()
List<UsageContext>	getUseContext()
UsageContext	getUseContextFirstRep()
String	getVersion()
StringType	getVersionElement()
List<CanonicalType>	getWorkflow()
boolean	hasActor()
boolean	hasContact()
boolean	hasCopyright()
boolean	hasCopyrightElement()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasExperimental()
boolean	hasExperimentalElement()
boolean	hasIdentifier()
boolean	hasInstance()
boolean	hasJurisdiction()
boolean	hasName()
boolean	hasNameElement()
boolean	hasProcess()
boolean	hasPublisher()
boolean	hasPublisherElement()
boolean	hasPurpose()
boolean	hasPurposeElement()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasUrl()
boolean	hasUrlElement()
boolean	hasUseContext()
boolean	hasVersion()
boolean	hasVersionElement()
boolean	hasWorkflow()
boolean	hasWorkflow(String value)
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ExampleScenario	setActor(List<ExampleScenario.ExampleScenarioActorComponent> theActor)
ExampleScenario	setContact(List<ContactDetail> theContact)
ExampleScenario	setCopyright(String value)
ExampleScenario	setCopyrightElement(MarkdownType value)
ExampleScenario	setDate(Date value)
ExampleScenario	setDateElement(DateTimeType value)
ExampleScenario	setExperimental(boolean value)
ExampleScenario	setExperimentalElement(BooleanType value)
ExampleScenario	setIdentifier(List<Identifier> theIdentifier)
ExampleScenario	setInstance(List<ExampleScenario.ExampleScenarioInstanceComponent> theInstance)
ExampleScenario	setJurisdiction(List<CodeableConcept> theJurisdiction)
ExampleScenario	setName(String value)
ExampleScenario	setNameElement(StringType value)
ExampleScenario	setProcess(List<ExampleScenario.ExampleScenarioProcessComponent> theProcess)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ExampleScenario	setPublisher(String value)
ExampleScenario	setPublisherElement(StringType value)
ExampleScenario	setPurpose(String value)
ExampleScenario	setPurposeElement(MarkdownType value)
ExampleScenario	setStatus(Enumerations.PublicationStatus value)
ExampleScenario	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
ExampleScenario	setUrl(String value)
ExampleScenario	setUrlElement(UriType value)
ExampleScenario	setUseContext(List<UsageContext> theUseContext)
ExampleScenario	setVersion(String value)
ExampleScenario	setVersionElement(StringType value)
ExampleScenario	setWorkflow(List<CanonicalType> theWorkflow)
protected ExampleScenario	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.MetadataResource

copyValues, getDescription, getDescriptionElement, getTitle, getTitleElement, hasDescription, hasDescriptionElement, hasTitle, hasTitleElement, present, setDescription, setDescriptionElement, setTitle, setTitleElement, toString

Methods inherited from class org.hl7.fhir.r4.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, 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.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN, setXhtml

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

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.

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_DATE

public static final String SP_DATE

Search parameter: date

Description: 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 date

Description: The example scenario publication date
Type: date
Path: ExampleScenario.date

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: 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 identifier

Description: External identifier for the example scenario
Type: token
Path: ExampleScenario.identifier

SP_CONTEXT_TYPE_VALUE

public static final String SP_CONTEXT_TYPE_VALUE

Search parameter: context-type-value

Description: A use context type and value assigned to the example scenario
Type: composite
Path:

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-value

Description: A use context type and value assigned to the example scenario
Type: composite
Path:

SP_JURISDICTION

public static final String SP_JURISDICTION

Search parameter: jurisdiction

Description: 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 jurisdiction

Description: Intended jurisdiction for the example scenario
Type: token
Path: ExampleScenario.jurisdiction

SP_CONTEXT_TYPE

public static final String SP_CONTEXT_TYPE

Search parameter: context-type

Description: 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-type

Description: A type of use context assigned to the example scenario
Type: token
Path: ExampleScenario.useContext.code

SP_VERSION

public static final String SP_VERSION

Search parameter: version

Description: 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 version

Description: The business version of the example scenario
Type: token
Path: ExampleScenario.version

SP_URL

public static final String SP_URL

Search parameter: url

Description: 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 url

Description: The uri that identifies the example scenario
Type: uri
Path: ExampleScenario.url

SP_CONTEXT_QUANTITY

public static final String SP_CONTEXT_QUANTITY

Search parameter: context-quantity

Description: A quantity- or range-valued use context assigned to the example scenario
Type: quantity
Path: ExampleScenario.useContext.valueQuantity, ExampleScenario.useContext.valueRange

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-quantity

Description: A quantity- or range-valued use context assigned to the example scenario
Type: quantity
Path: ExampleScenario.useContext.valueQuantity, ExampleScenario.useContext.valueRange

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: 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 name

Description: Computationally friendly name of the example scenario
Type: string
Path: ExampleScenario.name

SP_CONTEXT

public static final String SP_CONTEXT

Search parameter: context

Description: A use context assigned to the example scenario
Type: token
Path: ExampleScenario.useContext.valueCodeableConcept

See Also:

• Constant Field Values

CONTEXT

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT

Fluent Client search parameter constant for context

Description: A use context assigned to the example scenario
Type: token
Path: ExampleScenario.useContext.valueCodeableConcept

SP_PUBLISHER

public static final String SP_PUBLISHER

Search parameter: publisher

Description: 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 publisher

Description: Name of the publisher of the example scenario
Type: string
Path: ExampleScenario.publisher

SP_CONTEXT_TYPE_QUANTITY

public static final String SP_CONTEXT_TYPE_QUANTITY

Search parameter: context-type-quantity

Description: A use context type and quantity- or range-based value assigned to the example scenario
Type: composite
Path:

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-quantity

Description: A use context type and quantity- or range-based value assigned to the example scenario
Type: composite
Path:

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: 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 status

Description: The current status of the example scenario
Type: token
Path: ExampleScenario.status

Constructor Details

ExampleScenario

public ExampleScenario()

Constructor

ExampleScenario

public ExampleScenario(Enumeration<Enumerations.PublicationStatus> status)

Constructor

Method Details

getUrlElement

public UriType getUrlElement()

Overrides:

getUrlElement in class MetadataResource

Returns:

MetadataResource.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()

Overrides:

hasUrlElement in class MetadataResource

hasUrl

public boolean hasUrl()

Overrides:

hasUrl in class MetadataResource

setUrlElement

public ExampleScenario setUrlElement(UriType value)

Overrides:

setUrlElement in class MetadataResource

Parameters:

value - MetadataResource.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()

Overrides:

getUrl in class MetadataResource

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)

Overrides:

setUrl in class MetadataResource

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()

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)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public ExampleScenario addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getVersionElement

public StringType getVersionElement()

Overrides:

getVersionElement in class MetadataResource

Returns:

MetadataResource.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()

Overrides:

hasVersionElement in class MetadataResource

hasVersion

public boolean hasVersion()

Overrides:

hasVersion in class MetadataResource

setVersionElement

public ExampleScenario setVersionElement(StringType value)

Overrides:

setVersionElement in class MetadataResource

Parameters:

value - MetadataResource.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()

Overrides:

getVersion in class MetadataResource

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)

Overrides:

setVersion in class MetadataResource

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()

Overrides:

getNameElement in class MetadataResource

Returns:

MetadataResource.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()

Overrides:

hasNameElement in class MetadataResource

hasName

public boolean hasName()

Overrides:

hasName in class MetadataResource

setNameElement

public ExampleScenario setNameElement(StringType value)

Overrides:

setNameElement in class MetadataResource

Parameters:

value - MetadataResource.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()

Overrides:

getName in class MetadataResource

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)

Overrides:

setName in class MetadataResource

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()

Overrides:

getStatusElement in class MetadataResource

Returns:

MetadataResource.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()

Overrides:

hasStatusElement in class MetadataResource

hasStatus

public boolean hasStatus()

Overrides:

hasStatus in class MetadataResource

setStatusElement

public ExampleScenario setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

Overrides:

setStatusElement in class MetadataResource

Parameters:

value - MetadataResource.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()

Overrides:

getStatus in class MetadataResource

Returns:

The status of this example scenario. Enables tracking the life-cycle of the content.

setStatus

public ExampleScenario setStatus(Enumerations.PublicationStatus value)

Overrides:

setStatus in class MetadataResource

Parameters:

value - The status of this example scenario. Enables tracking the life-cycle of the content.

getExperimentalElement

public BooleanType getExperimentalElement()

Overrides:

getExperimentalElement in class MetadataResource

Returns:

MetadataResource.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()

Overrides:

hasExperimentalElement in class MetadataResource

hasExperimental

public boolean hasExperimental()

Overrides:

hasExperimental in class MetadataResource

setExperimentalElement

public ExampleScenario setExperimentalElement(BooleanType value)

Overrides:

setExperimentalElement in class MetadataResource

Parameters:

value - MetadataResource.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()

Overrides:

getExperimental in class MetadataResource

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)

Overrides:

setExperimental in class MetadataResource

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()

Overrides:

getDateElement in class MetadataResource

Returns:

MetadataResource.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()

Overrides:

hasDateElement in class MetadataResource

hasDate

public boolean hasDate()

Overrides:

hasDate in class MetadataResource

setDateElement

public ExampleScenario setDateElement(DateTimeType value)

Overrides:

setDateElement in class MetadataResource

Parameters:

value - MetadataResource.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()

Overrides:

getDate in class MetadataResource

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)

Overrides:

setDate in class MetadataResource

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()

Overrides:

getPublisherElement in class MetadataResource

Returns:

MetadataResource.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()

Overrides:

hasPublisherElement in class MetadataResource

hasPublisher

public boolean hasPublisher()

Overrides:

hasPublisher in class MetadataResource

setPublisherElement

public ExampleScenario setPublisherElement(StringType value)

Overrides:

setPublisherElement in class MetadataResource

Parameters:

value - MetadataResource.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()

Overrides:

getPublisher in class MetadataResource

Returns:

The name of the organization or individual that published the example scenario.

setPublisher

public ExampleScenario setPublisher(String value)

Overrides:

setPublisher in class MetadataResource

Parameters:

value - The name of the organization or individual that published the example scenario.

getContact

public List<ContactDetail> getContact()

Overrides:

getContact in class MetadataResource

Returns:

MetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)

setContact

public ExampleScenario setContact(List<ContactDetail> theContact)

Overrides:

setContact in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasContact

public boolean hasContact()

Overrides:

hasContact in class MetadataResource

addContact

public ContactDetail addContact()

Overrides:

addContact in class MetadataResource

addContact

public ExampleScenario addContact(ContactDetail t)

Overrides:

addContact in class MetadataResource

getContactFirstRep

public ContactDetail getContactFirstRep()

Overrides:

getContactFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.contact, creating it if it does not already exist

getUseContext

public List<UsageContext> getUseContext()

Overrides:

getUseContext in class MetadataResource

Returns:

MetadataResource.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)

Overrides:

setUseContext in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasUseContext

public boolean hasUseContext()

Overrides:

hasUseContext in class MetadataResource

addUseContext

public UsageContext addUseContext()

Overrides:

addUseContext in class MetadataResource

addUseContext

public ExampleScenario addUseContext(UsageContext t)

Overrides:

addUseContext in class MetadataResource

getUseContextFirstRep

public UsageContext getUseContextFirstRep()

Overrides:

getUseContextFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.useContext, creating it if it does not already exist

getJurisdiction

public List<CodeableConcept> getJurisdiction()

Overrides:

getJurisdiction in class MetadataResource

Returns:

MetadataResource.jurisdiction (A legal or geographic region in which the example scenario is intended to be used.)

setJurisdiction

public ExampleScenario setJurisdiction(List<CodeableConcept> theJurisdiction)

Overrides:

setJurisdiction in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasJurisdiction

public boolean hasJurisdiction()

Overrides:

hasJurisdiction in class MetadataResource

addJurisdiction

public CodeableConcept addJurisdiction()

Overrides:

addJurisdiction in class MetadataResource

addJurisdiction

public ExampleScenario addJurisdiction(CodeableConcept t)

Overrides:

addJurisdiction in class MetadataResource

getJurisdictionFirstRep

public CodeableConcept getJurisdictionFirstRep()

Overrides:

getJurisdictionFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.jurisdiction, creating it if it does not already exist

getCopyrightElement

public MarkdownType getCopyrightElement()

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()

hasCopyright

public boolean hasCopyright()

setCopyrightElement

public ExampleScenario setCopyrightElement(MarkdownType value)

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()

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)

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()

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()

hasPurpose

public boolean hasPurpose()

setPurposeElement

public ExampleScenario setPurposeElement(MarkdownType value)

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()

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)

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 this for 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

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 this for 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

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 this for 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

getWorkflow

public List<CanonicalType> getWorkflow()

Returns:

workflow (Another nested workflow.)

setWorkflow

public ExampleScenario setWorkflow(List<CanonicalType> theWorkflow)

Returns:

Returns a reference to this for 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:

listChildren in class MetadataResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class MetadataResource

copy

public ExampleScenario copy()

Specified by:

copy in class MetadataResource

copyValues

public void copyValues(ExampleScenario dst)

typedCopy

protected ExampleScenario typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class MetadataResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class MetadataResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class MetadataResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource