DRAFT Implementation Guide

This is for collaboration and discussion purposes and is subject to change.

North West Genomic Medicine Service Alliance - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON

Data Type Profile: Attachment

DRAFT: Additional conformance on FHIR Attachment data type. In HL7 FHIR this is likely to be a Binary resource and in HL7 v2 the OBX segment. When laboratory reports include a url link in DiagnosticReport, the FHIR Bundle should also include a FHIR DocumentReference providing additional document metadata.

Usages:

• Use this DataType Profile: Diagnostic Report and DocumentReference

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Attachment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Attachment			Attachment
contentType		0..1	code	Mime type of the content, with charset etc. Binding: DocumentEntry mimeType (required)
data		0..1	base64Binary	Avoid using for wider compatability reasons.
url		0..1	url	Uri where the data can be found. Mandatory for PDF or FHIR Documents
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Attachment.contentType	required	DocumentEntryMimeType https://nw-gmsa.github.io/ValueSet/document-entry-mimetype From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Attachment	C	0..*	Attachment	Content in a format defined elsewhere Constraints: att-1
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: DocumentEntry mimeType (required) Example General: text/plain; charset=UTF-8, image/png
data		0..1	base64Binary	Avoid using for wider compatability reasons.
url	Σ	0..1	url	Uri where the data can be found. Mandatory for PDF or FHIR Documents Example General: http://www.acme.com/logo-small.png
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Attachment.contentType	required	DocumentEntryMimeType https://nw-gmsa.github.io/ValueSet/document-entry-mimetype From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
att-1	error	Attachment	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Attachment	C	0..*	Attachment	Content in a format defined elsewhere Constraints: att-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	Σ	0..1	code	Mime type of the content, with charset etc. Binding: DocumentEntry mimeType (required) 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 Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Avoid using for wider compatability reasons.
url	Σ	0..1	url	Uri where the data can be found. Mandatory for PDF or FHIR Documents 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Attachment.contentType	required	DocumentEntryMimeType https://nw-gmsa.github.io/ValueSet/document-entry-mimetype From this IG
Attachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
att-1	error	Attachment	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Attachment

Summary

Differential View

This structure is derived from Attachment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Attachment			Attachment
contentType		0..1	code	Mime type of the content, with charset etc. Binding: DocumentEntry mimeType (required)
data		0..1	base64Binary	Avoid using for wider compatability reasons.
url		0..1	url	Uri where the data can be found. Mandatory for PDF or FHIR Documents
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Attachment.contentType	required	DocumentEntryMimeType https://nw-gmsa.github.io/ValueSet/document-entry-mimetype From this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Attachment	C	0..*	Attachment	Content in a format defined elsewhere Constraints: att-1
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: DocumentEntry mimeType (required) Example General: text/plain; charset=UTF-8, image/png
data		0..1	base64Binary	Avoid using for wider compatability reasons.
url	Σ	0..1	url	Uri where the data can be found. Mandatory for PDF or FHIR Documents Example General: http://www.acme.com/logo-small.png
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Attachment.contentType	required	DocumentEntryMimeType https://nw-gmsa.github.io/ValueSet/document-entry-mimetype From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
att-1	error	Attachment	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Attachment	C	0..*	Attachment	Content in a format defined elsewhere Constraints: att-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	Σ	0..1	code	Mime type of the content, with charset etc. Binding: DocumentEntry mimeType (required) 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 Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Avoid using for wider compatability reasons.
url	Σ	0..1	url	Uri where the data can be found. Mandatory for PDF or FHIR Documents 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Attachment.contentType	required	DocumentEntryMimeType https://nw-gmsa.github.io/ValueSet/document-entry-mimetype From this IG
Attachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
att-1	error	Attachment	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Attachment

Summary

Other representations of profile: CSV, Excel, Schematron