eHealth Infrastructure (v2020.8)
A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
In scope of the eHealth infrastructure Media resources are used with measurements, so that submitted measurement bundles can consist of e.g. Observations, QuestionnaireResponses, and Media. The actual media data can be contained as a payload of the Media resource (using the content.data element) or be referenced from the Media resource (using the content.url element).
Media are immutable. Once they are created as a FHIR resource they cannot be updated or deleted, but they can be read based on id or searched based on certain elements.
It is possible to search for Media based on:
At least one of “subject” and “context” must be provided. “period” searches on range of “occurence”.
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-media
This profile builds on Media.
This profile was published on Thu Jan 07 13:26:31 UTC 2021 as a draft by ehealth.sundhed.dk.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Media
Summary
Mandatory: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. | |
  extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 ehealth-quality | 0..* | (Complex) | Minimum requirements for qualities URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality | |
 basedOn | 1..1 | Reference(eHealth ProcedureRequest) {r} | Procedure that caused this media to be created | |
| subject | 1..1 | Reference(eHealth Patient | eHealth Practitioner | Group | eHealth Device | Specimen) {r} | Who/What this Media is a record of | |
   reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| context | 1..1 | Reference(Encounter | eHealth EpisodeOfCare) {r} | Encounter / Episode associated with media | |
| occurrence[x] | 1..1 | dateTime, Period | When Media was collected | |
| operator | 0..1 | Reference(eHealth Practitioner) {r} | The person who generated the image | |
| device | 0..1 | Reference(eHealth Device | eHealth DeviceMetric) {r} | Observing Device | |
| note | ||||
  author[x] | 0..1 | Individual responsible for the annotation | ||
| authorReference | Reference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson) | |||
 authorString | string | |||
| Documentation for this format | ||||
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | I | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. |
| id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ehealth-quality | 0..* | (Complex) | Minimum requirements for qualities URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Identifier(s) for the image |
| basedOn | Σ | 1..1 | Reference(eHealth ProcedureRequest) {r} | Procedure that caused this media to be created |
| type | Σ | 1..1 | code | photo | video | audio Binding: DigitalMediaType (required): Whether the media is a photo, video, or audio |
| subtype | Σ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: Media SubType (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it |
| view | Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: Media Collection View/Projection (example): Imaging view (projection) used when collecting an image |
| subject | Σ | 1..1 | Reference(eHealth Patient | eHealth Practitioner | Group | eHealth Device | Specimen) {r} | Who/What this Media is a record of |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| context | Σ | 1..1 | Reference(Encounter | eHealth EpisodeOfCare) {r} | Encounter / Episode associated with media |
| occurrence[x] | Σ | 1..1 | When Media was collected | |
| occurrenceDateTime | dateTime | |||
| occurrencePeriod | Period | |||
| operator | Σ | 0..1 | Reference(eHealth Practitioner) {r} | The person who generated the image |
| reasonCode | Σ | 0..* | CodeableConcept | Why was event performed? Binding: Procedure Reason Codes (example): The reason for the media |
| bodySite | Σ | 0..1 | CodeableConcept | Body part in media Binding: SNOMED CT Body Structures (example): Codes describing anatomical locations. May include laterality. |
| device | Σ | 0..1 | Reference(eHealth Device | eHealth DeviceMetric) {r} | Observing Device |
| height | ΣI | 0..1 | positiveInt | Height of the image in pixels (photo/video) |
| width | ΣI | 0..1 | positiveInt | Width of the image in pixels (photo/video) |
| frames | ΣI | 0..1 | positiveInt | Number of frames if > 1 (photo) |
| duration | ΣI | 0..1 | unsignedInt | Length in seconds (audio / video) |
| content | 1..1 | Attachment | Actual Media - reference or data | |
| note | 0..* | Annotation | Comments made about the media | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson) | |||
| authorString | string | |||
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | 1..1 | string | The annotation - text content | |
| Documentation for this format | ||||
This structure is derived from Media
Summary
Mandatory: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Media
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ehealth-quality | 0..* | (Complex) | Minimum requirements for qualities URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality | |
| basedOn | 1..1 | Reference(eHealth ProcedureRequest) {r} | Procedure that caused this media to be created | |
| subject | 1..1 | Reference(eHealth Patient | eHealth Practitioner | Group | eHealth Device | Specimen) {r} | Who/What this Media is a record of | |
| reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
| context | 1..1 | Reference(Encounter | eHealth EpisodeOfCare) {r} | Encounter / Episode associated with media | |
| occurrence[x] | 1..1 | dateTime, Period | When Media was collected | |
| operator | 0..1 | Reference(eHealth Practitioner) {r} | The person who generated the image | |
| device | 0..1 | Reference(eHealth Device | eHealth DeviceMetric) {r} | Observing Device | |
| note | ||||
| author[x] | 0..1 | Individual responsible for the annotation | ||
| authorReference | Reference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson) | |||
| authorString | string | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Media | I | 0..* | Media | A photo, video, or audio recording acquired or used in healthcare. |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ehealth-quality | 0..* | (Complex) | Minimum requirements for qualities URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Identifier(s) for the image |
| basedOn | Σ | 1..1 | Reference(eHealth ProcedureRequest) {r} | Procedure that caused this media to be created |
| type | Σ | 1..1 | code | photo | video | audio Binding: DigitalMediaType (required): Whether the media is a photo, video, or audio |
| subtype | Σ | 0..1 | CodeableConcept | The type of acquisition equipment/process Binding: Media SubType (example): Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it |
| view | Σ | 0..1 | CodeableConcept | Imaging view, e.g. Lateral or Antero-posterior Binding: Media Collection View/Projection (example): Imaging view (projection) used when collecting an image |
| subject | Σ | 1..1 | Reference(eHealth Patient | eHealth Practitioner | Group | eHealth Device | Specimen) {r} | Who/What this Media is a record of |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| context | Σ | 1..1 | Reference(Encounter | eHealth EpisodeOfCare) {r} | Encounter / Episode associated with media |
| occurrence[x] | Σ | 1..1 | When Media was collected | |
| occurrenceDateTime | dateTime | |||
| occurrencePeriod | Period | |||
| operator | Σ | 0..1 | Reference(eHealth Practitioner) {r} | The person who generated the image |
| reasonCode | Σ | 0..* | CodeableConcept | Why was event performed? Binding: Procedure Reason Codes (example): The reason for the media |
| bodySite | Σ | 0..1 | CodeableConcept | Body part in media Binding: SNOMED CT Body Structures (example): Codes describing anatomical locations. May include laterality. |
| device | Σ | 0..1 | Reference(eHealth Device | eHealth DeviceMetric) {r} | Observing Device |
| height | ΣI | 0..1 | positiveInt | Height of the image in pixels (photo/video) |
| width | ΣI | 0..1 | positiveInt | Width of the image in pixels (photo/video) |
| frames | ΣI | 0..1 | positiveInt | Number of frames if > 1 (photo) |
| duration | ΣI | 0..1 | unsignedInt | Length in seconds (audio / video) |
| content | 1..1 | Attachment | Actual Media - reference or data | |
| note | 0..* | Annotation | Comments made about the media | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson) | |||
| authorString | string | |||
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | 1..1 | string | The annotation - text content | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Media.language | extensible | Common Languages Max Binding: All Languages |
| Media.type | required | DigitalMediaType |
| Media.subtype | example | Media SubType |
| Media.view | example | Media Collection View/Projection |
| Media.reasonCode | example | Procedure Reason Codes |
| Media.bodySite | example | SNOMED CT Body Structures |
| Id | Path | Details | Requirements |
| dom-2 | Media | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Media | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Media | 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 | Media | 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 | Media | Height can only be used for a photo or video : height.empty() or type != 'audio' | |
| mda-2 | Media | Width can only be used for a photo or video : width.empty() or type != 'audio' | |
| mda-3 | Media | Frames can only be used for a photo : frames.empty() or type = 'photo' | |
| mda-4 | Media | Duration can only be used for an audio or a video : duration.empty() or type != 'photo' | |
| ele-1 | Media.extension:quality | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Media.extension:quality | Must have either extensions or value[x], not both : extension.exists() != value.exists() |