eHealth Infrastructure - Local Development build (v2.6.0). See the Directory of published versions
Active as of 2023-01-12 |
Definitions for the ehealth-media resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Media | |
2. Media.extension | |
Control | 20..* |
Slicing | This element introduces a set of slices on Media.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
3. Media.extension:episodeOfCare | |
SliceName | episodeOfCare |
Control | 1..1 |
Type | Extension(episodeOfCare) (Extension Type: Reference(EpisodeOfCare)) |
4. Media.extension:quality | |
SliceName | quality |
Control | 0..* |
Type | Extension(ehealth-quality) (Complex Extension) |
5. Media.extension:resolvedTiming | |
SliceName | resolvedTiming |
Control | 1..1 |
Type | Extension(ehealth-resolved-timing) (Complex Extension) |
6. Media.basedOn | |
Control | 10..1* |
Type | Reference(ehealth-servicerequest|ServiceRequest|CarePlan) : {r} |
7. Media.subject | |
Control | 10..1 |
Type | Reference(ehealth-patient|ehealth-practitioner|Group|ehealth-device|Specimen|Patient|Practitioner|PractitionerRole|Device|Location) |
8. Media.subject.reference | |
Control | 1..? |
Type | string |
9. Media.created[x] | |
Control | 10..1 |
[x] Note | See Choice of Data Types for further information about how to use [x] |
10. Media.operator | |
Type | Reference(ehealth-practitioner|Practitioner|PractitionerRole|Organization|CareTeam|Patient|Device|RelatedPerson) : {r} |
11. Media.device | |
Type | Reference(ehealth-device|ehealth-devicemetric|Device|DeviceMetric|Device) : {r} |
12. Media.note | |
Control | 0..? |
13. Media.note.authorReference | |
Control | 0..1 |
Type | Reference(ehealth-practitioner|ehealth-patient|ehealth-relatedperson) |
14. Media.note.authorString | |
Control | 0..1 |
Type | string |
Guidance on how to interpret the contents of this table can be found here.
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..* |
Summary | false |
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.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 |
Summary | 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())) |
3. Media.extension | |
Definition | An Extension 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 | 20..* |
Type | Extension |
Summary | false |
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.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. Media.extension:episodeOfCare | |
SliceName | episodeOfCare |
Definition | The episode(s) of care that establishes the context for this {{title}}. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(episodeOfCare) (Extension Type: Reference(EpisodeOfCare)) |
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()) |
5. Media.extension:quality | |
SliceName | quality |
Definition | Minimum required or actually assessed quality values. The qualityType element states the type of quality. For different values of qualityType the required or assessed quality value (qualityCode) must be from different value sets. The relation between qualityType and allowed value sets are defined in the definition of value set http://ehealth.sundhed.dk/vs/quality-types. 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 | This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-quality) (Complex Extension) |
Invariants | Defined on this element ele-1: (: ) ext-1: (: ) |
6. Media.extension:resolvedTiming | |
SliceName | resolvedTiming |
Definition | Resolved timing reflects whether a measurement (Observation, QuestionnaireResponse or Media) has been performed ad-hoc or as fulfillment of a measurement regime time slot in which case the extent of the time slot is given by start and end. If the measurement regime has a form for which a time slot cannot be resolved or determining is/was not supported, the type unresolved is used. 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 | 10..1* This element is affected by the following invariants: ele-1 |
Type | Extension(ehealth-resolved-timing) (Complex Extension) |
Invariants | Defined on this element ele-1: (: ) ext-1: (: ) |
7. 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 |
Summary | false |
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()) |
8. Media.basedOn | |
Definition | A procedure that is fulfilled in whole or in part by the creation of this media. |
Control | 10..1* |
Type | Reference(ehealth-servicerequest|ServiceRequest|CarePlan) : {r} |
Summary | true |
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())) |
9. 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 |
Summary | 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())) |
10. Media.subject | |
Definition | Who/What this Media is a record of. |
Control | 10..1 |
Type | Reference(ehealth-patient|ehealth-practitioner|Group|ehealth-device|Specimen|Patient|Practitioner|PractitionerRole|Device|Location) |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
11. 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. |
Control | 10..1 This element is affected by the following invariants: ref-1 |
Type | string |
Summary | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
12. Media.created[x] | |
Definition | The date and time(s) at which the media was collected. |
Control | 10..1 |
Type | Choice of: dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
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())) |
13. Media.operator | |
Definition | The person who administered the collection of the image. |
Control | 0..1 |
Type | Reference(ehealth-practitioner|Practitioner|PractitionerRole|Organization|CareTeam|Patient|Device|RelatedPerson) : {r} |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. Media.device | |
Definition | The device used to collect the media. |
Control | 0..1 |
Type | Reference(ehealth-device|ehealth-devicemetric|Device|DeviceMetric|Device) : {r} |
Summary | true |
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())) |
15. Media.content | |
Definition | The actual content of the media - inline or by direct reference to the media source file. |
Control | 1..1 |
Type | Attachment |
Summary | 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())) |
Guidance on how to interpret the contents of this table can be found here.
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..* | ||||
Summary | false | ||||
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 | id | ||||
Summary | true | ||||
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 | ||||
Summary | true | ||||
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 | ||||
Summary | 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
A human language
| ||||
Type | code | ||||
Summary | false | ||||
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 | ||||
Summary | false | ||||
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 | ||||
Summary | false | ||||
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 | An Extension | ||||
Control | 2..* | ||||
Type | Extension | ||||
Summary | false | ||||
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.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
9. Media.extension:episodeOfCare | |||||
SliceName | episodeOfCare | ||||
Definition | The episode(s) of care that establishes the context for this {{title}}. | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(episodeOfCare) (Extension Type: Reference(EpisodeOfCare)) | ||||
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.extension:quality | |||||
SliceName | quality | ||||
Definition | Minimum required or actually assessed quality values. The qualityType element states the type of quality. For different values of qualityType the required or assessed quality value (qualityCode) must be from different value sets. The relation between qualityType and allowed value sets are defined in the definition of value set http://ehealth.sundhed.dk/vs/quality-types. | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-quality) (Complex Extension) | ||||
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()) | ||||
11. Media.extension:resolvedTiming | |||||
SliceName | resolvedTiming | ||||
Definition | Resolved timing reflects whether a measurement (Observation, QuestionnaireResponse or Media) has been performed ad-hoc or as fulfillment of a measurement regime time slot in which case the extent of the time slot is given by start and end. If the measurement regime has a form for which a time slot cannot be resolved or determining is/was not supported, the type unresolved is used. | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ehealth-resolved-timing) (Complex Extension) | ||||
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()) | ||||
12. 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 | ||||
Summary | false | ||||
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()) | ||||
13. 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 | ||||
Summary | true | ||||
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())) | ||||
14. Media.basedOn | |||||
Definition | A procedure that is fulfilled in whole or in part by the creation of this media. | ||||
Control | 1..1 | ||||
Type | Reference(ehealth-servicerequest) : {r} | ||||
Summary | true | ||||
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())) | ||||
15. Media.partOf | |||||
Definition | A larger event of which this particular event is a component or step. | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
Summary | true | ||||
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())) | ||||
16. 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 | ||||
Summary | 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())) | ||||
17. 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 | ||||
Summary | true | ||||
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())) | ||||
18. 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 | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
19. 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 | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
20. Media.subject | |||||
Definition | Who/What this Media is a record of. | ||||
Control | 1..1 | ||||
Type | Reference(ehealth-patient|ehealth-practitioner|Group|ehealth-device|Specimen) | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
21. 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. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
22. Media.subject.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 | ||||
Summary | false | ||||
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.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
23. 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. | ||||
Control | 1..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
24. Media.subject.type | |||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model) | ||||
Type | uri | ||||
Summary | true | ||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
25. Media.subject.identifier | |||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
26. Media.subject.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
27. Media.encounter | |||||
Definition | The encounter that establishes the context for this media. | ||||
Control | 0..1 | ||||
Type | Reference(Encounter) | ||||
Summary | true | ||||
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())) | ||||
28. Media.created[x] | |||||
Definition | The date and time(s) at which the media was collected. | ||||
Control | 1..1 | ||||
Type | Choice of: dateTime, Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
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())) | ||||
29. 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 | ||||
Summary | true | ||||
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())) | ||||
30. Media.operator | |||||
Definition | The person who administered the collection of the image. | ||||
Control | 0..1 | ||||
Type | Reference(ehealth-practitioner) : {r} | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
31. 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 | ||||
Summary | true | ||||
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())) | ||||
32. 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 | ||||
Summary | true | ||||
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())) | ||||
33. Media.deviceName | |||||
Definition | The name of the device / manufacturer of the device that was used to make the recording. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
34. Media.device | |||||
Definition | The device used to collect the media. | ||||
Control | 0..1 | ||||
Type | Reference(ehealth-device|ehealth-devicemetric) : {r} | ||||
Summary | true | ||||
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())) | ||||
35. Media.height | |||||
Definition | Height of the image in pixels (photo/video). | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
36. Media.width | |||||
Definition | Width of the image in pixels (photo/video). | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
37. 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 | ||||
Summary | true | ||||
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())) | ||||
38. Media.duration | |||||
Definition | The duration of the recording in seconds - for audio and video. | ||||
Control | 0..1 | ||||
Type | decimal | ||||
Summary | true | ||||
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())) | ||||
39. Media.content | |||||
Definition | The actual content of the media - inline or by direct reference to the media source file. | ||||
Control | 1..1 | ||||
Type | Attachment | ||||
Summary | 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())) | ||||
40. Media.note | |||||
Definition | Comments made about the media by the performer, subject or other participants. | ||||
Control | 0..* | ||||
Type | Annotation | ||||
Summary | false | ||||
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())) | ||||
41. Media.note.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 | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
42. Media.note.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 | ||||
Summary | false | ||||
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.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
43. Media.note.author[x] | |||||
Definition | The individual responsible for making the annotation. | ||||
Control | 0..1 | ||||
Type | Choice of: Reference(Practitioner|Patient|RelatedPerson|Organization), string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Comments | Organization is used when there's no need for specific attribution as to who made the comment. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Media.note.author[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
44. Media.note.author[x]:authorReference | |||||
SliceName | authorReference | ||||
Definition | The individual responsible for making the annotation. | ||||
Control | 0..1 | ||||
Type | Reference(ehealth-practitioner|ehealth-patient|ehealth-relatedperson) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Comments | Organization is used when there's no need for specific attribution as to who made the comment. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
45. Media.note.author[x]:authorString | |||||
SliceName | authorString | ||||
Definition | The individual responsible for making the annotation. | ||||
Control | 0..1 | ||||
Type | string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Comments | Organization is used when there's no need for specific attribution as to who made the comment. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
46. Media.note.time | |||||
Definition | Indicates when this particular annotation was made. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
47. Media.note.text | |||||
Definition | The text of the annotation in markdown format. | ||||
Control | 1..1 | ||||
Type | markdown | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |