Package org.hl7.fhir.r5.model

Class Binary

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.BaseBinary
org.hl7.fhir.r5.model.Binary
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBinary, org.hl7.fhir.instance.model.api.IBaseResource
public class Binary extends BaseBinary implements org.hl7.fhir.instance.model.api.IBaseBinary
A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.
See Also:

  • Field Details

    • contentType

      protected CodeType contentType
      MimeType of the binary content represented as a standard MimeType (BCP 13).

    • securityContext

      protected Reference securityContext
      This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.

    • data

      protected Base64BinaryType data
      The actual content, base64 encoded.

  • Constructor Details

    • Binary

      public Binary()
      Constructor

    • Binary

      public Binary(String contentType)
      Constructor

  • Method Details

    • getContentTypeElement

      public CodeType getContentTypeElement()
      Returns:
      contentType (MimeType of the binary content represented as a standard MimeType (BCP 13).). 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 Binary setContentTypeElement(CodeType value)
      Parameters:
      value - contentType (MimeType of the binary content represented as a standard MimeType (BCP 13).). This is the underlying object with id, value and extensions. The accessor "getContentType" gives direct access to the value

    • getContentType

      public String getContentType()
      Specified by:
      getContentType in interface org.hl7.fhir.instance.model.api.IBaseBinary
      Returns:
      MimeType of the binary content represented as a standard MimeType (BCP 13).

    • setContentType

      public Binary setContentType(String value)
      Specified by:
      setContentType in interface org.hl7.fhir.instance.model.api.IBaseBinary
      Parameters:
      value - MimeType of the binary content represented as a standard MimeType (BCP 13).

    • getSecurityContext

      public Reference getSecurityContext()
      Returns:
      securityContext (This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.)

    • hasSecurityContext

      public boolean hasSecurityContext()

    • setSecurityContext

      public Binary setSecurityContext(Reference value)
      Parameters:
      value - securityContext (This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.)

    • getDataElement

      public Base64BinaryType getDataElement()
      Returns:
      data (The actual content, 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()
      Specified by:
      hasData in interface org.hl7.fhir.instance.model.api.IBaseBinary

    • setDataElement

      public Binary setDataElement(Base64BinaryType value)
      Parameters:
      value - data (The actual content, 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 content, base64 encoded.

    • setData

      public Binary setData(byte[] value)
      Parameters:
      value - The actual content, base64 encoded.

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class Resource

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Resource
      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 Resource
      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 Resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • removeChild

      public void removeChild(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      removeChild in class Resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class Resource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class Resource
      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 Resource
      Returns:
      the FHIR type name of the instance (not the java class name)

    • copy

      public Binary copy()
      Specified by:
      copy in class Resource

    • copyValues

      public void copyValues(Binary dst)

    • typedCopy

      protected Binary typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class Resource

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class Resource

    • isEmpty

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

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource

    • getContent

      public byte[] getContent()
      Specified by:
      getContent in interface org.hl7.fhir.instance.model.api.IBaseBinary

    • setContent

      public org.hl7.fhir.instance.model.api.IBaseBinary setContent(byte[] arg0)
      Specified by:
      setContent in interface org.hl7.fhir.instance.model.api.IBaseBinary

    • getContentElement

      public Base64BinaryType getContentElement()
      Specified by:
      getContentElement in interface org.hl7.fhir.instance.model.api.IBaseBinary
      Specified by:
      getContentElement in class BaseBinary