Package org.hl7.fhir.r5.model

Class ElementDefinition.TypeRefComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.ElementDefinition.TypeRefComponent

All Implemented Interfaces:

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

Enclosing class:

ElementDefinition

public static class ElementDefinition.TypeRefComponent
extends Element
implements org.hl7.fhir.instance.model.api.IBaseDatatypeElement

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<Enumeration<ElementDefinition.AggregationMode>>	aggregation	If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.
protected UriType	code	URL of Data type or Resource that is a(or the) type used for this element.
protected List<CanonicalType>	profile	Identifies a profile structure or implementation Guide that applies to the datatype this element refers to.
protected List<CanonicalType>	targetProfile	Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to.
protected Enumeration<ElementDefinition.ReferenceVersionRules>	versioning	Whether this reference needs to be version specific or version independent, or whether either can be used.

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

extension, id

Constructor Summary

Constructors

Constructor	Description
TypeRefComponent()	Constructor
TypeRefComponent(String code)	Constructor

Method Summary

Modifier and Type	Method	Description
ElementDefinition.TypeRefComponent	addAggregation(ElementDefinition.AggregationMode value)
Enumeration<ElementDefinition.AggregationMode>	addAggregationElement()
Base	addChild(String name)
ElementDefinition.TypeRefComponent	addProfile(String value)
CanonicalType	addProfileElement()
ElementDefinition.TypeRefComponent	addTargetProfile(String value)
CanonicalType	addTargetProfileElement()
ElementDefinition.TypeRefComponent	copy()
void	copyValues(ElementDefinition.TypeRefComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Enumeration<ElementDefinition.AggregationMode>>	getAggregation()
String	getCode()
UriType	getCodeElement()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<CanonicalType>	getProfile()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CanonicalType>	getTargetProfile()
String[]	getTypesForProperty(int hash, String name)
ElementDefinition.ReferenceVersionRules	getVersioning()
Enumeration<ElementDefinition.ReferenceVersionRules>	getVersioningElement()
String	getWorkingCode()	This code checks for the system prefix and returns the FHIR type
boolean	hasAggregation()
boolean	hasAggregation(ElementDefinition.AggregationMode value)
boolean	hasCode()
boolean	hasCodeElement()
boolean	hasProfile()
boolean	hasProfile(String value)
boolean	hasTarget()
boolean	hasTargetProfile()
boolean	hasTargetProfile(String value)
boolean	hasVersioning()
boolean	hasVersioningElement()
boolean	isEmpty()
boolean	isResourceReference()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ElementDefinition.TypeRefComponent	setAggregation(List<Enumeration<ElementDefinition.AggregationMode>> theAggregation)
ElementDefinition.TypeRefComponent	setCode(String value)
ElementDefinition.TypeRefComponent	setCodeElement(UriType value)
ElementDefinition.TypeRefComponent	setProfile(List<CanonicalType> theProfile)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ElementDefinition.TypeRefComponent	setTargetProfile(List<CanonicalType> theTargetProfile)
ElementDefinition.TypeRefComponent	setVersioning(ElementDefinition.ReferenceVersionRules value)
ElementDefinition.TypeRefComponent	setVersioningElement(Enumeration<ElementDefinition.ReferenceVersionRules> value)
String	toString()

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, 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, 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

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.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

Field Details

code

protected UriType code

URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.

profile

protected List<CanonicalType> profile

Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.

targetProfile

protected List<CanonicalType> targetProfile

Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

aggregation

protected List<Enumeration<ElementDefinition.AggregationMode>> aggregation

If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.

versioning

protected Enumeration<ElementDefinition.ReferenceVersionRules> versioning

Whether this reference needs to be version specific or version independent, or whether either can be used.

Constructor Details

TypeRefComponent

public TypeRefComponent()

Constructor

TypeRefComponent

public TypeRefComponent(String code)

Constructor

Method Details

getCodeElement

public UriType getCodeElement()

Returns:

code (URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value

hasCodeElement

public boolean hasCodeElement()

hasCode

public boolean hasCode()

setCodeElement

public ElementDefinition.TypeRefComponent setCodeElement(UriType value)

Parameters:

value - code (URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value

getCode

public String getCode()

Returns:

URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.

setCode

public ElementDefinition.TypeRefComponent setCode(String value)

Parameters:

value - URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.

getProfile

public List<CanonicalType> getProfile()

Returns:

profile (Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.)

setProfile

public ElementDefinition.TypeRefComponent setProfile(List<CanonicalType> theProfile)

Returns:

Returns a reference to this for easy method chaining

hasProfile

public boolean hasProfile()

addProfileElement

public CanonicalType addProfileElement()

Returns:

profile (Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.)

addProfile

public ElementDefinition.TypeRefComponent addProfile(String value)

Parameters:

value - profile (Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.)

hasProfile

public boolean hasProfile(String value)

Parameters:

value - profile (Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide.)

getTargetProfile

public List<CanonicalType> getTargetProfile()

Returns:

targetProfile (Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.)

setTargetProfile

public ElementDefinition.TypeRefComponent setTargetProfile(List<CanonicalType> theTargetProfile)

Returns:

Returns a reference to this for easy method chaining

hasTargetProfile

public boolean hasTargetProfile()

addTargetProfileElement

public CanonicalType addTargetProfileElement()

Returns:

targetProfile (Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.)

addTargetProfile

public ElementDefinition.TypeRefComponent addTargetProfile(String value)

Parameters:

value - targetProfile (Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.)

hasTargetProfile

public boolean hasTargetProfile(String value)

Parameters:

value - targetProfile (Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.)

getAggregation

public List<Enumeration<ElementDefinition.AggregationMode>> getAggregation()

Returns:

aggregation (If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.)

setAggregation

public ElementDefinition.TypeRefComponent setAggregation(List<Enumeration<ElementDefinition.AggregationMode>> theAggregation)

Returns:

Returns a reference to this for easy method chaining

hasAggregation

public boolean hasAggregation()

addAggregationElement

public Enumeration<ElementDefinition.AggregationMode> addAggregationElement()

Returns:

aggregation (If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.)

addAggregation

public ElementDefinition.TypeRefComponent addAggregation(ElementDefinition.AggregationMode value)

Parameters:

value - aggregation (If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.)

hasAggregation

public boolean hasAggregation(ElementDefinition.AggregationMode value)

Parameters:

value - aggregation (If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.)

getVersioningElement

public Enumeration<ElementDefinition.ReferenceVersionRules> getVersioningElement()

Returns:

versioning (Whether this reference needs to be version specific or version independent, or whether either can be used.). This is the underlying object with id, value and extensions. The accessor "getVersioning" gives direct access to the value

hasVersioningElement

public boolean hasVersioningElement()

hasVersioning

public boolean hasVersioning()

setVersioningElement

public ElementDefinition.TypeRefComponent setVersioningElement(Enumeration<ElementDefinition.ReferenceVersionRules> value)

Parameters:

value - versioning (Whether this reference needs to be version specific or version independent, or whether either can be used.). This is the underlying object with id, value and extensions. The accessor "getVersioning" gives direct access to the value

getVersioning

public ElementDefinition.ReferenceVersionRules getVersioning()

Returns:

Whether this reference needs to be version specific or version independent, or whether either can be used.

setVersioning

public ElementDefinition.TypeRefComponent setVersioning(ElementDefinition.ReferenceVersionRules value)

Parameters:

value - Whether this reference needs to be version specific or version independent, or whether either can be used.

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Element

getNamedProperty

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

Overrides:

getNamedProperty in class Element

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 Element

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 Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public ElementDefinition.TypeRefComponent copy()

Specified by:

copy in class Element

copyValues

public void copyValues(ElementDefinition.TypeRefComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Element

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Element

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class Element

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class Element

Returns:

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

hasTarget

public boolean hasTarget()

getWorkingCode

public String getWorkingCode()

This code checks for the system prefix and returns the FHIR type

Returns:

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

isResourceReference

public boolean isResourceReference()