Package org.hl7.fhir.r5.model

Class ExampleScenario.ExampleScenarioInstanceComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.ExampleScenario.ExampleScenarioInstanceComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

ExampleScenario

public static class ExampleScenario.ExampleScenarioInstanceComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent>	containedInstance	References to other instances that can be found within this instance (e.g. the observations contained in a bundle).
protected Reference	content	Points to an instance (typically an example) that shows the data that would corespond to this instance.
protected MarkdownType	description	An explanation of what the instance contains and what it's for.
protected StringType	key	A unique string within the scenario that is used to reference the instance.
protected DataType	structureProfile	Refers to a profile, template or other ruleset the instance adheres to.
protected Coding	structureType	A code indicating the kind of data structure (FHIR resource or some other standard) this is an instance of.
protected StringType	structureVersion	Conveys the version of the data structure instantiated.
protected StringType	title	A short descriptive label the instance to be used in tables or diagrams.
protected List<ExampleScenario.ExampleScenarioInstanceVersionComponent>	version	Represents the instance as it was at a specific time-point.

Fields inherited from class org.hl7.fhir.r5.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
ExampleScenarioInstanceComponent()	Constructor
ExampleScenarioInstanceComponent(String key, Coding structureType, String title)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent	addContainedInstance()
ExampleScenario.ExampleScenarioInstanceComponent	addContainedInstance(ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent t)
ExampleScenario.ExampleScenarioInstanceVersionComponent	addVersion()
ExampleScenario.ExampleScenarioInstanceComponent	addVersion(ExampleScenario.ExampleScenarioInstanceVersionComponent t)
ExampleScenario.ExampleScenarioInstanceComponent	copy()
void	copyValues(ExampleScenario.ExampleScenarioInstanceComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent>	getContainedInstance()
ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent	getContainedInstanceFirstRep()
Reference	getContent()
String	getDescription()
MarkdownType	getDescriptionElement()
String	getKey()
StringType	getKeyElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
DataType	getStructureProfile()
CanonicalType	getStructureProfileCanonicalType()
UriType	getStructureProfileUriType()
Coding	getStructureType()
String	getStructureVersion()
StringType	getStructureVersionElement()
String	getTitle()
StringType	getTitleElement()
String[]	getTypesForProperty(int hash, String name)
List<ExampleScenario.ExampleScenarioInstanceVersionComponent>	getVersion()
ExampleScenario.ExampleScenarioInstanceVersionComponent	getVersionFirstRep()
boolean	hasContainedInstance()
boolean	hasContent()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasKey()
boolean	hasKeyElement()
boolean	hasStructureProfile()
boolean	hasStructureProfileCanonicalType()
boolean	hasStructureProfileUriType()
boolean	hasStructureType()
boolean	hasStructureVersion()
boolean	hasStructureVersionElement()
boolean	hasTitle()
boolean	hasTitleElement()
boolean	hasVersion()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ExampleScenario.ExampleScenarioInstanceComponent	setContainedInstance(List<ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent> theContainedInstance)
ExampleScenario.ExampleScenarioInstanceComponent	setContent(Reference value)
ExampleScenario.ExampleScenarioInstanceComponent	setDescription(String value)
ExampleScenario.ExampleScenarioInstanceComponent	setDescriptionElement(MarkdownType value)
ExampleScenario.ExampleScenarioInstanceComponent	setKey(String value)
ExampleScenario.ExampleScenarioInstanceComponent	setKeyElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ExampleScenario.ExampleScenarioInstanceComponent	setStructureProfile(DataType value)
ExampleScenario.ExampleScenarioInstanceComponent	setStructureType(Coding value)
ExampleScenario.ExampleScenarioInstanceComponent	setStructureVersion(String value)
ExampleScenario.ExampleScenarioInstanceComponent	setStructureVersionElement(StringType value)
ExampleScenario.ExampleScenarioInstanceComponent	setTitle(String value)
ExampleScenario.ExampleScenarioInstanceComponent	setTitleElement(StringType value)
ExampleScenario.ExampleScenarioInstanceComponent	setVersion(List<ExampleScenario.ExampleScenarioInstanceVersionComponent> theVersion)

Methods inherited from class org.hl7.fhir.r5.model.BackboneElement

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionValue, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

key

protected StringType key

A unique string within the scenario that is used to reference the instance.

structureType

protected Coding structureType

A code indicating the kind of data structure (FHIR resource or some other standard) this is an instance of.

structureVersion

protected StringType structureVersion

Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.

structureProfile

protected DataType structureProfile

Refers to a profile, template or other ruleset the instance adheres to.

title

protected StringType title

A short descriptive label the instance to be used in tables or diagrams.

description

protected MarkdownType description

An explanation of what the instance contains and what it's for.

content

protected Reference content

Points to an instance (typically an example) that shows the data that would corespond to this instance.

version

protected List<ExampleScenario.ExampleScenarioInstanceVersionComponent> version

Represents the instance as it was at a specific time-point.

containedInstance

protected List<ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent> containedInstance

References to other instances that can be found within this instance (e.g. the observations contained in a bundle).

Constructor Details

ExampleScenarioInstanceComponent

public ExampleScenarioInstanceComponent()

Constructor

ExampleScenarioInstanceComponent

public ExampleScenarioInstanceComponent(String key,
 Coding structureType,
 String title)

Constructor

Method Details

getKeyElement

public StringType getKeyElement()

Returns:

key (A unique string within the scenario that is used to reference the instance.). This is the underlying object with id, value and extensions. The accessor "getKey" gives direct access to the value

hasKeyElement

public boolean hasKeyElement()

hasKey

public boolean hasKey()

setKeyElement

public ExampleScenario.ExampleScenarioInstanceComponent setKeyElement(StringType value)

Parameters:

value - key (A unique string within the scenario that is used to reference the instance.). This is the underlying object with id, value and extensions. The accessor "getKey" gives direct access to the value

getKey

public String getKey()

Returns:

A unique string within the scenario that is used to reference the instance.

setKey

public ExampleScenario.ExampleScenarioInstanceComponent setKey(String value)

Parameters:

value - A unique string within the scenario that is used to reference the instance.

getStructureType

public Coding getStructureType()

Returns:

structureType (A code indicating the kind of data structure (FHIR resource or some other standard) this is an instance of.)

hasStructureType

public boolean hasStructureType()

setStructureType

public ExampleScenario.ExampleScenarioInstanceComponent setStructureType(Coding value)

Parameters:

value - structureType (A code indicating the kind of data structure (FHIR resource or some other standard) this is an instance of.)

getStructureVersionElement

public StringType getStructureVersionElement()

Returns:

structureVersion (Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.). This is the underlying object with id, value and extensions. The accessor "getStructureVersion" gives direct access to the value

hasStructureVersionElement

public boolean hasStructureVersionElement()

hasStructureVersion

public boolean hasStructureVersion()

setStructureVersionElement

public ExampleScenario.ExampleScenarioInstanceComponent setStructureVersionElement(StringType value)

Parameters:

value - structureVersion (Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.). This is the underlying object with id, value and extensions. The accessor "getStructureVersion" gives direct access to the value

getStructureVersion

public String getStructureVersion()

Returns:

Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.

setStructureVersion

public ExampleScenario.ExampleScenarioInstanceComponent setStructureVersion(String value)

Parameters:

value - Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.

getStructureProfile

public DataType getStructureProfile()

Returns:

structureProfile (Refers to a profile, template or other ruleset the instance adheres to.)

getStructureProfileCanonicalType

public CanonicalType getStructureProfileCanonicalType()
                                               throws org.hl7.fhir.exceptions.FHIRException

Returns:

structureProfile (Refers to a profile, template or other ruleset the instance adheres to.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasStructureProfileCanonicalType

public boolean hasStructureProfileCanonicalType()

getStructureProfileUriType

public UriType getStructureProfileUriType()
                                   throws org.hl7.fhir.exceptions.FHIRException

Returns:

structureProfile (Refers to a profile, template or other ruleset the instance adheres to.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasStructureProfileUriType

public boolean hasStructureProfileUriType()

hasStructureProfile

public boolean hasStructureProfile()

setStructureProfile

public ExampleScenario.ExampleScenarioInstanceComponent setStructureProfile(DataType value)

Parameters:

value - structureProfile (Refers to a profile, template or other ruleset the instance adheres to.)

getTitleElement

public StringType getTitleElement()

Returns:

title (A short descriptive label the instance to be used in tables or diagrams.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

hasTitleElement

public boolean hasTitleElement()

hasTitle

public boolean hasTitle()

setTitleElement

public ExampleScenario.ExampleScenarioInstanceComponent setTitleElement(StringType value)

Parameters:

value - title (A short descriptive label the instance to be used in tables or diagrams.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

getTitle

public String getTitle()

Returns:

A short descriptive label the instance to be used in tables or diagrams.

setTitle

public ExampleScenario.ExampleScenarioInstanceComponent setTitle(String value)

Parameters:

value - A short descriptive label the instance to be used in tables or diagrams.

getDescriptionElement

public MarkdownType getDescriptionElement()

Returns:

description (An explanation of what the instance contains and what it's for.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public ExampleScenario.ExampleScenarioInstanceComponent setDescriptionElement(MarkdownType value)

Parameters:

value - description (An explanation of what the instance contains and what it's for.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

An explanation of what the instance contains and what it's for.

setDescription

public ExampleScenario.ExampleScenarioInstanceComponent setDescription(String value)

Parameters:

value - An explanation of what the instance contains and what it's for.

getContent

public Reference getContent()

Returns:

content (Points to an instance (typically an example) that shows the data that would corespond to this instance.)

hasContent

public boolean hasContent()

setContent

public ExampleScenario.ExampleScenarioInstanceComponent setContent(Reference value)

Parameters:

value - content (Points to an instance (typically an example) that shows the data that would corespond to this instance.)

getVersion

public List<ExampleScenario.ExampleScenarioInstanceVersionComponent> getVersion()

Returns:

version (Represents the instance as it was at a specific time-point.)

setVersion

public ExampleScenario.ExampleScenarioInstanceComponent setVersion(List<ExampleScenario.ExampleScenarioInstanceVersionComponent> theVersion)

Returns:

Returns a reference to this for easy method chaining

hasVersion

public boolean hasVersion()

addVersion

public ExampleScenario.ExampleScenarioInstanceVersionComponent addVersion()

addVersion

public ExampleScenario.ExampleScenarioInstanceComponent addVersion(ExampleScenario.ExampleScenarioInstanceVersionComponent t)

getVersionFirstRep

public ExampleScenario.ExampleScenarioInstanceVersionComponent getVersionFirstRep()

Returns:

The first repetition of repeating field version, creating it if it does not already exist {3}

getContainedInstance

public List<ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent> getContainedInstance()

Returns:

containedInstance (References to other instances that can be found within this instance (e.g. the observations contained in a bundle).)

setContainedInstance

public ExampleScenario.ExampleScenarioInstanceComponent setContainedInstance(List<ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent> theContainedInstance)

Returns:

Returns a reference to this for easy method chaining

hasContainedInstance

public boolean hasContainedInstance()

addContainedInstance

public ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent addContainedInstance()

addContainedInstance

public ExampleScenario.ExampleScenarioInstanceComponent addContainedInstance(ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent t)

getContainedInstanceFirstRep

public ExampleScenario.ExampleScenarioInstanceContainedInstanceComponent getContainedInstanceFirstRep()

Returns:

The first repetition of repeating field containedInstance, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

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

Overrides:

getNamedProperty in class BackboneElement

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 BackboneElement

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 BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public ExampleScenario.ExampleScenarioInstanceComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(ExampleScenario.ExampleScenarioInstanceComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class BackboneElement

Returns:

the FHIR type name of the instance (not the java class name)