{ "resourceType": "StructureDefinition", "base": "http://hl7.org/fhir/StructureDefinition/DomainResource", "id": "spark56", "meta": { "versionId": "spark56", "lastUpdated": "2015-10-02T11:54:09.228+00:00" }, "text": { "status": "generated", "div": "
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\"MediaIDomainResourceA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference\n
Height can only be used for a photo or video
Width can only be used for a photo or video
Duration can only be used for an audio or a video
Frames can only be used for a photo
\".\"\".\"\".\"typeΣ1..1codephoto | video | audio\n
DigitalMediaType (\n Required)\n
\".\"\".\"\".\"subtypeΣ0..1CodeableConceptThe type of acquisition equipment/process\n
Media SubType (\n Example)\n
\".\"\".\"\".\"identifierΣ0..*IdentifierIdentifier(s) for the image
\".\"\".\"\".\"subjectΣ0..1Reference(\n Patient | \n Practitioner | \n Group | \n Device | \n Specimen)\n Who/What this Media is a record of
\".\"\".\"\".\"operatorΣ0..1Reference(\n Practitioner)\n The person who generated the image
\".\"\".\"\".\"viewΣ0..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior\n
Media Collection View/Projection (\n Example)\n
\".\"\".\"\".\"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)
\".\"\".\"\".\"content1..1AttachmentActual Media - reference or data

\"doco\" Documentation for this format\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1 } ], "url": "http://hl7.org/fhir/StructureDefinition/Media", "name": "Media", "status": "draft", "date": "2015-09-22T03:47:23+00:00", "publisher": "Health Level Seven International (FHIR Infrastructure)", "contact": [ { "telecom": [ { "system": "other", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "other", "value": "http://www.hl7.org/Special/committees/fiwg/index.cfm" } ] } ], "description": "Base StructureDefinition for Media Resource", "fhirVersion": "1.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" }, { "identity": "dicom", "uri": "http://nema.org/dicom", "name": "DICOM" } ], "kind": "resource", "abstract": false, "snapshot": { "element": [ { "path": "Media", "short": "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference", "definition": "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.", "min": 0, "max": "*", "type": [ { "code": "DomainResource" } ], "constraint": [ { "key": "mda-1", "severity": "error", "human": "Height can only be used for a photo or video", "xpath": "not(f:type/@value='audio') or not(f:height)" }, { "key": "mda-2", "severity": "error", "human": "Width can only be used for a photo or video", "xpath": "not(f:type/@value='audio') or not(f:width)" }, { "key": "mda-4", "severity": "error", "human": "Duration can only be used for an audio or a video", "xpath": "not(f:type/@value='photo') or not(f:duration)" }, { "key": "mda-3", "severity": "error", "human": "Frames can only be used for a photo", "xpath": "(f:type/@value='photo') or not(f:frames)" } ], "mapping": [ { "identity": "rim", "map": "Act[classCode=\"DGIMG\", moodCode=\"EVN\"]" }, { "identity": "w5", "map": "infrastructure.structure" } ] }, { "comments": "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.", "path": "Media.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "min": 0, "max": "1", "type": [ { "code": "id" } ], "isSummary": true }, { "path": "Media.meta", "short": "Metadata about the resource", "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.", "min": 0, "max": "1", "type": [ { "code": "Meta" } ], "isSummary": true }, { "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.", "path": "Media.implicitRules", "short": "A set of rules under which this content was created", "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.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "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).", "path": "Media.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "A human language.", "valueSetUri": "http://tools.ietf.org/html/bcp47" } }, { "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.", "path": "Media.text", "short": "Text summary of the resource, for human interpretation", "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.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "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.", "path": "Media.contained", "short": "Contained, inline Resources", "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "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.", "path": "Media.extension", "short": "Additional Content defined by implementations", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "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.", "path": "Media.modifierExtension", "short": "Extensions that cannot be ignored", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Media.type", "short": "photo | video | audio", "definition": "Whether the media is a photo (still image), an audio recording, or a video recording.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "Whether the Media is a photo, video, or audio", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/digital-media-type" } }, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "class" } ] }, { "path": "Media.subtype", "short": "The type of acquisition equipment/process", "definition": "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": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "example", "description": "Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/digital-media-subtype" } }, "mapping": [ { "identity": "dicom", "map": "0008,0060 | 0008,1032" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" }, { "identity": "w5", "map": "class" } ] }, { "comments": "The identifier label and use can be used to determine what kind of identifier it is.", "path": "Media.identifier", "short": "Identifier(s) for the image", "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.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "0008,0018 | ~0008,0050 | 0020,000D | 0020,000E" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] }, { "path": "Media.subject", "short": "Who/What this Media is a record of", "definition": "Who/What this Media is a record of.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Specimen" } ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "~0010,0020" }, { "identity": "rim", "map": ".participation[typeCode=\"SUBJ\"]???" }, { "identity": "w5", "map": "who.focus" } ] }, { "path": "Media.operator", "short": "The person who generated the image", "definition": "The person who administered the collection of the image.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "0008,1060?" }, { "identity": "rim", "map": ".participation[typeCode=\"PERF\"]???" }, { "identity": "w5", "map": "who.actor" } ] }, { "path": "Media.view", "short": "Imaging view, e.g. Lateral or Antero-posterior", "definition": "The name of the imaging view e.g. Lateral or Antero-posterior (AP).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "example", "description": "Imaging view (projection) used when collecting an image", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/media-view" } }, "mapping": [ { "identity": "rim", "map": "DiagnosticImage.subjectOrientationCode" }, { "identity": "w5", "map": "class" } ] }, { "path": "Media.deviceName", "short": "Name of the device/manufacturer", "definition": "The name of the device / manufacturer of the device that was used to make the recording.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "0008,0070" }, { "identity": "rim", "map": ".participation[typeCode=\"DEV\"].role.player.Entity[classCode=\"DEV\"].name" } ] }, { "path": "Media.height", "short": "Height of the image in pixels (photo/video)", "definition": "Height of the image in pixels (photo/video).", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "condition": [ "mda-1" ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "0028,0010" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value" } ] }, { "path": "Media.width", "short": "Width of the image in pixels (photo/video)", "definition": "Width of the image in pixels (photo/video).", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "condition": [ "mda-2" ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "0028,0011" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value" } ] }, { "path": "Media.frames", "short": "Number of frames if > 1 (photo)", "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.", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "defaultValueInteger": 1, "condition": [ "mda-3" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value" } ] }, { "path": "Media.duration", "short": "Length in seconds (audio / video)", "definition": "The duration of the recording in seconds - for audio and video.", "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ], "condition": [ "mda-4" ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "~0028,0002" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value" } ] }, { "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.", "path": "Media.content", "short": "Actual Media - reference or data", "definition": "The actual content of the media - inline or by direct reference to the media source file.", "min": 1, "max": "1", "type": [ { "code": "Attachment" } ], "mapping": [ { "identity": "rim", "map": ".text" } ] } ] }, "differential": { "element": [ { "path": "Media", "short": "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference", "definition": "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.", "min": 0, "max": "*", "type": [ { "code": "DomainResource" } ], "constraint": [ { "key": "mda-1", "severity": "error", "human": "Height can only be used for a photo or video", "xpath": "not(f:type/@value='audio') or not(f:height)" }, { "key": "mda-2", "severity": "error", "human": "Width can only be used for a photo or video", "xpath": "not(f:type/@value='audio') or not(f:width)" }, { "key": "mda-4", "severity": "error", "human": "Duration can only be used for an audio or a video", "xpath": "not(f:type/@value='photo') or not(f:duration)" }, { "key": "mda-3", "severity": "error", "human": "Frames can only be used for a photo", "xpath": "(f:type/@value='photo') or not(f:frames)" } ], "mapping": [ { "identity": "rim", "map": "Act[classCode=\"DGIMG\", moodCode=\"EVN\"]" }, { "identity": "w5", "map": "infrastructure.structure" } ] }, { "path": "Media.type", "short": "photo | video | audio", "definition": "Whether the media is a photo (still image), an audio recording, or a video recording.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "Whether the Media is a photo, video, or audio", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/digital-media-type" } }, "mapping": [ { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "class" } ] }, { "path": "Media.subtype", "short": "The type of acquisition equipment/process", "definition": "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": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "example", "description": "Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/digital-media-subtype" } }, "mapping": [ { "identity": "dicom", "map": "0008,0060 | 0008,1032" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code" }, { "identity": "w5", "map": "class" } ] }, { "comments": "The identifier label and use can be used to determine what kind of identifier it is.", "path": "Media.identifier", "short": "Identifier(s) for the image", "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.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "0008,0018 | ~0008,0050 | 0020,000D | 0020,000E" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] }, { "path": "Media.subject", "short": "Who/What this Media is a record of", "definition": "Who/What this Media is a record of.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Specimen" } ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "~0010,0020" }, { "identity": "rim", "map": ".participation[typeCode=\"SUBJ\"]???" }, { "identity": "w5", "map": "who.focus" } ] }, { "path": "Media.operator", "short": "The person who generated the image", "definition": "The person who administered the collection of the image.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner" } ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "0008,1060?" }, { "identity": "rim", "map": ".participation[typeCode=\"PERF\"]???" }, { "identity": "w5", "map": "who.actor" } ] }, { "path": "Media.view", "short": "Imaging view, e.g. Lateral or Antero-posterior", "definition": "The name of the imaging view e.g. Lateral or Antero-posterior (AP).", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "example", "description": "Imaging view (projection) used when collecting an image", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/media-view" } }, "mapping": [ { "identity": "rim", "map": "DiagnosticImage.subjectOrientationCode" }, { "identity": "w5", "map": "class" } ] }, { "path": "Media.deviceName", "short": "Name of the device/manufacturer", "definition": "The name of the device / manufacturer of the device that was used to make the recording.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "0008,0070" }, { "identity": "rim", "map": ".participation[typeCode=\"DEV\"].role.player.Entity[classCode=\"DEV\"].name" } ] }, { "path": "Media.height", "short": "Height of the image in pixels (photo/video)", "definition": "Height of the image in pixels (photo/video).", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "condition": [ "mda-1" ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "0028,0010" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value" } ] }, { "path": "Media.width", "short": "Width of the image in pixels (photo/video)", "definition": "Width of the image in pixels (photo/video).", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "condition": [ "mda-2" ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "0028,0011" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value" } ] }, { "path": "Media.frames", "short": "Number of frames if > 1 (photo)", "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.", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "defaultValueInteger": 1, "condition": [ "mda-3" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value" } ] }, { "path": "Media.duration", "short": "Length in seconds (audio / video)", "definition": "The duration of the recording in seconds - for audio and video.", "min": 0, "max": "1", "type": [ { "code": "unsignedInt" } ], "condition": [ "mda-4" ], "isSummary": true, "mapping": [ { "identity": "dicom", "map": "~0028,0002" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"\"].value" } ] }, { "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.", "path": "Media.content", "short": "Actual Media - reference or data", "definition": "The actual content of the media - inline or by direct reference to the media source file.", "min": 1, "max": "1", "type": [ { "code": "Attachment" } ], "mapping": [ { "identity": "rim", "map": ".text" } ] } ] } }