Data Model Libraries
    Preparing search index...

    Class Binary

    Binary Class

    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.

    There are situations where it is useful or required to handle pure binary content using the same framework as other resources.

    FHIR Specification

    • Short: Pure binary content defined by a format other than FHIR
    • Definition: 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.
    • Comment: Typically, Binary resources are used for handling content such as: * CDA Documents (i.e. with XDS) * PDF Documents * Images (the Media resource is preferred for handling images, but not possible when the content is already binary - e.g. XDS).
    • FHIR Version: 4.3.0

    FHIR Binary

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    contentType securityContext? data?

    Methods

    parse getContentTypeElement setContentTypeElement hasContentTypeElement getContentType setContentType hasContentType getSecurityContext setSecurityContext hasSecurityContext getDataElement setDataElement hasDataElement getData setData hasData fhirType isEmpty isRequiredFieldsEmpty copy toJSON resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    contentType: null | CodeType

    Binary.contentType Element

    FHIR Specification

    • Short: MimeType of the binary content
    • Definition: MimeType of the binary content represented as a standard MimeType (BCP 13).
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    securityContext?: Reference

    Binary.securityContext Element

    FHIR Specification

    • Short: Identifies another resource to use as proxy when enforcing access control
    • Definition: 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. Media, 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.
    • Comment: Very often, a server will also know of a resource that references the binary, and can automatically apply the appropriate access rules based on that reference. However, there are some circumstances where this is not appropriate, e.g. the binary is uploaded directly to the server without any linking resource, the binary is referred to from multiple different resources, and/or the binary is content such as an application logo that has less protection than any of the resources that reference it.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    data?: Base64BinaryType

    Binary.data Element

    FHIR Specification

    • Short: The actual content
    • Definition: The actual content, base64 encoded.
    • Comment: If the content type is itself base64 encoding, then this will be base64 encoded twice - what is created by un-base64ing the content must be the specified content type.
    • FHIR Type: base64Binary
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided Binary JSON to instantiate the Binary data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Binary

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Binary

      Returns undefined | Binary

      Binary data model or undefined for Binary

      JsonError if the provided JSON is not a valid JSON object

    • Returns string

      the FHIR resource type as defined by the FHIR specification

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Returns undefined | string

      the implicitRules property value as a primitive value

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the system property exists and has a value; false otherwise

    • Assigns the provided PrimitiveType value to the language property.

      Parameters

      • element: undefined | CodeType

        the language value

      Returns this

      this

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods