Situational Awareness for Novel Epidemic Response
1.0.1 - CI Build International flag

Situational Awareness for Novel Epidemic Response, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-saner/ and changes regularly. See the Directory of published versions

Data Type Profile: PublicHealthMeasureMetadataAttachment - Detailed Descriptions

Active as of 2024-01-25

Definitions for the PublicHealthMeasureMetadataAttachment data type profile.

Guidance on how to interpret the contents of this table can be found here

0. Attachment
2. Attachment.id
Control1..?
4. Attachment.contentType
Definition

FHIR Resources should use application/fhir+xml or application/fhir+json, CQL source files should use text/cql, and FHIR Packages should use application/gzip.

Shortapplication/fhir+xml | application/fhir+json | text/cql | application/gzip
Control1..?
BindingThe codes SHALL be taken from Public Health Measure Attachment Types
(required to http://hl7.org/fhir/uv/saner/ValueSet/PublicHealthMeasureAttachmentTypes
Must Supporttrue
6. Attachment.data
Must Supporttrue
8. Attachment.url
Control1..?
Must Supporttrue
10. Attachment.title
Control1..?
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here

0. Attachment
Definition

For referring to data content defined in other formats.

ShortContent in a format defined elsewhere
Comments

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".

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsatt-1: If the Attachment has data, it SHALL have a contentType (data.empty() or contentType.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
att-1: If the Attachment has data, it SHALL have a contentType (data.empty() or contentType.exists())
2. Attachment.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control10..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Attachment.contentType
Definition

FHIR Resources should use application/fhir+xml or application/fhir+json, CQL source files should use text/cql, and FHIR Packages should use application/gzip.


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.

Shortapplication/fhir+xml | application/fhir+json | text/cql | application/gzipMime type of the content, with charset etc.
Control10..1
BindingThe codes SHALL be taken from Public Health Measure Attachment Typeshttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
(required to http://hl7.org/fhir/uv/saner/ValueSet/PublicHealthMeasureAttachmentTypes
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Processors of the data need to be able to know how to interpret the data.

Example<br/><b>General</b>:text/plain; charset=UTF-8, image/png
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Attachment.data
Definition

The actual data of the attachment - a sequence of bytes, base64 encoded.

ShortData inline, base64ed
Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

Control0..1
Typebase64Binary
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Requirements

The data needs to able to be transmitted inline.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Attachment.url
Definition

A location where the data can be accessed.

ShortUri where the data can be found
Comments

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.

Control10..1
Typeurl
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

The data needs to be transmitted by reference.

Example<br/><b>General</b>:http://www.acme.com/logo-small.png
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Attachment.title
Definition

A label or set of text to display in place of the data.

ShortLabel to display in place of the data
Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
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.

Example<br/><b>General</b>:Official Corporate Logo
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Attachment
Definition

For referring to data content defined in other formats.

ShortContent in a format defined elsewhere
Comments

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".

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsatt-1: If the Attachment has data, it SHALL have a contentType (data.empty() or contentType.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Attachment.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control1..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. Attachment.extension
Definition

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 manageable, 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.

ShortAdditional content defined by implementations
Comments

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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Attachment.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. Attachment.contentType
Definition

FHIR Resources should use application/fhir+xml or application/fhir+json, CQL source files should use text/cql, and FHIR Packages should use application/gzip.

Shortapplication/fhir+xml | application/fhir+json | text/cql | application/gzip
Control1..1
BindingThe codes SHALL be taken from Public Health Measure Attachment Types
(required to http://hl7.org/fhir/uv/saner/ValueSet/PublicHealthMeasureAttachmentTypes
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Processors of the data need to be able to know how to interpret the data.

Example<br/><b>General</b>:text/plain; charset=UTF-8, image/png
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Attachment.language
Definition

The human language of the content. The value can be any valid value according to BCP 47.

ShortHuman language of the content (BCP-47)
Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Users need to be able to choose between the languages in a set of attachments.

Example<br/><b>General</b>:en-AU
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Attachment.data
Definition

The actual data of the attachment - a sequence of bytes, base64 encoded.

ShortData inline, base64ed
Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

Control0..1
Typebase64Binary
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Requirements

The data needs to able to be transmitted inline.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Attachment.url
Definition

A location where the data can be accessed.

ShortUri where the data can be found
Comments

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.

Control1..1
Typeurl
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

The data needs to be transmitted by reference.

Example<br/><b>General</b>:http://www.acme.com/logo-small.png
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Attachment.size
Definition

The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

ShortNumber of bytes of content (if url provided)
Comments

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.

Control0..1
TypeunsignedInt
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Attachment.hash
Definition

The calculated hash of the data using SHA-1. Represented using base64.

ShortHash of the data (sha-1, base64ed)
Comments

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.

Control0..1
Typebase64Binary
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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).

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Attachment.title
Definition

A label or set of text to display in place of the data.

ShortLabel to display in place of the data
Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
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.

Example<br/><b>General</b>:Official Corporate Logo
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Attachment.creation
Definition

The date that the attachment was first created.

ShortDate attachment was first created
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This is often tracked as an integrity issue for use of the attachment.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))