HL7 FHIR Implementation Guide: Profiles for Transfusion and Vaccination Adverse Event Detection and Reporting
1.0.1 - STU 1 Technical Correction United States of America flag

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. For a full list of available versions, see the Directory of published versions

Extension: AdditionalDocumentInformation

Official URL: http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/icsr-ext-additionaldocumentinformation Version: 1.0.1
Draft as of 2023-08-29 Computable Name: AdditionalDocumentInformation

A set of information to indicate what additional documentation exists.

Context of Use

This extension may be used on the following element(s):

  • Element ID Composition

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Complex Extension: A set of information to indicate what additional documentation exists.

  • availableFlag: boolean: An Extension
  • document: Attachment: An Extension

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension 1..*ExtensionExtension
... extension:availableFlag S1..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"availableFlag"
.... value[x] S1..1booleanValue of extension
... extension:document S0..*ExtensionExtension
.... extension 0..0
.... url 1..1uri"document"
.... value[x] S1..1AttachmentValue of extension
..... contentType S0..1codeMime type of the content, with charset etc.
..... url S1..1urlUri where the data can be found
..... title S1..1stringLabel to display in place of the data
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:availableFlag S1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"availableFlag"
.... value[x] S1..1booleanValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"document"
.... value[x] S1..1AttachmentValue of extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ0..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url SΣ1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title SΣ1..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
... url 1..1uri"http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/icsr-ext-additionaldocumentinformation"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: A set of information to indicate what additional documentation exists.

  • availableFlag: boolean: An Extension
  • document: Attachment: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension 1..*ExtensionExtension
... extension:availableFlag S1..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"availableFlag"
.... value[x] S1..1booleanValue of extension
... extension:document S0..*ExtensionExtension
.... extension 0..0
.... url 1..1uri"document"
.... value[x] S1..1AttachmentValue of extension
..... contentType S0..1codeMime type of the content, with charset etc.
..... url S1..1urlUri where the data can be found
..... title S1..1stringLabel to display in place of the data
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:availableFlag S1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"availableFlag"
.... value[x] S1..1booleanValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"document"
.... value[x] S1..1AttachmentValue of extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ0..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
..... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url SΣ1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title SΣ1..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
... url 1..1uri"http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/icsr-ext-additionaldocumentinformation"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:document.value[x].contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
Extension.extension:document.value[x].languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding