Class 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 DataType
    implements org.hl7.fhir.instance.model.api.ICompositeType
    Base StructureDefinition for Attachment Type: For referring to data content defined in other formats.
    See Also:
    Serialized Form
    • 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 Integer64Type 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.
      • frames

        protected PositiveIntType frames
        The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
      • duration

        protected DecimalType duration
        The duration of the recording in seconds - for audio and video.
    • Constructor Detail

    • 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
      • 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
      • 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
      • 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
      • 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 Integer64Type 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
      • hasSize

        public boolean hasSize()
      • setSizeElement

        public Attachment setSizeElement​(Integer64Type 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 long getSize()
        Returns:
        The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
      • setSize

        public Attachment setSize​(long 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
      • 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
      • 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
      • 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.
      • getHeightElement

        public PositiveIntType getHeightElement()
        Returns:
        height (Height of the image in pixels (photo/video).). This is the underlying object with id, value and extensions. The accessor "getHeight" gives direct access to the value
      • setHeightElement

        public Attachment setHeightElement​(PositiveIntType value)
        Parameters:
        value - height (Height of the image in pixels (photo/video).). This is the underlying object with id, value and extensions. The accessor "getHeight" gives direct access to the value
      • getHeight

        public int getHeight()
        Returns:
        Height of the image in pixels (photo/video).
      • setHeight

        public Attachment setHeight​(int value)
        Parameters:
        value - Height of the image in pixels (photo/video).
      • getWidthElement

        public PositiveIntType getWidthElement()
        Returns:
        width (Width of the image in pixels (photo/video).). This is the underlying object with id, value and extensions. The accessor "getWidth" gives direct access to the value
      • setWidthElement

        public Attachment setWidthElement​(PositiveIntType value)
        Parameters:
        value - width (Width of the image in pixels (photo/video).). This is the underlying object with id, value and extensions. The accessor "getWidth" gives direct access to the value
      • getWidth

        public int getWidth()
        Returns:
        Width of the image in pixels (photo/video).
      • setWidth

        public Attachment setWidth​(int value)
        Parameters:
        value - Width of the image in pixels (photo/video).
      • getFramesElement

        public PositiveIntType getFramesElement()
        Returns:
        frames (The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.). This is the underlying object with id, value and extensions. The accessor "getFrames" gives direct access to the value
      • setFramesElement

        public Attachment setFramesElement​(PositiveIntType value)
        Parameters:
        value - frames (The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.). This is the underlying object with id, value and extensions. The accessor "getFrames" gives direct access to the value
      • getFrames

        public int getFrames()
        Returns:
        The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
      • setFrames

        public Attachment setFrames​(int value)
        Parameters:
        value - The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
      • getDurationElement

        public DecimalType getDurationElement()
        Returns:
        duration (The duration of the recording in seconds - for audio and video.). This is the underlying object with id, value and extensions. The accessor "getDuration" gives direct access to the value
      • setDurationElement

        public Attachment setDurationElement​(DecimalType value)
        Parameters:
        value - duration (The duration of the recording in seconds - for audio and video.). This is the underlying object with id, value and extensions. The accessor "getDuration" gives direct access to the value
      • getDuration

        public BigDecimal getDuration()
        Returns:
        The duration of the recording in seconds - for audio and video.
      • setDuration

        public Attachment setDuration​(long value)
        Parameters:
        value - The duration of the recording in seconds - for audio and video.
      • setDuration

        public Attachment setDuration​(double value)
        Parameters:
        value - The duration of the recording in seconds - for audio and video.
      • getPagesElement

        public PositiveIntType getPagesElement()
        Returns:
        pages (The number of pages when printed.). This is the underlying object with id, value and extensions. The accessor "getPages" gives direct access to the value
      • setPagesElement

        public Attachment setPagesElement​(PositiveIntType value)
        Parameters:
        value - pages (The number of pages when printed.). This is the underlying object with id, value and extensions. The accessor "getPages" gives direct access to the value
      • getPages

        public int getPages()
        Returns:
        The number of pages when printed.
      • setPages

        public Attachment setPages​(int value)
        Parameters:
        value - The number of pages when printed.
      • 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
      • 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
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class Element