Name Flags Card. Type Description & Constraints Attachment N Element Content in a format defined elsewhere + Rule: If the Attachment has data, it SHALL have a contentType Elements defined in Ancestors: id, <a href="types.html#Element" title="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.">extension #xD; contentType ΣC 0..1 code Mime type of the content, with charset etc. Binding: Mime Types (Required) #xD; language Σ 0..1 code Human language of the content (BCP-47) Binding: All Languages (Required) Additional Bindings Purpose Common Languages Starter #xD; data C 0..1 base64Binary Data inline, base64ed #xD; url Σ 0..1 url Uri where the data can be found #xD; size Σ 0..1 integer64 Number of bytes of content (if url provided) #xD; hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed) #xD; title ΣT 0..1 string Label to display in place of the data #xD; creation Σ 0..1 dateTime Date attachment was first created #xD; height TU 0..1 positiveInt Height of the image in pixels (photo/video) #xD; width TU 0..1 positiveInt Width of the image in pixels (photo/video) #xD; frames TU 0..1 positiveInt Number of frames if > 1 (photo) #xD; duration TU 0..1 decimal Length in seconds (audio / video) #xD; pages TU 0..1 positiveInt Number of printed pages #xD; Documentation for this format
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.
For referring to data content defined in other formats.
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".
If the Attachment has data, it SHALL have a contentType
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Mime type of the content, with charset etc.
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.
Processors of the data need to be able to know how to interpret the data.
The mime type of an attachment. Any valid mime type is allowed.
ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
The human language of the content. The value can be any valid value according to BCP 47.
Users need to be able to choose between the languages in a set of attachments.
The actual data of the attachment - a sequence of bytes, base64 encoded.
The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
The data needs to able to be transmitted inline.
A location where the data can be accessed.
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.
The data needs to be transmitted by reference.
RP.1+RP.2 - if they refer to a URL (see v2.6)
Number of bytes of content (if url provided)
The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
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.
Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
The calculated hash of the data using SHA-1. Represented using base64.
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](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.
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).
A label or set of text to display in place of the data.
May sometimes be derived from the source filename.
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.
The date that the attachment was first created.
This is often tracked as an integrity issue for use of the attachment.
Height of the image in pixels (photo/video)
Height of the image in pixels (photo/video).
.outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value
Width of the image in pixels (photo/video)
Width of the image in pixels (photo/video).
The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.
The duration of the recording in seconds - for audio and video.
The duration might differ from occurrencePeriod if recording was paused.