Data Model Libraries
    Preparing search index...

    Class Attachment

    Attachment Class

    Base StructureDefinition for Attachment Type: For referring to data content defined in other formats.

    Many models need to include data defined in other specifications that is complex and opaque to the healthcare model. This includes documents, media recordings, structured data, etc.

    FHIR Specification

    • Short: Content in a format defined elsewhere
    • Definition: For referring to data content defined in other formats.
    • Comment: When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
    • FHIR Version: 4.0.1

    FHIR Attachment

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    contentType? language? data? url? size? hash? title? creation?

    Methods

    parse getContentTypeElement setContentTypeElement hasContentTypeElement getContentType setContentType hasContentType getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage getDataElement setDataElement hasDataElement getData setData hasData getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getSizeElement setSizeElement hasSizeElement getSize setSize hasSize getHashElement setHashElement hasHashElement getHash setHash hasHash getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getCreationElement setCreationElement hasCreationElement getCreation setCreation hasCreation fhirType isEmpty copy isComplexDataType dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    contentType?: CodeType

    Attachment.contentType Element

    FHIR Specification

    • Short: Mime type of the content, with charset etc.
    • Definition: 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.
    • Requirements: Processors of the data need to be able to know how to interpret the data.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    language?: CodeType

    Attachment.language Element

    FHIR Specification

    • Short: Human language of the content (BCP-47)
    • Definition: The human language of the content. The value can be any valid value according to BCP 47.
    • Requirements: Users need to be able to choose between the languages in a set of attachments.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    data?: Base64BinaryType

    Attachment.data Element

    FHIR Specification

    • Short: Data inline, base64ed
    • Definition: The actual data of the attachment - a sequence of bytes, base64 encoded.
    • Comment: The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
    • Requirements: The data needs to able to be transmitted inline.
    • FHIR Type: base64Binary
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    url?: UrlType

    Attachment.url Element

    FHIR Specification

    • Short: Uri where the data can be found
    • Definition: A location where the data can be accessed.
    • Comment: If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
    • Requirements: The data needs to be transmitted by reference.
    • FHIR Type: url
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    size?: UnsignedIntType

    Attachment.size Element

    FHIR Specification

    • Short: Number of bytes of content (if url provided)
    • Definition: The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
    • Comment: The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
    • Requirements: Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    hash?: Base64BinaryType

    Attachment.hash Element

    FHIR Specification

    • Short: Hash of the data (sha-1, base64ed)
    • Definition: The calculated hash of the data using SHA-1. Represented using base64.
    • Comment: The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.
    • Requirements: Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).
    • FHIR Type: base64Binary
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    Attachment.title Element

    FHIR Specification

    • Short: Label to display in place of the data
    • Definition: A label or set of text to display in place of the data.
    • Requirements: Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    creation?: DateTimeType

    Attachment.creation Element

    FHIR Specification

    • Short: Date attachment was first created
    • Definition: The date that the attachment was first created.
    • Requirements: This is often tracked as an integrity issue for use of the attachment.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Attachment

      • OptionaloptSourceField: string

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

      Returns undefined | Attachment

      Attachment data model or undefined for Attachment

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

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

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; 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
    parsegetContentTypeElementsetContentTypeElementhasContentTypeElementgetContentTypesetContentTypehasContentTypegetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguagegetDataElementsetDataElementhasDataElementgetDatasetDatahasDatagetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetSizeElementsetSizeElementhasSizeElementgetSizesetSizehasSizegetHashElementsetHashElementhasHashElementgetHashsetHashhasHashgetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetCreationElementsetCreationElementhasCreationElementgetCreationsetCreationhasCreationfhirTypeisEmptycopyisComplexDataTypedataTypeNametoJSONisDataTypegetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValues