Skip to main content


class HS.FHIR.DTL.vSTU3.Model.Datatype.Attachment extends HS.FHIR.DTL.vSTU3.Model.Base.Element

This type is for containing or referencing attachments - additional data content defined in other formats. The most common use of this type is to include images or reports in some report format such as PDF. However it can be used for any data that has a MIME type.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = Attachment;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = Attachment;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property contentType as %String (MAXLEN = 1000000, XMLNAME = "contentType", XMLPROJECTION = "ATTRIBUTE");

Mime type of the content, with charset etc.

MimeType RFC 4289 is the REQUIRED IETF specification for the FHIR3 code values that may be used.

Property methods: contentTypeDisplayToLogical(), contentTypeGet(), contentTypeIsValid(), contentTypeLogicalToDisplay(), contentTypeLogicalToOdbc(), contentTypeNormalize(), contentTypeSet()
property creation as %String (MAXLEN = 1000000, XMLNAME = "creation", XMLPROJECTION = "ATTRIBUTE");

Date attachment was first created.

Property methods: creationDisplayToLogical(), creationGet(), creationIsValid(), creationLogicalToDisplay(), creationLogicalToOdbc(), creationNormalize(), creationSet()
property data as %Binary (XMLNAME = "data", XMLPROJECTION = "ATTRIBUTE");

Data inline, base64ed.

Property methods: dataGet(), dataIsValid(), dataLogicalToXSD(), dataSet(), dataXSDToLogical()
property hash as %Binary (XMLNAME = "hash", XMLPROJECTION = "ATTRIBUTE");

Hash of the data (sha-1, base64ed)

Property methods: hashGet(), hashIsValid(), hashLogicalToXSD(), hashSet(), hashXSDToLogical()
property language as %String (MAXLEN = 1000000, XMLNAME = "language", XMLPROJECTION = "ATTRIBUTE");

Human language of the content (BCP-47)

languages is the REQUIRED FHIR3 ValueSet for codes, but if you need to express meanings not found in languages, you may formally EXTEND languages to add codes to it.

Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property size as %Integer (XMLNAME = "size", XMLPROJECTION = "ATTRIBUTE");

Number of bytes of content (if url provided)

Property methods: sizeDisplayToLogical(), sizeGet(), sizeIsValid(), sizeLogicalToDisplay(), sizeNormalize(), sizeSet(), sizeXSDToLogical()
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");

Label to display in place of the data.

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");

Uri where the data can be found.

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab