CH RAD-Order (R4)
1.0.0 - STU 1
This page is part of the CH RAD-Order (R4) (v1.0.0: STU 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Active as of 2022-02-22 |
Definitions for the ch-rad-order-media resource profile.
1. Media | |
Definition | 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 | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) |
2. Media.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | string |
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. |
3. Media.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
4. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
5. Media.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | The codes SHOULD be taken from CommonLanguages Max Binding: AllLanguages A human language. |
Type | code |
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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
6. Media.text | |
Definition | A human-readable narrative that contains a summary of the resource and can 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. |
Control | 0..1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
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 information is added later. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. 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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
8. Media.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
9. Media.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
10. 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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Comments | The identifier label and use can be used to determine what kind of identifier it is. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
11. Media.basedOn | |
Definition | A procedure that is fulfilled in whole or in part by the creation of this media. |
Control | 0..* |
Type | Reference(ServiceRequest | CarePlan) |
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
Alternate Names | fulfills |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
12. Media.partOf | |
Definition | A larger event of which this particular event is a component or step. |
Control | 0..* |
Type | Reference(Resource) |
Requirements | E.g. Drug administration as part of a procedure, procedure as part of observation, etc. |
Alternate Names | container |
Comments | Not to be used to link an event to an Encounter - use Media.encounter for that. [The allowed reference resources may be adjusted as appropriate for the event resource]. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
13. Media.status | |
Definition | The current state of the {{title}}. |
Control | 1..1 |
Binding | The codes SHALL be taken from EventStatus Codes identifying the lifecycle stage of an event. |
Type | code |
Is Modifier | true |
Must Support | true |
Comments | A nominal state-transition diagram can be found in the [[event.html#statemachine | Event pattern]] documentation 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. Media.type | |
Definition | A code that classifies whether the media is an image, video or audio recording or some other media category. |
Control | 0..1 |
Binding | The codes SHALL be taken from MediaType; other codes may be used where these codes are not suitable Codes for high level media categories. |
Type | CodeableConcept |
Requirements | Used for filtering what observations are retrieved and displayed. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
15. Media.modality | |
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. |
Control | 0..1 |
Binding | For example codes, see MediaModality Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it. |
Type | CodeableConcept |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
16. Media.view | |
Definition | The name of the imaging view e.g. Lateral or Antero-posterior (AP). |
Control | 0..1 |
Binding | For example codes, see MediaCollectionView/Projection Imaging view (projection) used when collecting an image. |
Type | CodeableConcept |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
17. Media.subject | |
Definition | Who/What this Media is a record of. |
Control | 0..1 |
Type | Reference(Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
18. Media.encounter | |
Definition | The encounter that establishes the context for this media. |
Control | 0..1 |
Type | Reference(Encounter) |
Requirements | Links the Media to the Encounter context. |
Alternate Names | context |
Comments | This will typically be the encounter the media occurred within. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
19. Media.created[x] | |
Definition | The date and time(s) at which the media was collected. |
Control | 0..1 |
Type | Choice of: dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Alternate Names | timing |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
20. Media.issued | |
Definition | The date and time this version of the media was made available to providers, typically after having been reviewed. |
Control | 0..1 |
Type | instant |
Comments | It may be the same as the |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. Media.operator | |
Definition | The person who administered the collection of the image. |
Control | 0..1 |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
22. Media.reasonCode | |
Definition | Describes why the event occurred in coded or textual form. |
Control | 0..* |
Binding | For example codes, see ProcedureReasonCodes The reason for the media. |
Type | CodeableConcept |
Comments | Textual reasons can be captured using reasonCode.text. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
23. Media.bodySite | |
Definition | Indicates the site on the subject's body where the observation was made (i.e. the target site). |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTBodyStructures Codes describing anatomical locations. May include laterality. |
Type | CodeableConcept |
Comments | Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. 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 bodySite. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. Media.deviceName | |
Definition | The name of the device / manufacturer of the device that was used to make the recording. |
Control | 0..1 |
Type | string |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. Media.device | |
Definition | The device used to collect the media. |
Control | 0..1 |
Type | Reference(Device | DeviceMetric | Device) |
Comments | An extension should be used if further typing of the device is needed. Secondary devices used to support collecting a media can be represented using either extension or through the Observation.related element. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. Media.height | |
Definition | Height of the image in pixels (photo/video). |
Control | 0..1 |
Type | positiveInt |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
27. Media.width | |
Definition | Width of the image in pixels (photo/video). |
Control | 0..1 |
Type | positiveInt |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
28. 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. |
Control | 0..1 |
Type | positiveInt |
Comments | if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
29. Media.duration | |
Definition | The duration of the recording in seconds - for audio and video. |
Control | 0..1 |
Type | decimal |
Comments | The duration might differ from occurrencePeriod if recording was paused. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
30. Media.content | |
Definition | The actual content of the media - inline or by direct reference to the media source file. |
Control | 1..1 |
Type | Attachment |
Must Support | true |
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 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
31. Media.content.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
32. Media.content.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Media.content.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
33. Media.content.contentType | |
Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. |
Control | 0..1 |
Binding | The codes SHALL be taken from Mime Types The mime type of an attachment. Any valid mime type is allowed. |
Type | code |
Must Support | true |
Requirements | Processors of the data need to be able to know how to interpret the data. |
Example | General:text/plain; charset=UTF-8, image/png |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
34. Media.content.language | |
Definition | The human language of the content. The value can be any valid value according to BCP 47. |
Control | 0..1 |
Binding | The codes SHOULD be taken from CommonLanguages Max Binding: AllLanguages A human language. |
Type | code |
Requirements | Users need to be able to choose between the languages in a set of attachments. |
Example | General:en-AU |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
35. Media.content.data | |
Definition | The actual data of the attachment - a sequence of bytes, base64 encoded. |
Control | 0..1 |
Type | base64Binary |
Must Support | true |
Requirements | The data needs to able to be transmitted inline. |
Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
36. Media.content.url | |
Definition | A location where the data can be accessed. |
Control | 0..1 |
Type | url |
Requirements | The data needs to be transmitted by reference. |
Comments | If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. |
Example | General:http://www.acme.com/logo-small.png |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
37. Media.content.size | |
Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). |
Control | 0..1 |
Type | unsignedInt |
Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. |
Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
38. Media.content.hash | |
Definition | The calculated hash of the data using SHA-1. Represented using base64. |
Control | 0..1 |
Type | base64Binary |
Requirements | Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). |
Comments | The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
39. Media.content.title | |
Definition | A label or set of text to display in place of the data. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. |
Example | General:Official Corporate Logo |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
40. Media.content.creation | |
Definition | The date that the attachment was first created. |
Control | 0..1 |
Type | dateTime |
Requirements | This is often tracked as an integrity issue for use of the attachment. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
41. Media.note | |
Definition | Comments made about the media by the performer, subject or other participants. |
Control | 0..* |
Type | Annotation |
Comments | Not to be used for observations, conclusions, etc. Instead use an Observation based on the Media/ImagingStudy resource. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |