eHealth Infrastructure
3.1.0 - release

This page is part of the FUT Infrastructure (v3.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: ehealth-media

Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-media Version: 3.1.0
Active as of 2024-07-01 Computable Name: ehealth-media

Introduction

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

Scope and Usage

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).

Immutability

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.

Searching media

It is possible to search for Media based on:

  • context
  • subject
  • code
  • period
  • deviceMeasuringQuality
  • situationQuality
  • operationQuality

At least one of “subject” and “context” must be provided. “period” searches on range of “occurence”.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media Media
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... episodeOfCare 1..1 Reference(EpisodeOfCare) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
.... quality 0..* (Complex) Minimum requirements for qualities
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
.... resolvedTiming 1..1 (Complex) Resolved Timing
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing
... basedOn 1..1 Reference(ehealth-servicerequest) {r} Procedure that caused this media to be created
... subject 1..1 Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device | Specimen) Who/What this Media is a record of
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... 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
.... Slices for author[x] 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization), string Individual responsible for the annotation
Slice: Unordered, Open by type:$this
..... author[x]:authorReference 0..1 Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson) Individual responsible for the annotation
..... author[x]:authorString 0..1 string Individual responsible for the annotation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..* Media A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... episodeOfCare 1..1 Reference(EpisodeOfCare) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
.... quality 0..* (Complex) Minimum requirements for qualities
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
.... resolvedTiming 1..1 (Complex) Resolved Timing
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): Codes identifying the lifecycle stage of an event.

... subject Σ 1..1 Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device | Specimen) Who/What this Media is a record of
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... created[x] Σ 1..1 When Media was collected
.... createdDateTime dateTime
.... createdPeriod Period
... operator Σ 0..1 Reference(ehealth-practitioner) {r} The person who generated the image
... device Σ 0..1 Reference(ehealth-device | ehealth-devicemetric) {r} Observing Device
... content Σ 1..1 Attachment Actual Media - reference or data

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Media.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..* Media A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... episodeOfCare 1..1 Reference(EpisodeOfCare) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
.... quality 0..* (Complex) Minimum requirements for qualities
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
.... resolvedTiming 1..1 (Complex) Resolved Timing
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifier(s) for the image
... basedOn Σ 1..1 Reference(ehealth-servicerequest) {r} Procedure that caused this media to be created
... partOf Σ 0..* Reference(Resource) Part of referenced event
... status ?!Σ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): Codes identifying the lifecycle stage of an event.

... type Σ 0..1 CodeableConcept Classification of media as image, video, or audio
Binding: MediaType (extensible): Codes for high level media categories.

... modality Σ 0..1 CodeableConcept The type of acquisition equipment/process
Binding: MediaModality (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: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image.

... subject Σ 1..1 Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device | Specimen) Who/What this Media is a record of
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Encounter associated with media
... created[x] Σ 1..1 When Media was collected
.... createdDateTime dateTime
.... createdPeriod Period
... issued Σ 0..1 instant Date/Time this version was made available
... operator Σ 0..1 Reference(ehealth-practitioner) {r} The person who generated the image
... reasonCode Σ 0..* CodeableConcept Why was event performed?
Binding: ProcedureReasonCodes (example): The reason for the media.


... bodySite Σ 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... deviceName Σ 0..1 string Name of the device/manufacturer
... device Σ 0..1 Reference(ehealth-device | ehealth-devicemetric) {r} Observing Device
... height Σ 0..1 positiveInt Height of the image in pixels (photo/video)
... width Σ 0..1 positiveInt Width of the image in pixels (photo/video)
... frames Σ 0..1 positiveInt Number of frames if > 1 (photo)
... duration Σ 0..1 decimal 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 Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for author[x] Σ 0..1 Individual responsible for the annotation
Slice: Unordered, Closed by type:$this
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
..... author[x]:authorReference Σ 0..1 Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson) Individual responsible for the annotation
..... author[x]:authorString Σ 0..1 string Individual responsible for the annotation
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Media.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Media.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Media.typeextensibleMediaType
http://hl7.org/fhir/ValueSet/media-type
from the FHIR Standard
Media.modalityexampleMediaModality
http://hl7.org/fhir/ValueSet/media-modality
from the FHIR Standard
Media.viewexampleMediaCollectionView/Projection
http://hl7.org/fhir/ValueSet/media-view
from the FHIR Standard
Media.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Media.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
Media.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Differential View

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media Media
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... episodeOfCare 1..1 Reference(EpisodeOfCare) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
.... quality 0..* (Complex) Minimum requirements for qualities
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
.... resolvedTiming 1..1 (Complex) Resolved Timing
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing
... basedOn 1..1 Reference(ehealth-servicerequest) {r} Procedure that caused this media to be created
... subject 1..1 Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device | Specimen) Who/What this Media is a record of
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... 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
.... Slices for author[x] 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization), string Individual responsible for the annotation
Slice: Unordered, Open by type:$this
..... author[x]:authorReference 0..1 Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson) Individual responsible for the annotation
..... author[x]:authorString 0..1 string Individual responsible for the annotation

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..* Media A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... episodeOfCare 1..1 Reference(EpisodeOfCare) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
.... quality 0..* (Complex) Minimum requirements for qualities
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
.... resolvedTiming 1..1 (Complex) Resolved Timing
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): Codes identifying the lifecycle stage of an event.

... subject Σ 1..1 Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device | Specimen) Who/What this Media is a record of
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... created[x] Σ 1..1 When Media was collected
.... createdDateTime dateTime
.... createdPeriod Period
... operator Σ 0..1 Reference(ehealth-practitioner) {r} The person who generated the image
... device Σ 0..1 Reference(ehealth-device | ehealth-devicemetric) {r} Observing Device
... content Σ 1..1 Attachment Actual Media - reference or data

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Media.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..* Media A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... episodeOfCare 1..1 Reference(EpisodeOfCare) Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
.... quality 0..* (Complex) Minimum requirements for qualities
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
.... resolvedTiming 1..1 (Complex) Resolved Timing
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifier(s) for the image
... basedOn Σ 1..1 Reference(ehealth-servicerequest) {r} Procedure that caused this media to be created
... partOf Σ 0..* Reference(Resource) Part of referenced event
... status ?!Σ 1..1 code preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): Codes identifying the lifecycle stage of an event.

... type Σ 0..1 CodeableConcept Classification of media as image, video, or audio
Binding: MediaType (extensible): Codes for high level media categories.

... modality Σ 0..1 CodeableConcept The type of acquisition equipment/process
Binding: MediaModality (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: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image.

... subject Σ 1..1 Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device | Specimen) Who/What this Media is a record of
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Encounter associated with media
... created[x] Σ 1..1 When Media was collected
.... createdDateTime dateTime
.... createdPeriod Period
... issued Σ 0..1 instant Date/Time this version was made available
... operator Σ 0..1 Reference(ehealth-practitioner) {r} The person who generated the image
... reasonCode Σ 0..* CodeableConcept Why was event performed?
Binding: ProcedureReasonCodes (example): The reason for the media.


... bodySite Σ 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... deviceName Σ 0..1 string Name of the device/manufacturer
... device Σ 0..1 Reference(ehealth-device | ehealth-devicemetric) {r} Observing Device
... height Σ 0..1 positiveInt Height of the image in pixels (photo/video)
... width Σ 0..1 positiveInt Width of the image in pixels (photo/video)
... frames Σ 0..1 positiveInt Number of frames if > 1 (photo)
... duration Σ 0..1 decimal 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 Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for author[x] Σ 0..1 Individual responsible for the annotation
Slice: Unordered, Closed by type:$this
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
..... author[x]:authorReference Σ 0..1 Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson) Individual responsible for the annotation
..... author[x]:authorString Σ 0..1 string Individual responsible for the annotation
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Media.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Media.statusrequiredEventStatus
http://hl7.org/fhir/ValueSet/event-status|4.0.1
from the FHIR Standard
Media.typeextensibleMediaType
http://hl7.org/fhir/ValueSet/media-type
from the FHIR Standard
Media.modalityexampleMediaModality
http://hl7.org/fhir/ValueSet/media-modality
from the FHIR Standard
Media.viewexampleMediaCollectionView/Projection
http://hl7.org/fhir/ValueSet/media-view
from the FHIR Standard
Media.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Media.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
from the FHIR Standard
Media.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron