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

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 Attachment
extends Type
implements org.hl7.fhir.instance.model.api.ICompositeType
```
For referring to data content defined in other formats.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected CodeType`	`contentType` Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data.
`protected DateTimeType`	`creation` The date that the attachment was first created.
`protected Base64BinaryType`	`data` The actual data of the attachment - a sequence of bytes, base64 encoded.
`protected Base64BinaryType`	`hash` The calculated hash of the data using SHA-1.
`protected CodeType`	`language` The human language of the content.
`protected UnsignedIntType`	`size` The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
`protected StringType`	`title` A label or set of text to display in place of the data.
`protected UrlType`	`url` A location where the data can be accessed.

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

Constructor Summary

Constructors
Constructor and Description

Attachment()
Constructor

Constructors
Constructor and Description
`Attachment()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Attachment`	`copy()`
`void`	`copyValues(Attachment dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`String`	`getContentType()`
`CodeType`	`getContentTypeElement()`
`Date`	`getCreation()`
`DateTimeType`	`getCreationElement()`
`byte[]`	`getData()`
`Base64BinaryType`	`getDataElement()`
`byte[]`	`getHash()`
`Base64BinaryType`	`getHashElement()`
`String`	`getLanguage()`
`CodeType`	`getLanguageElement()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`int`	`getSize()`
`UnsignedIntType`	`getSizeElement()`
`String`	`getTitle()`
`StringType`	`getTitleElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`String`	`getUrl()`
`UrlType`	`getUrlElement()`
`boolean`	`hasContentType()`
`boolean`	`hasContentTypeElement()`
`boolean`	`hasCreation()`
`boolean`	`hasCreationElement()`
`boolean`	`hasData()`
`boolean`	`hasDataElement()`
`boolean`	`hasHash()`
`boolean`	`hasHashElement()`
`boolean`	`hasLanguage()`
`boolean`	`hasLanguageElement()`
`boolean`	`hasSize()`
`boolean`	`hasSizeElement()`
`boolean`	`hasTitle()`
`boolean`	`hasTitleElement()`
`boolean`	`hasUrl()`
`boolean`	`hasUrlElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Attachment`	`setContentType(String value)`
`Attachment`	`setContentTypeElement(CodeType value)`
`Attachment`	`setCreation(Date value)`
`Attachment`	`setCreationElement(DateTimeType value)`
`Attachment`	`setData(byte[] value)`
`Attachment`	`setDataElement(Base64BinaryType value)`
`Attachment`	`setHash(byte[] value)`
`Attachment`	`setHashElement(Base64BinaryType value)`
`Attachment`	`setLanguage(String value)`
`Attachment`	`setLanguageElement(CodeType value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Attachment`	`setSize(int value)`
`Attachment`	`setSizeElement(UnsignedIntType value)`
`Attachment`	`setTitle(String value)`
`Attachment`	`setTitleElement(StringType value)`
`Attachment`	`setUrl(String value)`
`Attachment`	`setUrlElement(UrlType value)`
`protected Attachment`	`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
  - contentType
```
protected CodeType contentType
```
    Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
  - language
```
protected CodeType language
```
    The human language of the content. The value can be any valid value according to BCP 47.
  - data
```
protected Base64BinaryType data
```
    The actual data of the attachment - a sequence of bytes, base64 encoded.
  - url
```
protected UrlType url
```
    A location where the data can be accessed.
  - size
```
protected UnsignedIntType size
```
    The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
  - hash
```
protected Base64BinaryType hash
```
    The calculated hash of the data using SHA-1. Represented using base64.
  - title
```
protected StringType title
```
    A label or set of text to display in place of the data.
  - creation
```
protected DateTimeType creation
```
    The date that the attachment was first created.
- Constructor Detail
  - Attachment
```
public Attachment()
```
    Constructor
- Method Detail
  - getContentTypeElement
```
public CodeType getContentTypeElement()
```
    Returns:
    
    contentType (Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.). This is the underlying object with id, value and extensions. The accessor "getContentType" gives direct access to the value
  - hasContentTypeElement
```
public boolean hasContentTypeElement()
```
  - hasContentType
```
public boolean hasContentType()
```
  - setContentTypeElement
```
public Attachment setContentTypeElement(CodeType value)
```
    Parameters:
    
    value - contentType (Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.). This is the underlying object with id, value and extensions. The accessor "getContentType" gives direct access to the value
  - getContentType
```
public String getContentType()
```
    Returns:
    
    Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
  - setContentType
```
public Attachment setContentType(String value)
```
    Parameters:
    
    value - Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
  - getLanguageElement
```
public CodeType getLanguageElement()
```
    Returns:
    
    language (The human language of the content. The value can be any valid value according to BCP 47.). This is the underlying object with id, value and extensions. The accessor "getLanguage" gives direct access to the value
  - hasLanguageElement
```
public boolean hasLanguageElement()
```
  - hasLanguage
```
public boolean hasLanguage()
```
  - setLanguageElement
```
public Attachment setLanguageElement(CodeType value)
```
    Parameters:
    
    value - language (The human language of the content. The value can be any valid value according to BCP 47.). This is the underlying object with id, value and extensions. The accessor "getLanguage" gives direct access to the value
  - getLanguage
```
public String getLanguage()
```
    Returns:
    
    The human language of the content. The value can be any valid value according to BCP 47.
  - setLanguage
```
public Attachment setLanguage(String value)
```
    Parameters:
    
    value - The human language of the content. The value can be any valid value according to BCP 47.
  - getDataElement
```
public Base64BinaryType getDataElement()
```
    Returns:
    
    data (The actual data of the attachment - a sequence of bytes, base64 encoded.). This is the underlying object with id, value and extensions. The accessor "getData" gives direct access to the value
  - hasDataElement
```
public boolean hasDataElement()
```
  - hasData
```
public boolean hasData()
```
  - setDataElement
```
public Attachment setDataElement(Base64BinaryType value)
```
    Parameters:
    
    value - data (The actual data of the attachment - a sequence of bytes, base64 encoded.). This is the underlying object with id, value and extensions. The accessor "getData" gives direct access to the value
  - getData
```
public byte[] getData()
```
    Returns:
    
    The actual data of the attachment - a sequence of bytes, base64 encoded.
  - setData
```
public Attachment setData(byte[] value)
```
    Parameters:
    
    value - The actual data of the attachment - a sequence of bytes, base64 encoded.
  - getUrlElement
```
public UrlType getUrlElement()
```
    Returns:
    
    url (A location where the data can be accessed.). 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 Attachment setUrlElement(UrlType value)
```
    Parameters:
    
    value - url (A location where the data can be accessed.). 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 location where the data can be accessed.
  - setUrl
```
public Attachment setUrl(String value)
```
    Parameters:
    
    value - A location where the data can be accessed.
  - getSizeElement
```
public UnsignedIntType getSizeElement()
```
    Returns:
    
    size (The number of bytes of data that make up this attachment (before base64 encoding, if that is done).). This is the underlying object with id, value and extensions. The accessor "getSize" gives direct access to the value
  - hasSizeElement
```
public boolean hasSizeElement()
```
  - hasSize
```
public boolean hasSize()
```
  - setSizeElement
```
public Attachment setSizeElement(UnsignedIntType value)
```
    Parameters:
    
    value - size (The number of bytes of data that make up this attachment (before base64 encoding, if that is done).). This is the underlying object with id, value and extensions. The accessor "getSize" gives direct access to the value
  - getSize
```
public int getSize()
```
    Returns:
    
    The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
  - setSize
```
public Attachment setSize(int value)
```
    Parameters:
    
    value - The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
  - getHashElement
```
public Base64BinaryType getHashElement()
```
    Returns:
    
    hash (The calculated hash of the data using SHA-1. Represented using base64.). This is the underlying object with id, value and extensions. The accessor "getHash" gives direct access to the value
  - hasHashElement
```
public boolean hasHashElement()
```
  - hasHash
```
public boolean hasHash()
```
  - setHashElement
```
public Attachment setHashElement(Base64BinaryType value)
```
    Parameters:
    
    value - hash (The calculated hash of the data using SHA-1. Represented using base64.). This is the underlying object with id, value and extensions. The accessor "getHash" gives direct access to the value
  - getHash
```
public byte[] getHash()
```
    Returns:
    
    The calculated hash of the data using SHA-1. Represented using base64.
  - setHash
```
public Attachment setHash(byte[] value)
```
    Parameters:
    
    value - The calculated hash of the data using SHA-1. Represented using base64.
  - getTitleElement
```
public StringType getTitleElement()
```
    Returns:
    
    title (A label or set of text to display in place of the data.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
  - hasTitleElement
```
public boolean hasTitleElement()
```
  - hasTitle
```
public boolean hasTitle()
```
  - setTitleElement
```
public Attachment setTitleElement(StringType value)
```
    Parameters:
    
    value - title (A label or set of text to display in place of the data.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
  - getTitle
```
public String getTitle()
```
    Returns:
    
    A label or set of text to display in place of the data.
  - setTitle
```
public Attachment setTitle(String value)
```
    Parameters:
    
    value - A label or set of text to display in place of the data.
  - getCreationElement
```
public DateTimeType getCreationElement()
```
    Returns:
    
    creation (The date that the attachment was first created.). This is the underlying object with id, value and extensions. The accessor "getCreation" gives direct access to the value
  - hasCreationElement
```
public boolean hasCreationElement()
```
  - hasCreation
```
public boolean hasCreation()
```
  - setCreationElement
```
public Attachment setCreationElement(DateTimeType value)
```
    Parameters:
    
    value - creation (The date that the attachment was first created.). This is the underlying object with id, value and extensions. The accessor "getCreation" gives direct access to the value
  - getCreation
```
public Date getCreation()
```
    Returns:
    
    The date that the attachment was first created.
  - setCreation
```
public Attachment setCreation(Date value)
```
    Parameters:
    
    value - The date that the attachment was first created.
  - 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 Attachment copy()
```
    Overrides:
    
    copy in class Type
  - copyValues
```
public void copyValues(Attachment dst)
```
  - typedCopy
```
protected Attachment 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 Attachment

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

contentType

language

data

url

size

hash

title

creation

Constructor Detail

Attachment

Method Detail

getContentTypeElement

hasContentTypeElement

hasContentType

setContentTypeElement

getContentType

setContentType

getLanguageElement

hasLanguageElement

hasLanguage

setLanguageElement

getLanguage

setLanguage

getDataElement

hasDataElement

hasData

setDataElement

getData

setData

getUrlElement

hasUrlElement

hasUrl

setUrlElement

getUrl

setUrl

getSizeElement

hasSizeElement

hasSize

setSizeElement

getSize

setSize

getHashElement

hasHashElement

hasHash

setHashElement

getHash

setHash

getTitleElement

hasTitleElement

hasTitle

setTitleElement

getTitle

setTitle

getCreationElement

hasCreationElement

hasCreation

setCreationElement

getCreation

setCreation

listChildren

getNamedProperty

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

fhirType

copy