Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-Media resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Media | |
| Definition | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. |
| Short | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference |
| Control | 0..* |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())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')dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) 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') |
| 2. 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. |
| Short | A set of rules under which this content was created |
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. Media.extension | |
| Definition | An Extension 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. |
| Short | ExtensionAdditional Content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Media.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Media.extension:partOf | |
| Slice Name | partOf |
| Definition | R4: |
| Short | R4: Part of referenced event (new) |
| Comments | Element [The allowed reference resources may be adjusted as appropriate for the event resource]. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Part of referenced event (new)) (Extension Type: Reference(Cross-version Profile for R4.Resource for use in FHIR STU3, Resource)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. Media.extension:issued | |
| Slice Name | issued |
| Definition | R4: |
| Short | R4: Date/Time this version was made available (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Date/Time this version was made available (new)) (Extension Type: instant) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. Media.extension:deviceName | |
| Slice Name | deviceName |
| Definition | R4: |
| Short | R4: Name of the device/manufacturer (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Name of the device/manufacturer (new)) (Extension Type: string) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. Media.modifierExtension | |
| Definition | An Extension 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. |
| Short | ExtensionExtensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Media.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 14. Media.modifierExtension:status | |
| Slice Name | status |
| Definition | R4: |
| Short | R4: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown (new) |
| Comments | Element Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown (new)) (Extension Type: code) |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 16. Media.type | |
| Definition | Whether the media is a photo (still image), an audio recording, or a video recording. |
| Short | photo | video | audio |
| Control | 1..1 |
| Binding | The codes SHALL be taken from DigitalMediaTypehttp://hl7.org/fhir/ValueSet/digital-media-type|3.0.2 (required to http://hl7.org/fhir/ValueSet/digital-media-type|3.0.2)Whether the media is a photo, video, or audio |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 18. Media.type.extension | |
| Definition | An Extension 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. |
| Short | ExtensionAdditional Content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Media.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. Media.type.extension:type | |
| Slice Name | type |
| Definition | R4: |
| Short | R4: Classification of media as image, video, or audio additional types |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Classification of media as image, video, or audio additional types) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 22. Media.content | |
| Definition | The actual content of the media - inline or by direct reference to the media source file. |
| Short | Actual Media - reference or data |
| 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. |
| Control | 1..1 |
| Type | Attachment |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Media | |
| 2. Media.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Media.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Media.extension:partOf | |
| Slice Name | partOf |
| Definition | R4: |
| Short | R4: Part of referenced event (new) |
| Comments | Element [The allowed reference resources may be adjusted as appropriate for the event resource]. |
| Control | 0..* |
| Type | Extension(R4: Part of referenced event (new)) (Extension Type: Reference(Cross-version Profile for R4.Resource for use in FHIR STU3, Resource)) |
| 6. Media.extension:issued | |
| Slice Name | issued |
| Definition | R4: |
| Short | R4: Date/Time this version was made available (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Date/Time this version was made available (new)) (Extension Type: instant) |
| 8. Media.extension:deviceName | |
| Slice Name | deviceName |
| Definition | R4: |
| Short | R4: Name of the device/manufacturer (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Name of the device/manufacturer (new)) (Extension Type: string) |
| 10. Media.modifierExtension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Media.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Media.modifierExtension:status | |
| Slice Name | status |
| Definition | R4: |
| Short | R4: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown (new) |
| Comments | Element Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. |
| Control | 1..1 |
| Type | Extension(R4: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown (new)) (Extension Type: code) |
| 14. Media.basedOn | |
| 16. Media.basedOn.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Media.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 18. Media.basedOn.extension:basedOn | |
| Slice Name | basedOn |
| Definition | R4: |
| Short | R4: basedOn additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 20. Media.type | |
| 22. Media.type.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Media.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 24. Media.type.extension:type | |
| Slice Name | type |
| Definition | R4: |
| Short | R4: Classification of media as image, video, or audio additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Classification of media as image, video, or audio additional types) (Extension Type: CodeableConcept) |
| 26. Media.subject | |
| 28. Media.subject.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Media.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 30. Media.subject.extension:subject | |
| Slice Name | subject |
| Definition | R4: |
| Short | R4: subject |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 32. Media.operator | |
| 34. Media.operator.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Media.operator.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 36. Media.operator.extension:operator | |
| Slice Name | operator |
| Definition | R4: |
| Short | R4: operator |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 38. Media.duration | |
| 40. Media.duration.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Media.duration.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 42. Media.duration.extension:duration | |
| Slice Name | duration |
| Definition | R4: |
| Short | R4: duration additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: duration additional types) (Extension Type: decimal) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Media | |||||
| Definition | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. | ||||
| Short | A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference | ||||
| Control | 0..* | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())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') | ||||
| 2. Media.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. 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. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 6. 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. | ||||
| Short | A set of rules under which this content was created | ||||
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 8. Media.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| 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). | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 10. 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. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 12. 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. | ||||
| Short | Contained, inline 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. Media.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Media.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. Media.extension:partOf | |||||
| Slice Name | partOf | ||||
| Definition | R4: | ||||
| Short | R4: Part of referenced event (new) | ||||
| Comments | Element [The allowed reference resources may be adjusted as appropriate for the event resource]. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Part of referenced event (new)) (Extension Type: Reference(Cross-version Profile for R4.Resource for use in FHIR STU3, Resource)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. Media.extension:issued | |||||
| Slice Name | issued | ||||
| Definition | R4: | ||||
| Short | R4: Date/Time this version was made available (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Date/Time this version was made available (new)) (Extension Type: instant) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 20. Media.extension:deviceName | |||||
| Slice Name | deviceName | ||||
| Definition | R4: | ||||
| Short | R4: Name of the device/manufacturer (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Name of the device/manufacturer (new)) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 22. Media.modifierExtension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Slicing | This element introduces a set of slices on Media.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 24. Media.modifierExtension:status | |||||
| Slice Name | status | ||||
| Definition | R4: | ||||
| Short | R4: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown (new) | ||||
| Comments | Element Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown (new)) (Extension Type: code) | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 26. 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. | ||||
| Short | Identifier(s) for the image | ||||
| Comments | The identifier label and use can be used to determine what kind of identifier it is. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 28. Media.basedOn | |||||
| Definition | A procedure that is fulfilled in whole or in part by the creation of this media. | ||||
| Short | Procedure that caused this media to be created | ||||
| Control | 0..* | ||||
| Type | Reference(ProcedureRequest) | ||||
| Summary | true | ||||
| Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. | ||||
| Alternate Names | fulfills | ||||
| 30. Media.basedOn.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 32. Media.basedOn.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Media.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 34. Media.basedOn.extension:basedOn | |||||
| Slice Name | basedOn | ||||
| Definition | R4: | ||||
| Short | R4: basedOn additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 36. Media.basedOn.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 38. Media.basedOn.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 40. Media.basedOn.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 42. Media.type | |||||
| Definition | Whether the media is a photo (still image), an audio recording, or a video recording. | ||||
| Short | photo | video | audio | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from DigitalMediaType (required to http://hl7.org/fhir/ValueSet/digital-media-type|3.0.2)Whether the media is a photo, video, or audio | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 44. Media.type.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 46. Media.type.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Media.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 48. Media.type.extension:type | |||||
| Slice Name | type | ||||
| Definition | R4: | ||||
| Short | R4: Classification of media as image, video, or audio additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Classification of media as image, video, or audio additional types) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 50. Media.type.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 52. Media.subtype | |||||
| 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. | ||||
| Short | The type of acquisition equipment/process | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Media SubType (example to http://hl7.org/fhir/ValueSet/digital-media-subtype|3.0.2)Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 54. Media.view | |||||
| Definition | The name of the imaging view e.g. Lateral or Antero-posterior (AP). | ||||
| Short | Imaging view, e.g. Lateral or Antero-posterior | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Media Collection View/Projection (example to http://hl7.org/fhir/ValueSet/media-view|3.0.2)Imaging view (projection) used when collecting an image | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 56. Media.subject | |||||
| Definition | Who/What this Media is a record of. | ||||
| Short | Who/What this Media is a record of | ||||
| Control | 0..1 | ||||
| Type | Reference(Patient, Practitioner, Group, Device, Specimen) | ||||
| Summary | true | ||||
| 58. Media.subject.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 60. Media.subject.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Media.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 62. Media.subject.extension:subject | |||||
| Slice Name | subject | ||||
| Definition | R4: | ||||
| Short | R4: subject | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 64. Media.subject.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 66. Media.subject.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 68. Media.subject.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 70. Media.context | |||||
| Definition | The encounter or episode of care that establishes the context for this media. | ||||
| Short | Encounter / Episode associated with media | ||||
| Comments | This will typically be the encounter the media occurred within. | ||||
| Control | 0..1 | ||||
| Type | Reference(Encounter, EpisodeOfCare) | ||||
| Summary | true | ||||
| Requirements | Links the media to the Encounter context. | ||||
| Alternate Names | encounter | ||||
| 72. Media.occurrence[x] | |||||
| Definition | The date and time(s) at which the media was collected. | ||||
| Short | When Media was collected | ||||
| Control | 0..1 | ||||
| Type | Choice of: dateTime, Period | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Alternate Names | timing | ||||
| 74. Media.operator | |||||
| Definition | The person who administered the collection of the image. | ||||
| Short | The person who generated the image | ||||
| Control | 0..1 | ||||
| Type | Reference(Practitioner) | ||||
| Summary | true | ||||
| 76. Media.operator.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 78. Media.operator.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Media.operator.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 80. Media.operator.extension:operator | |||||
| Slice Name | operator | ||||
| Definition | R4: | ||||
| Short | R4: operator | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 82. Media.operator.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 84. Media.operator.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 86. Media.operator.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 88. Media.reasonCode | |||||
| Definition | Describes why the event occurred in coded or textual form. | ||||
| Short | Why was event performed? | ||||
| Comments | Textual reasons can be caprued using reasonCode.text. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see Procedure Reason Codes (example to http://hl7.org/fhir/ValueSet/procedure-reason|3.0.2)The reason for the media | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 90. Media.bodySite | |||||
| Definition | Indicates the site on the subject's body where the media was collected (i.e. the target site). | ||||
| Short | Body part in media | ||||
| Comments | If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use The standard extension body-site-instance. | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see SNOMED CT Body Structures (example to http://hl7.org/fhir/ValueSet/body-site|3.0.2)Codes describing anatomical locations. May include laterality. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 92. Media.device | |||||
| Definition | The device used to collect the media. | ||||
| Short | Observing Device | ||||
| Comments | An extension should be used if further typing of the device is needed. Scondary devices used to support collecting a media can be represented using either extension or through the Observation.related element. | ||||
| Control | 0..1 | ||||
| Type | Reference(Device, DeviceMetric) | ||||
| Summary | true | ||||
| 94. Media.height | |||||
| Definition | Height of the image in pixels (photo/video). | ||||
| Short | Height of the image in pixels (photo/video) | ||||
| Control | 0..1 This element is affected by the following invariants: mda-1 | ||||
| Type | positiveInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 96. Media.width | |||||
| Definition | Width of the image in pixels (photo/video). | ||||
| Short | Width of the image in pixels (photo/video) | ||||
| Control | 0..1 This element is affected by the following invariants: mda-2 | ||||
| Type | positiveInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 98. 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. | ||||
| Short | Number of frames if > 1 (photo) | ||||
| Control | 0..1 This element is affected by the following invariants: mda-3 | ||||
| Type | positiveInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Default Value | 1 | ||||
| 100. Media.duration | |||||
| Definition | The duration of the recording in seconds - for audio and video. | ||||
| Short | Length in seconds (audio / video) | ||||
| Comments | The duration might differ from occurrencePeriod if recording was paused. | ||||
| Control | 0..1 This element is affected by the following invariants: mda-4 | ||||
| Type | unsignedInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 102. Media.duration.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 104. Media.duration.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Media.duration.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 106. Media.duration.extension:duration | |||||
| Slice Name | duration | ||||
| Definition | R4: | ||||
| Short | R4: duration additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: duration additional types) (Extension Type: decimal) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 108. Media.duration.value | |||||
| Definition | Primitive value for unsignedInt | ||||
| Short | Primitive value for unsignedInt | ||||
| Control | 0..1 | ||||
| Type | unsignedInt | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 110. Media.content | |||||
| Definition | The actual content of the media - inline or by direct reference to the media source file. | ||||
| Short | Actual Media - reference or data | ||||
| 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. | ||||
| Control | 1..1 | ||||
| Type | Attachment | ||||
| 112. Media.note | |||||
| Definition | Comments made about the media by the performer, subject or other participants. | ||||
| Short | Comments made about the media | ||||
| Control | 0..* | ||||
| Type | Annotation | ||||