This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2
StructureDefinition for media
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Media"/> <meta> <lastUpdated value="2015-04-03T14:24:32.000+11:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <url value="http://hl7.org/fhir/StructureDefinition/Media"/> <name value="Media"/> <publisher value="HL7 FHIR Project (FHIR Management Group)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fhirmg/index.cfm"/> </telecom> </contact> <description value="Base StructureDefinition for Media Resource"/> <status value="draft"/> <date value="2015-04-03T14:24:32+11:00"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="dicom"/> <uri value="http://nema.org/dicom"/> <name value="DICOM"/> </mapping> <type value="resource"/> <abstract value="true"/> <snapshot> <element> <path value="Media"/> <short value="A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference"/> <definition value="A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference."/> <min value="1"/> <max value="1"/> <type> <code value="DomainResource"/> </type> <constraint> <key value="mda-1"/> <name value="Height rule"/> <severity value="error"/> <human value="Height can only be used for a photo or video"/> <xpath value="not(f:type/@value='audio') or not(f:height)"/> </constraint> <constraint> <key value="mda-2"/> <name value="Width rule"/> <severity value="error"/> <human value="Width can only be used for a photo or video"/> <xpath value="not(f:type/@value='audio') or not(f:width)"/> </constraint> <constraint> <key value="mda-4"/> <name value="Length rule"/> <severity value="error"/> <human value="Length can only be used for an audio or a video"/> <xpath value="not(f:type/@value='photo') or not(f:length)"/> </constraint> <constraint> <key value="mda-3"/> <name value="Frames rule"/> <severity value="error"/> <human value="Frames can only be used for a photo"/> <xpath value="(f:type/@value='photo') or not(f:frames)"/> </constraint> <mapping> <identity value="rim"/> <map value="Act[classCode="DGIMG", moodCode="EVN"]"/> </mapping> </element> <element> <path value="Media.id"/> <short value="Logical id of this artefact"/> <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes."/> <comments value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> </element> <element> <path value="Media.meta"/> <short value="Metadata about the resource"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="Meta"/> </type> </element> <element> <path value="Media.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comments value="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."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="true"/> </element> <element> <path value="Media.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments value="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)."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="Language"/> <strength value="required"/> <description value="A human language"/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <path value="Media.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="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."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element> <path value="Media.contained"/> <short value="Contained, inline Resources"/> <definition value="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."/> <comments value="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."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Media.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Media.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Media.type"/> <short value="photo | video | audio"/> <definition value="Whether the media is a photo (still image), an audio recording, or a video recording."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <name value="DigitalMediaType"/> <strength value="required"/> <description value="Whether the Media is a photo, video, or audio"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/digital-media-type"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element> <path value="Media.subtype"/> <short value="The type of acquisition equipment/process"/> <definition value="Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="DigitalMediaSubtype"/> <strength value="example"/> <description value="Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/digital-media-subtype"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="0008,0060 | 0008,1032"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN&quo t;].code"/> </mapping> </element> <element> <path value="Media.identifier"/> <short value="Identifier(s) for the image"/> <definition value="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."/> <comments value="The identifier label and use can be used to determine what kind of identifier it is."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="0008,0018 | ~0008,0050 | 0020,000D | 0020,000E"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element> <path value="Media.subject"/> <short value="Who/What this Media is a record of"/> <definition value="Who/What this Media is a record of."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Group"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Specimen"/> </type> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="~0010,0020"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode="SUBJ"]???"/> </mapping> </element> <element> <path value="Media.operator"/> <short value="The person who generated the image"/> <definition value="The person who administered the collection of the image."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="0008,1060?"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode="PERF"]???"/> </mapping> </element> <element> <path value="Media.view"/> <short value="Imaging view e.g Lateral or Antero-posterior"/> <definition value="The name of the imaging view e.g Lateral or Antero-posterior (AP)."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="MediaView"/> <strength value="example"/> <description value="Imaging view (projection) used when collecting an image"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/media-view"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="DiagnosticImage.subjectOrientationCode"/> </mapping> </element> <element> <path value="Media.deviceName"/> <short value="Name of the device/manufacturer"/> <definition value="The name of the device / manufacturer of the device that was used to make the recording."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="0008,0070"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode="DEV"].role.player.Entity[classCode="DEV"].name"/> </mapping> </element> <element> <path value="Media.height"/> <short value="Height of the image in pixels(photo/video)"/> <definition value="Height of the image in pixels(photo/video)."/> <min value="0"/> <max value="1"/> <type> <code value="positiveInt"/> </type> <condition value="mda-1"/> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="0028,0010"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN" ;,code="<CODE>"].value"/> </mapping> </element> <element> <path value="Media.width"/> <short value="Width of the image in pixels (photo/video)"/> <definition value="Width of the image in pixels (photo/video)."/> <min value="0"/> <max value="1"/> <type> <code value="positiveInt"/> </type> <condition value="mda-2"/> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="0028,0011"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN" ;,code="<CODE>"].value"/> </mapping> </element> <element> <path value="Media.frames"/> <short value="Number of frames if > 1 (photo)"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="positiveInt"/> </type> <condition value="mda-3"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN" ;,code="<CODE>"].value"/> </mapping> </element> <element> <path value="Media.duration"/> <short value="Length in seconds (audio / video)"/> <definition value="The duration of the recording in seconds - for audio and video."/> <min value="0"/> <max value="1"/> <type> <code value="unsignedInt"/> </type> <condition value="mda-4"/> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="~0028,0002"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN" ;,code="<CODE>"].value"/> </mapping> </element> <element> <path value="Media.content"/> <short value="Actual Media - reference or data"/> <definition value="The actual content of the media - inline or by direct reference to the media source file."/> <comments value="Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dic om. 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."/> <min value="1"/> <max value="1"/> <type> <code value="Attachment"/> </type> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </element> </snapshot> <differential> <element> <path value="Media"/> <short value="A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference"/> <definition value="A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference."/> <min value="1"/> <max value="1"/> <type> <code value="DomainResource"/> </type> <constraint> <key value="mda-1"/> <name value="Height rule"/> <severity value="error"/> <human value="Height can only be used for a photo or video"/> <xpath value="not(f:type/@value='audio') or not(f:height)"/> </constraint> <constraint> <key value="mda-2"/> <name value="Width rule"/> <severity value="error"/> <human value="Width can only be used for a photo or video"/> <xpath value="not(f:type/@value='audio') or not(f:width)"/> </constraint> <constraint> <key value="mda-4"/> <name value="Length rule"/> <severity value="error"/> <human value="Length can only be used for an audio or a video"/> <xpath value="not(f:type/@value='photo') or not(f:length)"/> </constraint> <constraint> <key value="mda-3"/> <name value="Frames rule"/> <severity value="error"/> <human value="Frames can only be used for a photo"/> <xpath value="(f:type/@value='photo') or not(f:frames)"/> </constraint> <mapping> <identity value="rim"/> <map value="Act[classCode="DGIMG", moodCode="EVN"]"/> </mapping> </element> <element> <path value="Media.type"/> <short value="photo | video | audio"/> <definition value="Whether the media is a photo (still image), an audio recording, or a video recording."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <name value="DigitalMediaType"/> <strength value="required"/> <description value="Whether the Media is a photo, video, or audio"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/digital-media-type"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element> <path value="Media.subtype"/> <short value="The type of acquisition equipment/process"/> <definition value="Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="DigitalMediaSubtype"/> <strength value="example"/> <description value="Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/digital-media-subtype"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="0008,0060 | 0008,1032"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN&quo t;].code"/> </mapping> </element> <element> <path value="Media.identifier"/> <short value="Identifier(s) for the image"/> <definition value="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."/> <comments value="The identifier label and use can be used to determine what kind of identifier it is."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="0008,0018 | ~0008,0050 | 0020,000D | 0020,000E"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element> <path value="Media.subject"/> <short value="Who/What this Media is a record of"/> <definition value="Who/What this Media is a record of."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Group"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Specimen"/> </type> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="~0010,0020"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode="SUBJ"]???"/> </mapping> </element> <element> <path value="Media.operator"/> <short value="The person who generated the image"/> <definition value="The person who administered the collection of the image."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="0008,1060?"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode="PERF"]???"/> </mapping> </element> <element> <path value="Media.view"/> <short value="Imaging view e.g Lateral or Antero-posterior"/> <definition value="The name of the imaging view e.g Lateral or Antero-posterior (AP)."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="MediaView"/> <strength value="example"/> <description value="Imaging view (projection) used when collecting an image"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/media-view"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="DiagnosticImage.subjectOrientationCode"/> </mapping> </element> <element> <path value="Media.deviceName"/> <short value="Name of the device/manufacturer"/> <definition value="The name of the device / manufacturer of the device that was used to make the recording."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="0008,0070"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode="DEV"].role.player.Entity[classCode="DEV"].name"/> </mapping> </element> <element> <path value="Media.height"/> <short value="Height of the image in pixels(photo/video)"/> <definition value="Height of the image in pixels(photo/video)."/> <min value="0"/> <max value="1"/> <type> <code value="positiveInt"/> </type> <condition value="mda-1"/> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="0028,0010"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN" ;,code="<CODE>"].value"/> </mapping> </element> <element> <path value="Media.width"/> <short value="Width of the image in pixels (photo/video)"/> <definition value="Width of the image in pixels (photo/video)."/> <min value="0"/> <max value="1"/> <type> <code value="positiveInt"/> </type> <condition value="mda-2"/> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="0028,0011"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN" ;,code="<CODE>"].value"/> </mapping> </element> <element> <path value="Media.frames"/> <short value="Number of frames if > 1 (photo)"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="positiveInt"/> </type> <condition value="mda-3"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN" ;,code="<CODE>"].value"/> </mapping> </element> <element> <path value="Media.duration"/> <short value="Length in seconds (audio / video)"/> <definition value="The duration of the recording in seconds - for audio and video."/> <min value="0"/> <max value="1"/> <type> <code value="unsignedInt"/> </type> <condition value="mda-4"/> <isSummary value="true"/> <mapping> <identity value="dicom"/> <map value="~0028,0002"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN" ;,code="<CODE>"].value"/> </mapping> </element> <element> <path value="Media.content"/> <short value="Actual Media - reference or data"/> <definition value="The actual content of the media - inline or by direct reference to the media source file."/> <comments value="Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dic om. 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."/> <min value="1"/> <max value="1"/> <type> <code value="Attachment"/> </type> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </element> </differential> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.