Shared Health Specification and Guide Version 2.0 Revision F

 

Definitions for the profile-media-fax Profile.

Media
Definition

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

Control0..*
Must Supporttrue
Comments

Media is used to provide a copy of the Fax document that was created. Subtype and content are both mandatory. All values for subtype are fixed values. Content will be sued to provide the url where the copy of the Fax document can be retrieved.

Max Length0
InvariantsDefined on this element
mda-1: Height can only be used for a photo or video (: height.empty() or type != 'audio')
mda-2: Width can only be used for a photo or video (: width.empty() or type != 'audio')
mda-3: Frames can only be used for a photo (: frames.empty() or type = 'photo')
mda-4: Duration can only be used for an audio or a video (: duration.empty() or type != 'photo')
Media.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control1..1
Typeid
Must Supporttrue
Comments

Usage Note: This will usually be a GUID and is assigned by the sending application. Ideally it should be consistent for all messages referencing this same set of coverage information.

Max Length0
Media.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Max Length0
Media.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Max Length0
Media.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Max Length0
Media.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Max Length0
Media.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Max Length0
Media.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

Max Length0
Media.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
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.

Max Length0
Media.identifier
Definition

Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Comments

The identifier label and use can be used to determine what kind of identifier it is.

Max Length0
Media.type
Definition

Whether the media is a photo (still image), an audio recording, or a video recording.

Control1..1
BindingWhether the Media is a photo, video, or audio
The codes SHALL be taken from DigitalMediaType
Typecode
Must Supporttrue
Comments

Fixed value: photo

Max Length0
Fixed Valuephoto
Media.subtype
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1
BindingDetailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it
For example codes, see Media SubType
TypeCodeableConcept(Shared Health CodeableConcept Code)
Must Supporttrue
Comments

-

Max Length0
Media.view
Definition

The name of the imaging view e.g. Lateral or Antero-posterior (AP).

Control0..1
BindingImaging view (projection) used when collecting an image
For example codes, see Media Collection View/Projection
TypeCodeableConcept
Max Length0
Media.subject
Definition

Who/What this Media is a record of.

Control0..1
TypeReference(Patient | Practitioner | Group | Device | Specimen)
Max Length0
Media.operator
Definition

The person who administered the collection of the image.

Control0..1
TypeReference(Practitioner)
Max Length0
Media.deviceName
Definition

The name of the device / manufacturer of the device that was used to make the recording.

Control0..1
Typestring
Max Length0
Media.height
Definition

Height of the image in pixels (photo/video).

Control0..1 This element is affected by the following invariants: mda-1
TypepositiveInt
Max Length0
Media.width
Definition

Width of the image in pixels (photo/video).

Control0..1 This element is affected by the following invariants: mda-2
TypepositiveInt
Max Length0
Media.frames
Definition

The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

Control0..1 This element is affected by the following invariants: mda-3
TypepositiveInt
Max Length0
Default Value1
Media.duration
Definition

The duration of the recording in seconds - for audio and video.

Control0..1 This element is affected by the following invariants: mda-4
TypeunsignedInt
Max Length0
Media.content
Definition

The actual content of the media - inline or by direct reference to the media source file.

Control1..1
TypeAttachment
Must Supporttrue
Comments

Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter. For an media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching.

Max Length0
Media.content.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Media.content.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

Max Length0
Media.content.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.

Control1..1
BindingThe mime type of an attachment. Any valid mime type is allowed.
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/mimetypes
Typecode
Must Supporttrue
Requirements

Processors of the data need to be able to know how to interpret the data.

Comments

Fixed value: application/pdf

Max Length0
Fixed Valueapplication/pdf
Example
General:text/plain; charset=UTF-8, image/png
Media.content.language
Definition

The human language of the content. The value can be any valid value according to BCP 47.

Control0..1
BindingA human language.
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Requirements

Users need to be able to choose between the languages in a set of attachments.

Max Length0
Example
General:en-AU
Media.content.data
Definition

The actual data of the attachment - a sequence of bytes. In XML, represented using base64.

Control0..0
Typebase64Binary
Requirements

The data needs to able to be transmitted inline.

Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

Max Length0
Media.content.url
Definition

This is the URL from which the message recipient can retrieve the fax that was sent to the target of the underliverable message

Control1..1
Typeuri
Must Supporttrue
Requirements

The data needs to be transmitted by reference.

Comments

A url will be provided, where the Fax document can be retrieved from.

Max Length0
Example
General:http://www.acme.com/logo-small.png
Media.content.size
Definition

The number of bytes of data that make up this attachment.

Control0..1
TypeunsignedInt
Requirements

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

Comments

The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

Max Length0
Media.content.hash
Definition

The calculated hash of the data using SHA-1. Represented using base64.

Control0..1
Typebase64Binary
Requirements

Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature.

Max Length0
Media.content.title
Definition

A label or set of text to display in place of the data.

Control0..1
Typestring
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.

Max Length0
Example
General:Official Corporate Logo
Media.content.creation
Definition

The date that the attachment was first created.

Control0..1
TypedateTime
Requirements

This is often tracked as an integrity issue for use of the attachment.

Max Length0