RelatedArtifact (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.Element
  - - org.hl7.fhir.r4.model.Type
    - - org.hl7.fhir.r4.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 and Description

static class RelatedArtifact.RelatedArtifactType

static class RelatedArtifact.RelatedArtifactTypeEnumFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`RelatedArtifact.RelatedArtifactType`
`static class`	`RelatedArtifact.RelatedArtifactTypeEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected MarkdownType`	`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 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 CanonicalType`	`resource` 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 UrlType`	`url` A url for the artifact that can be followed to access the actual content.

Fields inherited from class org.hl7.fhir.r4.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

RelatedArtifact()
Constructor

RelatedArtifact(Enumeration<RelatedArtifact.RelatedArtifactType> type)
Constructor

Constructors
Constructor and Description
`RelatedArtifact()` Constructor
`RelatedArtifact(Enumeration<RelatedArtifact.RelatedArtifactType> type)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`RelatedArtifact`	`copy()`
`void`	`copyValues(RelatedArtifact dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`String`	`getCitation()`
`MarkdownType`	`getCitationElement()`
`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()`
`RelatedArtifact.RelatedArtifactType`	`getType()`
`Enumeration<RelatedArtifact.RelatedArtifactType>`	`getTypeElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`String`	`getUrl()`
`UrlType`	`getUrlElement()`
`boolean`	`hasCitation()`
`boolean`	`hasCitationElement()`
`boolean`	`hasDisplay()`
`boolean`	`hasDisplayElement()`
`boolean`	`hasDocument()`
`boolean`	`hasLabel()`
`boolean`	`hasLabelElement()`
`boolean`	`hasResource()`
`boolean`	`hasResourceElement()`
`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(MarkdownType value)`
`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`	`setResource(String value)`
`RelatedArtifact`	`setResourceElement(CanonicalType value)`
`RelatedArtifact`	`setType(RelatedArtifact.RelatedArtifactType value)`
`RelatedArtifact`	`setTypeElement(Enumeration<RelatedArtifact.RelatedArtifactType> value)`
`RelatedArtifact`	`setUrl(String value)`
`RelatedArtifact`	`setUrlElement(UrlType value)`
`protected RelatedArtifact`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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 Detail
  - type
```
protected Enumeration<RelatedArtifact.RelatedArtifactType> type
```
    The type of relationship to 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.
  - url
```
protected UrlType 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 CanonicalType resource
```
    The related resource, such as a library, value set, profile, or other knowledge resource.
- Constructor Detail
  - RelatedArtifact
```
public RelatedArtifact()
```
    Constructor
  - RelatedArtifact
```
public RelatedArtifact(Enumeration<RelatedArtifact.RelatedArtifactType> type)
```
    Constructor
- Method Detail
  - 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.
  - 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.
  - getUrlElement
```
public UrlType 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(UrlType 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.)
  - getResourceElement
```
public CanonicalType getResourceElement()
```
    Returns:
    
    resource (The related resource, 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 resource, 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 resource, such as a library, value set, profile, or other knowledge resource.
  - setResource
```
public RelatedArtifact setResource(String value)
```
    Parameters:
    
    value - 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
  - copyValues
```
public void copyValues(RelatedArtifact dst)
```
  - 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

Class RelatedArtifact

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Field Detail

type

label

display

citation

url

document

resource

Constructor Detail

RelatedArtifact

RelatedArtifact

Method Detail

getTypeElement

hasTypeElement

hasType

setTypeElement

getType

setType

getLabelElement

hasLabelElement

hasLabel

setLabelElement

getLabel

setLabel

getDisplayElement

hasDisplayElement

hasDisplay

setDisplayElement

getDisplay

setDisplay

getCitationElement

hasCitationElement

hasCitation

setCitationElement

getCitation

setCitation

getUrlElement

hasUrlElement

hasUrl

setUrlElement

getUrl

setUrl

getDocument

hasDocument

setDocument

getResourceElement

hasResourceElement

hasResource

setResourceElement

getResource

setResource

listChildren

getNamedProperty

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

fhirType

copy

copyValues

typedCopy

equalsDeep

equalsShallow

isEmpty