NHS England North West GMSA - IHE Laboratory Testing Workflow (LTW)
0.0.1 - ci-build United Kingdom flag

DRAFT Implementation Guide

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

NHS England North West GMSA - IHE Laboratory Testing Workflow (LTW) - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: Attachment

Official URL: https://fhir.north-west.england.nhs.uk/StructureDefinition/NWAttachment Version: 0.0.1
Draft as of 2025-04-20 Computable Name: NWAttachment

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.

Usage:

Formal Views of Profile Content

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

This structure is derived from Attachment

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Attachment.contentTyperequiredDocumentEntryMimeType
https://fhir.north-west.england.nhs.uk/ValueSet/document-entry-mimetype
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment C 0..* Attachment Content in a format defined elsewhere
att-1: If the Attachment has data, it SHALL have a contentType
ele-1: All FHIR elements must have a @value or children
... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: DocumentEntry mimeType (required)
ele-1: All FHIR elements must have a @value or children
Example General: text/plain; charset=UTF-8, image/png
... data 0..1 base64Binary Avoid using for wider compatability reasons.
ele-1: All FHIR elements must have a @value or children
... url Σ 0..1 url Uri where the data can be found. Mandatory for PDF or FHIR Documents
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/logo-small.png

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Attachment.contentTyperequiredDocumentEntryMimeType
https://fhir.north-west.england.nhs.uk/ValueSet/document-entry-mimetype
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment C 0..* Attachment Content in a format defined elsewhere
att-1: If the Attachment has data, it SHALL have a contentType
... 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 BindingsPurpose
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Attachment.contentTyperequiredDocumentEntryMimeType
https://fhir.north-west.england.nhs.uk/ValueSet/document-entry-mimetype
from this IG
Attachment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

This structure is derived from Attachment

Summary

Differential View

This structure is derived from Attachment

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Attachment.contentTyperequiredDocumentEntryMimeType
https://fhir.north-west.england.nhs.uk/ValueSet/document-entry-mimetype
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment C 0..* Attachment Content in a format defined elsewhere
att-1: If the Attachment has data, it SHALL have a contentType
ele-1: All FHIR elements must have a @value or children
... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: DocumentEntry mimeType (required)
ele-1: All FHIR elements must have a @value or children
Example General: text/plain; charset=UTF-8, image/png
... data 0..1 base64Binary Avoid using for wider compatability reasons.
ele-1: All FHIR elements must have a @value or children
... url Σ 0..1 url Uri where the data can be found. Mandatory for PDF or FHIR Documents
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/logo-small.png

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Attachment.contentTyperequiredDocumentEntryMimeType
https://fhir.north-west.england.nhs.uk/ValueSet/document-entry-mimetype
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Attachment C 0..* Attachment Content in a format defined elsewhere
att-1: If the Attachment has data, it SHALL have a contentType
... 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 BindingsPurpose
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Attachment.contentTyperequiredDocumentEntryMimeType
https://fhir.north-west.england.nhs.uk/ValueSet/document-entry-mimetype
from this IG
Attachment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

This structure is derived from Attachment

Summary

 

Other representations of profile: CSV, Excel, Schematron