Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft Australia flag

Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions

Extension: ADHA Alternate HL7 Format as Attachment Base64 Encoded (Experimental)

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-attachment-hl7-base64-1 Version: 0.0.1
Draft as of 2024-09-12 Computable Name: ADHAHL7AttachmentBase64

Copyright/Legal: Copyright © 2023 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

This extension applies to any resource and is provided. It is used to provide an alternate HL7 format of the content represented by the associated FHIR Resource it is sent as an attachment with. The data is represented directly inline, base64 encoded.

Context of Use

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

  • Element ID Resource

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

None.

Boundaries and relationships

This extension is part of a set of experimental design options:

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

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

Simple Extension of type Attachment: This extension applies to any resource and is provided. It is used to provide an alternate HL7 format of the content represented by the associated FHIR Resource it is sent as an attachment with. The data is represented directly inline, base64 encoded.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension Alternate HL7 format of the content as an attachment, data inline, base64 encoded
... url 1..1 uri "http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-attachment-hl7-base64-1"
... value[x] 1..1 Attachment Data inline, base64ed
.... contentType 1..1 code x-application/hl7-v2+er7 | x-application/hl7-v2+xml | x-application/hl7-v3+xml | x-application/fhir+xml | x-application/fhir+json | x-application/xml+cda
.... data 1..1 base64Binary Data inline, base64ed

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension Alternate HL7 format of the content as an attachment, data inline, base64 encoded
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1 uri "http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-attachment-hl7-base64-1"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType Σ 1..1 code x-application/hl7-v2+er7 | x-application/hl7-v2+xml | x-application/hl7-v3+xml | x-application/fhir+xml | x-application/fhir+json | x-application/xml+cda
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..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data 1..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension of type Attachment: This extension applies to any resource and is provided. It is used to provide an alternate HL7 format of the content represented by the associated FHIR Resource it is sent as an attachment with. The data is represented directly inline, base64 encoded.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension Alternate HL7 format of the content as an attachment, data inline, base64 encoded
... url 1..1 uri "http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-attachment-hl7-base64-1"
... value[x] 1..1 Attachment Data inline, base64ed
.... contentType 1..1 code x-application/hl7-v2+er7 | x-application/hl7-v2+xml | x-application/hl7-v3+xml | x-application/fhir+xml | x-application/fhir+json | x-application/xml+cda
.... data 1..1 base64Binary Data inline, base64ed

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension Alternate HL7 format of the content as an attachment, data inline, base64 encoded
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1 uri "http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-attachment-hl7-base64-1"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType Σ 1..1 code x-application/hl7-v2+er7 | x-application/hl7-v2+xml | x-application/hl7-v3+xml | x-application/fhir+xml | x-application/fhir+json | x-application/xml+cda
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..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data 1..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.value[x].contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
Extension.value[x].languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Notes:

Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.