eHealth Infrastructure (v2020.1)

StructureDefinition: 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”.

Formal Views of Profile Content

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 Tue Feb 04 09:11:17 UTC 2020 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..*MediaA photo, video, or audio recording acquired or used in healthcare.
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... ehealth-quality 0..*(Complex)Minimum requirements for qualities
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
... basedOn 1..1Reference(eHealth ProcedureRequest) {r}
... subject 1..1Reference(eHealth Patient | eHealth Practitioner | Group | eHealth Device | Specimen) {r}
.... reference 1..1string
... context 1..1Reference(Encounter | eHealth EpisodeOfCare) {r}
... occurrence[x] 1..1dateTime, Period
... operator 0..1Reference(eHealth Practitioner) {r}
... device 0..1Reference(eHealth Device | eHealth DeviceMetric) {r}
... note
.... author[x] 0..1
..... authorReferenceReference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson)
..... authorStringstring

doco Documentation for this format

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media I0..*MediaA photo, video, or audio recording acquired or used in healthcare.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-quality I0..*(Complex)Minimum requirements for qualities
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) for the image
... basedOn Σ1..1Reference(eHealth ProcedureRequest) {r}Procedure that caused this media to be created
... type Σ1..1codephoto | video | audio
Binding: DigitalMediaType (required)
... subtype Σ0..1CodeableConceptThe type of acquisition equipment/process
Binding: Media SubType (example)
... view Σ0..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior
Binding: Media Collection View/Projection (example)
... subject Σ1..1Reference(eHealth Patient | eHealth Practitioner | Group | eHealth Device | Specimen) {r}Who/What this Media is a record of
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... context Σ1..1Reference(Encounter | eHealth EpisodeOfCare) {r}Encounter / Episode associated with media
... occurrence[x] Σ1..1When Media was collected
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... operator Σ0..1Reference(eHealth Practitioner) {r}The person who generated the image
... reasonCode Σ0..*CodeableConceptWhy was event performed?
Binding: Procedure Reason Codes (example)
... bodySite Σ0..1CodeableConceptBody part in media
Binding: SNOMED CT Body Structures (example)
... device Σ0..1Reference(eHealth Device | eHealth DeviceMetric) {r}Observing Device
... height ΣI0..1positiveIntHeight of the image in pixels (photo/video)
... width ΣI0..1positiveIntWidth of the image in pixels (photo/video)
... frames ΣI0..1positiveIntNumber of frames if > 1 (photo)
... duration ΣI0..1unsignedIntLength in seconds (audio / video)
... content 1..1AttachmentActual Media - reference or data
... note 0..*AnnotationComments made about the media
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco Documentation for this format

Differential View

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..*MediaA photo, video, or audio recording acquired or used in healthcare.
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... ehealth-quality 0..*(Complex)Minimum requirements for qualities
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
... basedOn 1..1Reference(eHealth ProcedureRequest) {r}
... subject 1..1Reference(eHealth Patient | eHealth Practitioner | Group | eHealth Device | Specimen) {r}
.... reference 1..1string
... context 1..1Reference(Encounter | eHealth EpisodeOfCare) {r}
... occurrence[x] 1..1dateTime, Period
... operator 0..1Reference(eHealth Practitioner) {r}
... device 0..1Reference(eHealth Device | eHealth DeviceMetric) {r}
... note
.... author[x] 0..1
..... authorReferenceReference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson)
..... authorStringstring

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media I0..*MediaA photo, video, or audio recording acquired or used in healthcare.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ehealth-quality I0..*(Complex)Minimum requirements for qualities
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) for the image
... basedOn Σ1..1Reference(eHealth ProcedureRequest) {r}Procedure that caused this media to be created
... type Σ1..1codephoto | video | audio
Binding: DigitalMediaType (required)
... subtype Σ0..1CodeableConceptThe type of acquisition equipment/process
Binding: Media SubType (example)
... view Σ0..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior
Binding: Media Collection View/Projection (example)
... subject Σ1..1Reference(eHealth Patient | eHealth Practitioner | Group | eHealth Device | Specimen) {r}Who/What this Media is a record of
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... context Σ1..1Reference(Encounter | eHealth EpisodeOfCare) {r}Encounter / Episode associated with media
... occurrence[x] Σ1..1When Media was collected
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
... operator Σ0..1Reference(eHealth Practitioner) {r}The person who generated the image
... reasonCode Σ0..*CodeableConceptWhy was event performed?
Binding: Procedure Reason Codes (example)
... bodySite Σ0..1CodeableConceptBody part in media
Binding: SNOMED CT Body Structures (example)
... device Σ0..1Reference(eHealth Device | eHealth DeviceMetric) {r}Observing Device
... height ΣI0..1positiveIntHeight of the image in pixels (photo/video)
... width ΣI0..1positiveIntWidth of the image in pixels (photo/video)
... frames ΣI0..1positiveIntNumber of frames if > 1 (photo)
... duration ΣI0..1unsignedIntLength in seconds (audio / video)
... content 1..1AttachmentActual Media - reference or data
... note 0..*AnnotationComments made about the media
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(eHealth Practitioner | eHealth Patient | eHealth RelatedPerson)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content

doco Documentation for this format

 

Terminology Bindings

PathConformanceValueSet
Media.languageextensibleCommon Languages
Max Binding: All Languages
Media.typerequiredDigitalMediaType
Media.subtypeexampleMedia SubType
Media.viewexampleMedia Collection View/Projection
Media.reasonCodeexampleProcedure Reason Codes
Media.bodySiteexampleSNOMED CT Body Structures

Constraints

IdPathDetailsRequirements
dom-2MediaIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1MediaIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4MediaIf 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-3MediaIf 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-1MediaHeight can only be used for a photo or video
: height.empty() or type != 'audio'
mda-2MediaWidth can only be used for a photo or video
: width.empty() or type != 'audio'
mda-3MediaFrames can only be used for a photo
: frames.empty() or type = 'photo'
mda-4MediaDuration can only be used for an audio or a video
: duration.empty() or type != 'photo'
ele-1Media.extension:qualityAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Media.extension:qualityMust have either extensions or value[x], not both
: extension.exists() != value.exists()
.