Package org.hl7.fhir.r5.model

Class Citation.CitationCitedArtifactRelatesToComponent

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.Citation.CitationCitedArtifactRelatesToComponent

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:

Citation

public static class Citation.CitationCitedArtifactRelatesToComponent
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 MarkdownType	citation	A bibliographic citation for the related artifact.
protected List<CodeableConcept>	classifier	Provides additional classifiers of the related artifact.
protected StringType	display	A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
protected Attachment	document	The document being referenced, represented as an attachment.
protected StringType	label	A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index.
protected CanonicalType	resource	The related artifact, such as a library, value set, profile, or other knowledge resource.
protected Reference	resourceReference	The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.
protected Enumeration<Citation.RelatedArtifactTypeExpanded>	type	The type of relationship to the related artifact.

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
CitationCitedArtifactRelatesToComponent()	Constructor
CitationCitedArtifactRelatesToComponent(Citation.RelatedArtifactTypeExpanded type)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeableConcept	addClassifier()
Citation.CitationCitedArtifactRelatesToComponent	addClassifier(CodeableConcept t)
Citation.CitationCitedArtifactRelatesToComponent	copy()
void	copyValues(Citation.CitationCitedArtifactRelatesToComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getCitation()
MarkdownType	getCitationElement()
List<CodeableConcept>	getClassifier()
CodeableConcept	getClassifierFirstRep()
String	getDisplay()
StringType	getDisplayElement()
Attachment	getDocument()
String	getLabel()
StringType	getLabelElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getResource()
CanonicalType	getResourceElement()
Reference	getResourceReference()
Citation.RelatedArtifactTypeExpanded	getType()
Enumeration<Citation.RelatedArtifactTypeExpanded>	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCitation()
boolean	hasCitationElement()
boolean	hasClassifier()
boolean	hasDisplay()
boolean	hasDisplayElement()
boolean	hasDocument()
boolean	hasLabel()
boolean	hasLabelElement()
boolean	hasResource()
boolean	hasResourceElement()
boolean	hasResourceReference()
boolean	hasType()
boolean	hasTypeElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Citation.CitationCitedArtifactRelatesToComponent	setCitation(String value)
Citation.CitationCitedArtifactRelatesToComponent	setCitationElement(MarkdownType value)
Citation.CitationCitedArtifactRelatesToComponent	setClassifier(List<CodeableConcept> theClassifier)
Citation.CitationCitedArtifactRelatesToComponent	setDisplay(String value)
Citation.CitationCitedArtifactRelatesToComponent	setDisplayElement(StringType value)
Citation.CitationCitedArtifactRelatesToComponent	setDocument(Attachment value)
Citation.CitationCitedArtifactRelatesToComponent	setLabel(String value)
Citation.CitationCitedArtifactRelatesToComponent	setLabelElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Citation.CitationCitedArtifactRelatesToComponent	setResource(String value)
Citation.CitationCitedArtifactRelatesToComponent	setResourceElement(CanonicalType value)
Citation.CitationCitedArtifactRelatesToComponent	setResourceReference(Reference value)
Citation.CitationCitedArtifactRelatesToComponent	setType(Citation.RelatedArtifactTypeExpanded value)
Citation.CitationCitedArtifactRelatesToComponent	setTypeElement(Enumeration<Citation.RelatedArtifactTypeExpanded> value)

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

type

protected Enumeration<Citation.RelatedArtifactTypeExpanded> type

The type of relationship to the related artifact.

classifier

protected List<CodeableConcept> classifier

Provides additional classifiers of the related artifact.

label

protected StringType label

A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index.

display

protected StringType display

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

citation

protected MarkdownType citation

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

document

protected Attachment document

The document being referenced, represented as an attachment. Do not use this element if using the resource element to provide the canonical to the related artifact.

resource

protected CanonicalType resource

The related artifact, such as a library, value set, profile, or other knowledge resource.

resourceReference

protected Reference resourceReference

The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

Constructor Details

CitationCitedArtifactRelatesToComponent

public CitationCitedArtifactRelatesToComponent()

Constructor

CitationCitedArtifactRelatesToComponent

public CitationCitedArtifactRelatesToComponent(Citation.RelatedArtifactTypeExpanded type)

Constructor

Method Details

getTypeElement

public Enumeration<Citation.RelatedArtifactTypeExpanded> getTypeElement()

Returns:

type (The type of relationship to the related artifact.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

hasTypeElement

public boolean hasTypeElement()

hasType

public boolean hasType()

setTypeElement

public Citation.CitationCitedArtifactRelatesToComponent setTypeElement(Enumeration<Citation.RelatedArtifactTypeExpanded> value)

Parameters:

value - type (The type of relationship to the related artifact.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

getType

public Citation.RelatedArtifactTypeExpanded getType()

Returns:

The type of relationship to the related artifact.

setType

public Citation.CitationCitedArtifactRelatesToComponent setType(Citation.RelatedArtifactTypeExpanded value)

Parameters:

value - The type of relationship to the related artifact.

getClassifier

public List<CodeableConcept> getClassifier()

Returns:

classifier (Provides additional classifiers of the related artifact.)

setClassifier

public Citation.CitationCitedArtifactRelatesToComponent setClassifier(List<CodeableConcept> theClassifier)

Returns:

Returns a reference to this for easy method chaining

hasClassifier

public boolean hasClassifier()

addClassifier

public CodeableConcept addClassifier()

addClassifier

public Citation.CitationCitedArtifactRelatesToComponent addClassifier(CodeableConcept t)

getClassifierFirstRep

public CodeableConcept getClassifierFirstRep()

Returns:

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

getLabelElement

public StringType getLabelElement()

Returns:

label (A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value

hasLabelElement

public boolean hasLabelElement()

hasLabel

public boolean hasLabel()

setLabelElement

public Citation.CitationCitedArtifactRelatesToComponent setLabelElement(StringType value)

Parameters:

value - label (A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index.). This is the underlying object with id, value and extensions. The accessor "getLabel" gives direct access to the value

getLabel

public String getLabel()

Returns:

A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index.

setLabel

public Citation.CitationCitedArtifactRelatesToComponent setLabel(String value)

Parameters:

value - A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote index.

getDisplayElement

public StringType getDisplayElement()

Returns:

display (A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value

hasDisplayElement

public boolean hasDisplayElement()

hasDisplay

public boolean hasDisplay()

setDisplayElement

public Citation.CitationCitedArtifactRelatesToComponent setDisplayElement(StringType value)

Parameters:

value - display (A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value

getDisplay

public String getDisplay()

Returns:

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

setDisplay

public Citation.CitationCitedArtifactRelatesToComponent setDisplay(String value)

Parameters:

value - A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

getCitationElement

public MarkdownType getCitationElement()

Returns:

citation (A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.). This is the underlying object with id, value and extensions. The accessor "getCitation" gives direct access to the value

hasCitationElement

public boolean hasCitationElement()

hasCitation

public boolean hasCitation()

setCitationElement

public Citation.CitationCitedArtifactRelatesToComponent setCitationElement(MarkdownType value)

Parameters:

value - citation (A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.). This is the underlying object with id, value and extensions. The accessor "getCitation" gives direct access to the value

getCitation

public String getCitation()

Returns:

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

setCitation

public Citation.CitationCitedArtifactRelatesToComponent setCitation(String value)

Parameters:

value - A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

getDocument

public Attachment getDocument()

Returns:

document (The document being referenced, represented as an attachment. Do not use this element if using the resource element to provide the canonical to the related artifact.)

hasDocument

public boolean hasDocument()

setDocument

public Citation.CitationCitedArtifactRelatesToComponent setDocument(Attachment value)

Parameters:

value - document (The document being referenced, represented as an attachment. Do not use this element if using the resource element to provide the canonical to the related artifact.)

getResourceElement

public CanonicalType getResourceElement()

Returns:

resource (The related artifact, such as a library, value set, profile, or other knowledge resource.). This is the underlying object with id, value and extensions. The accessor "getResource" gives direct access to the value

hasResourceElement

public boolean hasResourceElement()

hasResource

public boolean hasResource()

setResourceElement

public Citation.CitationCitedArtifactRelatesToComponent setResourceElement(CanonicalType value)

Parameters:

value - resource (The related artifact, such as a library, value set, profile, or other knowledge resource.). This is the underlying object with id, value and extensions. The accessor "getResource" gives direct access to the value

getResource

public String getResource()

Returns:

The related artifact, such as a library, value set, profile, or other knowledge resource.

setResource

public Citation.CitationCitedArtifactRelatesToComponent setResource(String value)

Parameters:

value - The related artifact, such as a library, value set, profile, or other knowledge resource.

getResourceReference

public Reference getResourceReference()

Returns:

resourceReference (The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.)

hasResourceReference

public boolean hasResourceReference()

setResourceReference

public Citation.CitationCitedArtifactRelatesToComponent setResourceReference(Reference value)

Parameters:

value - resourceReference (The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.)

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 Citation.CitationCitedArtifactRelatesToComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Citation.CitationCitedArtifactRelatesToComponent 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)