Package org.hl7.fhir.r5.model

Class RelatedArtifact

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.model.RelatedArtifact

All Implemented Interfaces:

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

public class RelatedArtifact
extends DataType
implements org.hl7.fhir.instance.model.api.ICompositeType

RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RelatedArtifact.RelatedArtifactType
static class	RelatedArtifact.RelatedArtifactTypeEnumFactory

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 citation from elsewhere in the containing artifact, such as a footnote index.
protected DateType	publicationDate	The date of publication of the artifact being referred to.
protected Enumeration<Enumerations.PublicationStatus>	publicationStatus	The publication status of the artifact being referred to.
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<RelatedArtifact.RelatedArtifactType>	type	The type of relationship to the related artifact.

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

extension, id

Constructor Summary

Constructors

Constructor	Description
RelatedArtifact()	Constructor
RelatedArtifact(RelatedArtifact.RelatedArtifactType type)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeableConcept	addClassifier()
RelatedArtifact	addClassifier(CodeableConcept t)
RelatedArtifact	copy()
void	copyValues(RelatedArtifact 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)
Date	getPublicationDate()
DateType	getPublicationDateElement()
Enumerations.PublicationStatus	getPublicationStatus()
Enumeration<Enumerations.PublicationStatus>	getPublicationStatusElement()
String	getResource()
CanonicalType	getResourceElement()
Reference	getResourceReference()
RelatedArtifact.RelatedArtifactType	getType()
Enumeration<RelatedArtifact.RelatedArtifactType>	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCitation()
boolean	hasCitationElement()
boolean	hasClassifier()
boolean	hasDisplay()
boolean	hasDisplayElement()
boolean	hasDocument()
boolean	hasLabel()
boolean	hasLabelElement()
boolean	hasPublicationDate()
boolean	hasPublicationDateElement()
boolean	hasPublicationStatus()
boolean	hasPublicationStatusElement()
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)
RelatedArtifact	setCitation(String value)
RelatedArtifact	setCitationElement(MarkdownType value)
RelatedArtifact	setClassifier(List<CodeableConcept> theClassifier)
RelatedArtifact	setDisplay(String value)
RelatedArtifact	setDisplayElement(StringType value)
RelatedArtifact	setDocument(Attachment value)
RelatedArtifact	setLabel(String value)
RelatedArtifact	setLabelElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
RelatedArtifact	setPublicationDate(Date value)
RelatedArtifact	setPublicationDateElement(DateType value)
RelatedArtifact	setPublicationStatus(Enumerations.PublicationStatus value)
RelatedArtifact	setPublicationStatusElement(Enumeration<Enumerations.PublicationStatus> value)
RelatedArtifact	setResource(String value)
RelatedArtifact	setResourceElement(CanonicalType value)
RelatedArtifact	setResourceReference(Reference value)
RelatedArtifact	setType(RelatedArtifact.RelatedArtifactType value)
RelatedArtifact	setTypeElement(Enumeration<RelatedArtifact.RelatedArtifactType> value)
protected RelatedArtifact	typedCopy()

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

copyValues, getTranslation, isTranslatable

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

Field Details

type

protected Enumeration<RelatedArtifact.RelatedArtifactType> 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 citation 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. This is exclusive with the resource element.

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.

publicationStatus

protected Enumeration<Enumerations.PublicationStatus> publicationStatus

The publication status of the artifact being referred to.

publicationDate

protected DateType publicationDate

The date of publication of the artifact being referred to.

Constructor Details

RelatedArtifact

public RelatedArtifact()

Constructor

RelatedArtifact

public RelatedArtifact(RelatedArtifact.RelatedArtifactType type)

Constructor

Method Details

getTypeElement

public Enumeration<RelatedArtifact.RelatedArtifactType> 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 RelatedArtifact setTypeElement(Enumeration<RelatedArtifact.RelatedArtifactType> 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 RelatedArtifact.RelatedArtifactType getType()

Returns:

The type of relationship to the related artifact.

setType

public RelatedArtifact setType(RelatedArtifact.RelatedArtifactType 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 RelatedArtifact setClassifier(List<CodeableConcept> theClassifier)

Returns:

Returns a reference to this for easy method chaining

hasClassifier

public boolean hasClassifier()

addClassifier

public CodeableConcept addClassifier()

addClassifier

public RelatedArtifact 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 citation 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 RelatedArtifact setLabelElement(StringType value)

Parameters:

value - label (A short label that can be used to reference the citation 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 citation from elsewhere in the containing artifact, such as a footnote index.

setLabel

public RelatedArtifact setLabel(String value)

Parameters:

value - A short label that can be used to reference the citation 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 RelatedArtifact 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 RelatedArtifact 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 RelatedArtifact 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 RelatedArtifact 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. This is exclusive with the resource element.)

hasDocument

public boolean hasDocument()

setDocument

public RelatedArtifact setDocument(Attachment value)

Parameters:

value - document (The document being referenced, represented as an attachment. This is exclusive with the resource element.)

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

getPublicationStatusElement

public Enumeration<Enumerations.PublicationStatus> getPublicationStatusElement()

Returns:

publicationStatus (The publication status of the artifact being referred to.). This is the underlying object with id, value and extensions. The accessor "getPublicationStatus" gives direct access to the value

hasPublicationStatusElement

public boolean hasPublicationStatusElement()

hasPublicationStatus

public boolean hasPublicationStatus()

setPublicationStatusElement

public RelatedArtifact setPublicationStatusElement(Enumeration<Enumerations.PublicationStatus> value)

Parameters:

value - publicationStatus (The publication status of the artifact being referred to.). This is the underlying object with id, value and extensions. The accessor "getPublicationStatus" gives direct access to the value

getPublicationStatus

public Enumerations.PublicationStatus getPublicationStatus()

Returns:

The publication status of the artifact being referred to.

setPublicationStatus

public RelatedArtifact setPublicationStatus(Enumerations.PublicationStatus value)

Parameters:

value - The publication status of the artifact being referred to.

getPublicationDateElement

public DateType getPublicationDateElement()

Returns:

publicationDate (The date of publication of the artifact being referred to.). This is the underlying object with id, value and extensions. The accessor "getPublicationDate" gives direct access to the value

hasPublicationDateElement

public boolean hasPublicationDateElement()

hasPublicationDate

public boolean hasPublicationDate()

setPublicationDateElement

public RelatedArtifact setPublicationDateElement(DateType value)

Parameters:

value - publicationDate (The date of publication of the artifact being referred to.). This is the underlying object with id, value and extensions. The accessor "getPublicationDate" gives direct access to the value

getPublicationDate

public Date getPublicationDate()

Returns:

The date of publication of the artifact being referred to.

setPublicationDate

public RelatedArtifact setPublicationDate(Date value)

Parameters:

value - The date of publication of the artifact being referred to.

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

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class DataType

Returns:

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

copy

public RelatedArtifact copy()

Specified by:

copy in class DataType

copyValues

public void copyValues(RelatedArtifact dst)

typedCopy

protected RelatedArtifact typedCopy()

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