Package org.hl7.fhir.dstu3.model

Class RelatedArtifact

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.Element

org.hl7.fhir.dstu3.model.Type

org.hl7.fhir.dstu3.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 Type
implements org.hl7.fhir.instance.model.api.ICompositeType

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

Field Summary

Fields

Modifier and Type	Field	Description
protected StringType	citation	A bibliographic citation for 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 Reference	resource	The related resource, such as a library, value set, profile, or other knowledge resource.
protected Resource	resourceTarget	The actual object that is the target of the reference (The related resource, such as a library, value set, profile, or other knowledge resource.)
protected Enumeration<RelatedArtifact.RelatedArtifactType>	type	The type of relationship to the related artifact.
protected UriType	url	A url for the artifact that can be followed to access the actual content.

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

extension, id

Constructor Summary

Constructors

Constructor	Description
RelatedArtifact()	Constructor
RelatedArtifact(Enumeration<RelatedArtifact.RelatedArtifactType> type)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
RelatedArtifact	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getCitation()
StringType	getCitationElement()
String	getDisplay()
StringType	getDisplayElement()
Attachment	getDocument()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
Reference	getResource()
Resource	getResourceTarget()
RelatedArtifact.RelatedArtifactType	getType()
Enumeration<RelatedArtifact.RelatedArtifactType>	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
String	getUrl()
UriType	getUrlElement()
boolean	hasCitation()
boolean	hasCitationElement()
boolean	hasDisplay()
boolean	hasDisplayElement()
boolean	hasDocument()
boolean	hasResource()
boolean	hasType()
boolean	hasTypeElement()
boolean	hasUrl()
boolean	hasUrlElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
RelatedArtifact	setCitation(String value)
RelatedArtifact	setCitationElement(StringType value)
RelatedArtifact	setDisplay(String value)
RelatedArtifact	setDisplayElement(StringType value)
RelatedArtifact	setDocument(Attachment value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
RelatedArtifact	setResource(Reference value)
RelatedArtifact	setResourceTarget(Resource value)
RelatedArtifact	setType(RelatedArtifact.RelatedArtifactType value)
RelatedArtifact	setTypeElement(Enumeration<RelatedArtifact.RelatedArtifactType> value)
RelatedArtifact	setUrl(String value)
RelatedArtifact	setUrlElement(UriType value)
protected RelatedArtifact	typedCopy()

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

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, 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.

display

protected StringType display

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

citation

protected StringType citation

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

url

protected UriType url

A url for the artifact that can be followed to access the actual content.

document

protected Attachment document

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

resource

protected Reference resource

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

resourceTarget

protected Resource resourceTarget

The actual object that is the target of the reference (The related resource, such as a library, value set, profile, or other knowledge resource.)

Constructor Details

RelatedArtifact

public RelatedArtifact()

Constructor

RelatedArtifact

public RelatedArtifact(Enumeration<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.

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 StringType 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(StringType 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.

getUrlElement

public UriType getUrlElement()

Returns:

url (A url for the artifact that can be followed to access the actual content.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

hasUrlElement

public boolean hasUrlElement()

hasUrl

public boolean hasUrl()

setUrlElement

public RelatedArtifact setUrlElement(UriType value)

Parameters:

value - url (A url for the artifact that can be followed to access the actual content.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

getUrl

public String getUrl()

Returns:

A url for the artifact that can be followed to access the actual content.

setUrl

public RelatedArtifact setUrl(String value)

Parameters:

value - A url for the artifact that can be followed to access the actual content.

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

getResource

public Reference getResource()

Returns:

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

hasResource

public boolean hasResource()

setResource

public RelatedArtifact setResource(Reference value)

Parameters:

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

getResourceTarget

public Resource getResourceTarget()

Returns:

resource The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The related resource, such as a library, value set, profile, or other knowledge resource.)

setResourceTarget

public RelatedArtifact setResourceTarget(Resource value)

Parameters:

value - resource The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The related resource, such as a library, value set, profile, or other knowledge resource.)

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

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 Element

copy

public RelatedArtifact copy()

Overrides:

copy in class Type

typedCopy

protected RelatedArtifact typedCopy()

Specified by:

typedCopy in class Type

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