ca.uhn.fhir.model.dstu.resource

Class Profile.StructureElement

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.resource.Profile.StructureElement

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions, Serializable, IBase

Enclosing class:

Profile

public static class Profile.StructureElement
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: Profile.structure.element (Definition of elements in the resource (if no profile))

Definition: Captures constraints on each element within the resource

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StructureElement()

Method Summary

Modifier and Type	Method and Description
BoundCodeDt<PropertyRepresentationEnum>	addRepresentation() Add a value for representation (How this element is represented in instances)
BoundCodeDt<PropertyRepresentationEnum>	addRepresentation(PropertyRepresentationEnum theValue) Add a value for representation (How this element is represented in instances) using an enumerated type.
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
Profile.StructureElementDefinition	getDefinition() Gets the value(s) for definition (More specific definition of the element).
Profile.StructureElementDefinition	getDefinitionElement() Gets the value(s) for definition (More specific definition of the element).
StringDt	getName() Gets the value(s) for name (Name for this particular element definition (reference target)).
StringDt	getNameElement() Gets the value(s) for name (Name for this particular element definition (reference target)).
StringDt	getPath() Gets the value(s) for path (The path of the element (see the formal definitions)).
StringDt	getPathElement() Gets the value(s) for path (The path of the element (see the formal definitions)).
List<BoundCodeDt<PropertyRepresentationEnum>>	getRepresentation() Gets the value(s) for representation (How this element is represented in instances).
List<BoundCodeDt<PropertyRepresentationEnum>>	getRepresentationElement() Gets the value(s) for representation (How this element is represented in instances).
BoundCodeDt<PropertyRepresentationEnum>	getRepresentationFirstRep() Gets the first repetition for representation (How this element is represented in instances), creating it if it does not already exist.
Profile.StructureElementSlicing	getSlicing() Gets the value(s) for slicing (This element is sliced - slices follow).
Profile.StructureElementSlicing	getSlicingElement() Gets the value(s) for slicing (This element is sliced - slices follow).
boolean	isEmpty()
Profile.StructureElement	setDefinition(Profile.StructureElementDefinition theValue) Sets the value(s) for definition (More specific definition of the element)
Profile.StructureElement	setName(String theString) Sets the value for name (Name for this particular element definition (reference target))
Profile.StructureElement	setName(StringDt theValue) Sets the value(s) for name (Name for this particular element definition (reference target))
Profile.StructureElement	setPath(String theString) Sets the value for path (The path of the element (see the formal definitions))
Profile.StructureElement	setPath(StringDt theValue) Sets the value(s) for path (The path of the element (see the formal definitions))
Profile.StructureElement	setRepresentation(List<BoundCodeDt<PropertyRepresentationEnum>> theValue) Sets the value(s) for representation (How this element is represented in instances)
Profile.StructureElement	setRepresentation(PropertyRepresentationEnum theValue) Sets the value(s), and clears any existing value(s) for representation (How this element is represented in instances)
Profile.StructureElement	setSlicing(Profile.StructureElementSlicing theValue) Sets the value(s) for slicing (This element is sliced - slices follow)

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment, isBaseEmpty

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Constructor Detail

StructureElement

public StructureElement()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

getPath

public StringDt getPath()

Gets the value(s) for path (The path of the element (see the formal definitions)). creating it if it does not exist. Will not return null.

Definition: The path identifies the element and is expressed as a \".\"-separated list of ancestor elements, beginning with the name of the resource

getPathElement

public StringDt getPathElement()

Gets the value(s) for path (The path of the element (see the formal definitions)). creating it if it does not exist. Will not return null.

Definition: The path identifies the element and is expressed as a \".\"-separated list of ancestor elements, beginning with the name of the resource

setPath

public Profile.StructureElement setPath(StringDt theValue)

Sets the value(s) for path (The path of the element (see the formal definitions))

Definition: The path identifies the element and is expressed as a \".\"-separated list of ancestor elements, beginning with the name of the resource

setPath

public Profile.StructureElement setPath(String theString)

Sets the value for path (The path of the element (see the formal definitions))

Definition: The path identifies the element and is expressed as a \".\"-separated list of ancestor elements, beginning with the name of the resource

getRepresentation

public List<BoundCodeDt<PropertyRepresentationEnum>> getRepresentation()

Gets the value(s) for representation (How this element is represented in instances). creating it if it does not exist. Will not return null.

Definition: Codes that define how this element is represented in instances, when the deviation varies from the normal case

getRepresentationElement

public List<BoundCodeDt<PropertyRepresentationEnum>> getRepresentationElement()

Gets the value(s) for representation (How this element is represented in instances). creating it if it does not exist. Will not return null.

Definition: Codes that define how this element is represented in instances, when the deviation varies from the normal case

setRepresentation

public Profile.StructureElement setRepresentation(List<BoundCodeDt<PropertyRepresentationEnum>> theValue)

Sets the value(s) for representation (How this element is represented in instances)

Definition: Codes that define how this element is represented in instances, when the deviation varies from the normal case

addRepresentation

public BoundCodeDt<PropertyRepresentationEnum> addRepresentation(PropertyRepresentationEnum theValue)

Add a value for representation (How this element is represented in instances) using an enumerated type. This is intended as a convenience method for situations where the FHIR defined ValueSets are mandatory or contain the desirable codes. If you wish to use codes other than those which are built-in, you may also use the addRepresentation() method.

Definition: Codes that define how this element is represented in instances, when the deviation varies from the normal case

getRepresentationFirstRep

public BoundCodeDt<PropertyRepresentationEnum> getRepresentationFirstRep()

Gets the first repetition for representation (How this element is represented in instances), creating it if it does not already exist.

Definition: Codes that define how this element is represented in instances, when the deviation varies from the normal case

addRepresentation

public BoundCodeDt<PropertyRepresentationEnum> addRepresentation()

Add a value for representation (How this element is represented in instances)

Definition: Codes that define how this element is represented in instances, when the deviation varies from the normal case

setRepresentation

public Profile.StructureElement setRepresentation(PropertyRepresentationEnum theValue)

Sets the value(s), and clears any existing value(s) for representation (How this element is represented in instances)

Definition: Codes that define how this element is represented in instances, when the deviation varies from the normal case

getName

public StringDt getName()

Gets the value(s) for name (Name for this particular element definition (reference target)). creating it if it does not exist. Will not return null.

Definition: The name of this element definition (to refer to it from other element definitions using Profile.structure.element.definition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element

getNameElement

public StringDt getNameElement()

Gets the value(s) for name (Name for this particular element definition (reference target)). creating it if it does not exist. Will not return null.

Definition: The name of this element definition (to refer to it from other element definitions using Profile.structure.element.definition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element

setName

public Profile.StructureElement setName(StringDt theValue)

Sets the value(s) for name (Name for this particular element definition (reference target))

Definition: The name of this element definition (to refer to it from other element definitions using Profile.structure.element.definition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element

setName

public Profile.StructureElement setName(String theString)

Sets the value for name (Name for this particular element definition (reference target))

Definition: The name of this element definition (to refer to it from other element definitions using Profile.structure.element.definition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element

getSlicing

public Profile.StructureElementSlicing getSlicing()

Gets the value(s) for slicing (This element is sliced - slices follow). creating it if it does not exist. Will not return null.

Definition: Indicates that the element is sliced into a set of alternative definitions (there are multiple definitions on a single element in the base resource). The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set)

getSlicingElement

public Profile.StructureElementSlicing getSlicingElement()

Gets the value(s) for slicing (This element is sliced - slices follow). creating it if it does not exist. Will not return null.

Definition: Indicates that the element is sliced into a set of alternative definitions (there are multiple definitions on a single element in the base resource). The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set)

setSlicing

public Profile.StructureElement setSlicing(Profile.StructureElementSlicing theValue)

Sets the value(s) for slicing (This element is sliced - slices follow)

Definition: Indicates that the element is sliced into a set of alternative definitions (there are multiple definitions on a single element in the base resource). The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set)

getDefinition

public Profile.StructureElementDefinition getDefinition()

Gets the value(s) for definition (More specific definition of the element). creating it if it does not exist. Will not return null.

Definition: Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource

getDefinitionElement

public Profile.StructureElementDefinition getDefinitionElement()

Gets the value(s) for definition (More specific definition of the element). creating it if it does not exist. Will not return null.

Definition: Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource

setDefinition

public Profile.StructureElement setDefinition(Profile.StructureElementDefinition theValue)

Sets the value(s) for definition (More specific definition of the element)

Definition: Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource