Shared Health Specification and Guide Version 5.0

 

The official URL for this profile is:

http://sharedhealth.exchange/fhir/StructureDefinition/profile-media-fax

Download Excel representation

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

>

This structure is derived from Media

NameCard.TypeConstraints and Usage
.  Media 0..*Mediamda-1: Height can only be used for a photo or video
mda-2: Width can only be used for a photo or video
mda-4: Duration can only be used for an audio or a video
mda-3: Frames can only be used for a photo
Definition:
A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.


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.

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


Comments:
Usage Note: This will usually be a GUID and is assigned by the sending application.

..  type 1..1codeBinding: DigitalMediaType (required): Whether the Media is a photo, video, or audio


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


Comments:
Fixed value: photo

..  subtype 1..1Shared Health CodeableConcept CodeBinding: Media SubType (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it


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


Comments:


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


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.

...  contentType 1..1codeBinding: MimeTypes (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/pdf
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.


Comments:
Fixed value: application/pdf

...  url 1..1uriExample' General': http://www.acme.com/logo-small.png
Definition:
This is the URL from which the message recipient can retrieve the fax that was sent to the target of the underliverable message


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

This structure is derived from Media

Summary

Mandatory: 6 elements
Must-Support: 6 elements
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media S0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... id S1..1idLogical id of this artifact
... type S1..1codephoto | video | audio
Fixed Value: photo
... subtype S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
... content S1..1AttachmentActual Media - reference or data
.... contentType S1..1codeMime type of the content, with charset etc.
Fixed Value: application/pdf
.... data 0..0
.... url S1..1uriURL to retrieve fax from

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Media SI0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) for the image
... type SΣ1..1codephoto | video | audio
Binding: DigitalMediaType (required): Whether the Media is a photo, video, or audio


Fixed Value: photo
... subtype S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: Media SubType (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it

... view Σ0..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior
Binding: Media Collection View/Projection (example): Imaging view (projection) used when collecting an image

... subject Σ0..1Reference(Patient | Practitioner | Group | Device | Specimen)Who/What this Media is a record of
... operator Σ0..1Reference(Practitioner)The person who generated the image
... deviceName Σ0..1stringName of the device/manufacturer
... height ΣI0..1positiveIntHeight of the image in pixels (photo/video)
... width ΣI0..1positiveIntWidth of the image in pixels (photo/video)
... frames ΣI0..1positiveIntNumber of frames if > 1 (photo)
... duration ΣI0..1unsignedIntLength in seconds (audio / video)
... content S1..1AttachmentActual Media - reference or data
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: MimeTypes (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/pdf
.... language Σ0..1codeHuman language of the content (BCP-47)
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


Example General: en-AU
.... url SΣ1..1uriURL to retrieve fax from
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 Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
.... creation Σ0..1dateTimeDate attachment was first created

doco Documentation for this format

Grid View

This structure is derived from Media

NameCard.TypeConstraints and Usage
.  Media 0..*Mediamda-1: Height can only be used for a photo or video
mda-2: Width can only be used for a photo or video
mda-4: Duration can only be used for an audio or a video
mda-3: Frames can only be used for a photo
Definition:
A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.


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.

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


Comments:
Usage Note: This will usually be a GUID and is assigned by the sending application.

..  type 1..1codeBinding: DigitalMediaType (required): Whether the Media is a photo, video, or audio


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


Comments:
Fixed value: photo

..  subtype 1..1Shared Health CodeableConcept CodeBinding: Media SubType (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it


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


Comments:


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


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.

...  contentType 1..1codeBinding: MimeTypes (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/pdf
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.


Comments:
Fixed value: application/pdf

...  url 1..1uriExample' General': http://www.acme.com/logo-small.png
Definition:
This is the URL from which the message recipient can retrieve the fax that was sent to the target of the underliverable message


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

This structure is derived from Media

Summary

Mandatory: 6 elements
Must-Support: 6 elements
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media S0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... id S1..1idLogical id of this artifact
... type S1..1codephoto | video | audio
Fixed Value: photo
... subtype S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
... content S1..1AttachmentActual Media - reference or data
.... contentType S1..1codeMime type of the content, with charset etc.
Fixed Value: application/pdf
.... data 0..0
.... url S1..1uriURL to retrieve fax from

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media SI0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) for the image
... type SΣ1..1codephoto | video | audio
Binding: DigitalMediaType (required): Whether the Media is a photo, video, or audio


Fixed Value: photo
... subtype S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: Media SubType (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it

... view Σ0..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior
Binding: Media Collection View/Projection (example): Imaging view (projection) used when collecting an image

... subject Σ0..1Reference(Patient | Practitioner | Group | Device | Specimen)Who/What this Media is a record of
... operator Σ0..1Reference(Practitioner)The person who generated the image
... deviceName Σ0..1stringName of the device/manufacturer
... height ΣI0..1positiveIntHeight of the image in pixels (photo/video)
... width ΣI0..1positiveIntWidth of the image in pixels (photo/video)
... frames ΣI0..1positiveIntNumber of frames if > 1 (photo)
... duration ΣI0..1unsignedIntLength in seconds (audio / video)
... content S1..1AttachmentActual Media - reference or data
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: MimeTypes (required): The mime type of an attachment. Any valid mime type is allowed.


Fixed Value: application/pdf
.... language Σ0..1codeHuman language of the content (BCP-47)
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


Example General: en-AU
.... url SΣ1..1uriURL to retrieve fax from
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 Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
.... creation Σ0..1dateTimeDate attachment was first created

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Media.languagerequiredhttp://tools.ietf.org/html/bcp47
Media.typerequiredFixed Value: photo
Media.subtypeexampleMedia SubType
Media.viewexampleMedia Collection View/Projection
Media.content.contentTyperequiredFixed Value: application/pdf
Media.content.languagerequiredhttp://tools.ietf.org/html/bcp47

Constraints

IdPathDetailsRequirements
mda-1MediaHeight can only be used for a photo or video
: height.empty() or type != 'audio'
mda-2MediaWidth can only be used for a photo or video
: width.empty() or type != 'audio'
mda-4MediaDuration can only be used for an audio or a video
: duration.empty() or type != 'photo'
mda-3MediaFrames can only be used for a photo
: frames.empty() or type = 'photo'