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

This page is part of the Profiles for ICSR Transfusion and Vaccination Adverse Event Detection and Reporting (v1.0.1: STU 1 Update) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: AdditionalDocumentInformation - Detailed Descriptions

Draft as of 2023-08-29

Definitions for the icsr-ext-additionaldocumentinformation extension.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

0. Extension
Definition	A set of information to indicate what additional documentation exists.
2. Extension.extension
Control	1..?
4. Extension.extension:availableFlag
Slice Name	availableFlag
Control	1..1
Must Support	true
6. Extension.extension:availableFlag.extension
Control	0..0
8. Extension.extension:availableFlag.url
Fixed Value	availableFlag
10. Extension.extension:availableFlag.value[x]
Control	1..?
Type	boolean
[x] Note	See Choice of Data Types for further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	true
12. Extension.extension:document
Slice Name	document
Control	0..*
Must Support	true
14. Extension.extension:document.extension
Control	0..0
16. Extension.extension:document.url
Fixed Value	document
18. Extension.extension:document.value[x]
Control	1..?
Type	Attachment
[x] Note	See Choice of Data Types for further information about how to use [x]
Must Support	true
20. Extension.extension:document.value[x].contentType
Must Support	true
22. Extension.extension:document.value[x].url
Control	1..?
Must Support	true
24. Extension.extension:document.value[x].title
Control	1..?
Must Support	true
26. Extension.url
Fixed Value	http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/icsr-ext-additionaldocumentinformation
28. Extension.value[x]
Control	0..0

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

0. Extension
Definition	A set of information to indicate what additional documentation exists. Optional Extension Element - found in all resources.
Short	ExtensionOptional Extensions Element
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-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()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition	An Extension 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	ExtensionAdditional 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	10..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-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())
Slicing	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
4. Extension.extension:availableFlag
Slice Name	availableFlag
Definition	An Extension
Short	ExtensionAdditional content defined by implementations
Control	10..1*
Type	Extension
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())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Extension.extension:availableFlag.extension
Definition	An Extension 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	ExtensionAdditional 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..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-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())
Slicing	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
8. 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
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	availableFlag
10. 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	10..1
Type	boolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
[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()))
12. Extension.extension:document
Slice Name	document
Definition	An Extension
Short	ExtensionAdditional content defined by implementations
Control	0..*
Type	Extension
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())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Extension.extension:document.extension
Definition	An Extension 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	ExtensionAdditional 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..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-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())
Slicing	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
16. 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	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
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	document
18. 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	10..1
Type	Attachment, date, Meta, Address, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[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()))
20. 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 Typeshttp://hl7.org/fhir/ValueSet/mimetypes\|4.0.1 The mime type of an attachment. Any valid mime type is allowed.
Type	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	<br/><b>General</b>: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()))
22. 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	10..1
Type	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	<br/><b>General</b>: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()))
24. 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	10..1
Type	string
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	<br/><b>General</b>:Official Corporate Logo
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. 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	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
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/icsr-ext-additionaldocumentinformation
28. Extension.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	0..01
Type	Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-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. Extension

Definition

A set of information to indicate what additional documentation exists.

Short Extension

Control 0..*
This element is affected by the following invariants: ele-1

Is Modifier false

Invariants ele-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())

2. Extension.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