HL7.FHIR.US.ICSR-AE-REPORTING\AdditionalDocumentInformation - Definitions

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

4. Extension.extension

Definition

An Extension

Short Extension

Control 1..*

Is Modifier false

Summary false

This element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:

value @ url

6. Extension.extension:availableFlag

Slice Name availableFlag

Definition

An Extension

Short Extension

Control 1..1

Is Modifier false

Must Support true

Summary false

8. Extension.extension:availableFlag.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

10. Extension.extension:availableFlag.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:

value @ url

12. Extension.extension:availableFlag.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control 1..1

uri

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value availableFlag

14. Extension.extension:availableFlag.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

boolean

[x] Note See Choice of Data Types for further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary false

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

16. Extension.extension:document

Slice Name document

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Must Support true

Summary false

18. Extension.extension:document.id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

20. Extension.extension:document.extension

Definition

An Extension

Short Extension

Control 0..0

Is Modifier false

Summary false

value @ url

22. Extension.extension:document.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1

uri

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

Fixed Value document

24. Extension.extension:document.value[x]

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Short Value of extension

Control 1..1

Attachment

[x] Note See Choice of Data Types for further information about how to use [x]

Is Modifier false

Must Support true

Summary false

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

26. Extension.extension:document.value[x].id

Definition

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

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

28. Extension.extension:document.value[x].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.

Short Additional 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.

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

This element introduces a set of slices on Extension.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:

value @ url

30. Extension.extension:document.value[x].contentType

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.

Short Mime type of the content, with charset etc.

Control 0..1

Binding The codes SHALL be taken from Mime Types: The mime type of an attachment. Any valid mime type is allowed.

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

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

Example General:text/plain; charset=UTF-8, image/png

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

32. Extension.extension:document.value[x].language

Definition

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

Short Human language of the content (BCP-47)

Control 0..1

Binding

The codes SHOULD be taken from CommonLanguages: A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

Example General:en-AU

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

34. Extension.extension:document.value[x].data

Definition

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

Short Data inline, base64ed

Comments

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

Control 0..1

base64Binary

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Requirements

The data needs to able to be transmitted inline.

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

36. Extension.extension:document.value[x].url

Definition

A location where the data can be accessed.

Short Uri 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.

Control 1..1

url

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

Requirements

The data needs to be transmitted by reference.

Example General:http://www.acme.com/logo-small.png

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

38. Extension.extension:document.value[x].size

Definition

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

Short Number 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.

Control 0..1

unsignedInt

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

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

40. Extension.extension:document.value[x].hash

Definition

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

Short Hash 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.

Control 0..1

base64Binary

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

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

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

42. Extension.extension:document.value[x].title

Definition

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

Short Label to display in place of the data

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support true

Summary true

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 General:Official Corporate Logo

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

44. Extension.extension:document.value[x].creation

Definition

The date that the attachment was first created.

Short Date attachment was first created

Control 0..1

dateTime

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

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

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

46. Extension.url

Definition

Source of the definition for the extension code - a logical name or a URL.

Short identifies the meaning of the extension

Comments

Control 1..1