Private OptionalcontentAttachment.contentType Element
FHIR Specification
codePrivate OptionallanguageAttachment.language Element
FHIR Specification
codePrivate OptionaldataAttachment.data Element
FHIR Specification
base64BinaryPrivate OptionalurlAttachment.url Element
FHIR Specification
urlPrivate OptionalsizeAttachment.size Element
FHIR Specification
integer64Private OptionalhashAttachment.hash Element
FHIR Specification
base64BinaryPrivate OptionaltitleAttachment.title Element
FHIR Specification
stringPrivate OptionalcreationAttachment.creation Element
Private OptionalheightAttachment.height Element
Private OptionalwidthAttachment.width Element
Private OptionalframesAttachment.frames Element
FHIR Specification
positiveIntPrivate OptionaldurationAttachment.duration Element
Private OptionalpagesAttachment.pages Element
StaticparseParse the provided Attachment JSON to instantiate the Attachment data model.
JSON representing FHIR Attachment
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Attachment
Attachment data model or undefined for Attachment
JsonError if the provided JSON is not a valid JSON object
the contentType property value as a CodeType object if defined; else an empty CodeType object
Assigns the provided PrimitiveType value to the contentType property.
the contentType value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the contentType property exists and has a value; false otherwise
the contentType property value as a fhirCode if defined; else undefined
Assigns the provided primitive value to the contentType property.
the contentType value
this
PrimitiveTypeError for invalid primitive types
true if the contentType property exists and has a value; false otherwise
the language property value as a CodeType object if defined; else an empty CodeType object
Assigns the provided PrimitiveType value to the language property.
the language value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
the language property value as a fhirCode if defined; else undefined
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
the data property value as a Base64BinaryType object if defined; else an empty Base64BinaryType object
Assigns the provided PrimitiveType value to the data property.
the data value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the data property exists and has a value; false otherwise
the data property value as a fhirBase64Binary if defined; else undefined
Assigns the provided primitive value to the data property.
the data value
this
PrimitiveTypeError for invalid primitive types
true if the data property exists and has a value; false otherwise
the url property value as a UrlType object if defined; else an empty UrlType object
Assigns the provided PrimitiveType value to the url property.
the url value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the url property value as a fhirUrl if defined; else undefined
Assigns the provided primitive value to the url property.
the url value
this
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the size property value as a Integer64Type object if defined; else an empty Integer64Type object
Assigns the provided PrimitiveType value to the size property.
the size value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the size property exists and has a value; false otherwise
the size property value as a fhirInteger64 if defined; else undefined
Assigns the provided primitive value to the size property.
the size value
this
PrimitiveTypeError for invalid primitive types
true if the size property exists and has a value; false otherwise
the hash property value as a Base64BinaryType object if defined; else an empty Base64BinaryType object
Assigns the provided PrimitiveType value to the hash property.
the hash value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the hash property exists and has a value; false otherwise
the hash property value as a fhirBase64Binary if defined; else undefined
Assigns the provided primitive value to the hash property.
the hash value
this
PrimitiveTypeError for invalid primitive types
true if the hash property exists and has a value; false otherwise
the title property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the title property.
the title value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the title property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the title property.
the title value
this
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the creation property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the creation property.
the creation value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the creation property exists and has a value; false otherwise
the creation property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the creation property.
the creation value
this
PrimitiveTypeError for invalid primitive types
true if the creation property exists and has a value; false otherwise
the height property value as a PositiveIntType object if defined; else an empty PositiveIntType object
Assigns the provided PrimitiveType value to the height property.
the height value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the height property exists and has a value; false otherwise
the height property value as a fhirPositiveInt if defined; else undefined
Assigns the provided primitive value to the height property.
the height value
this
PrimitiveTypeError for invalid primitive types
true if the height property exists and has a value; false otherwise
the width property value as a PositiveIntType object if defined; else an empty PositiveIntType object
Assigns the provided PrimitiveType value to the width property.
the width value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the width property exists and has a value; false otherwise
the width property value as a fhirPositiveInt if defined; else undefined
Assigns the provided primitive value to the width property.
the width value
this
PrimitiveTypeError for invalid primitive types
true if the width property exists and has a value; false otherwise
the frames property value as a PositiveIntType object if defined; else an empty PositiveIntType object
Assigns the provided PrimitiveType value to the frames property.
the frames value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the frames property exists and has a value; false otherwise
the frames property value as a fhirPositiveInt if defined; else undefined
Assigns the provided primitive value to the frames property.
the frames value
this
PrimitiveTypeError for invalid primitive types
true if the frames property exists and has a value; false otherwise
the duration property value as a DecimalType object if defined; else an empty DecimalType object
Assigns the provided PrimitiveType value to the duration property.
the duration value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the duration property exists and has a value; false otherwise
the duration property value as a fhirDecimal if defined; else undefined
Assigns the provided primitive value to the duration property.
the duration value
this
PrimitiveTypeError for invalid primitive types
true if the duration property exists and has a value; false otherwise
the pages property value as a PositiveIntType object if defined; else an empty PositiveIntType object
Assigns the provided PrimitiveType value to the pages property.
the pages value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the pages property exists and has a value; false otherwise
the pages property value as a fhirPositiveInt if defined; else undefined
Assigns the provided primitive value to the pages property.
the pages value
this
PrimitiveTypeError for invalid primitive types
true if the pages property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
true if the instance is a FHIR complex datatype; false otherwise
the complex or primitive data model type name (e.g., 'Period", 'StringType', `UriType', etc.)
the JSON value or undefined if the instance is empty
true if the instance is a FHIR complex or primitive datatype; false otherwise
the id property value
Assigns the provided value to the id property.
the id value
this
PrimitiveTypeError for invalid value
true if id exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
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.
the url that identifies a specific Extension
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.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
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
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
Attachment Class
Remarks
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
See
FHIR Attachment