eHealth Infrastructure
2.9.0 - release

eHealth Infrastructure - Local Development build (v2.9.0). See the Directory of published versions

Resource Profile: ehealth-media

Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-media Version: 2.9.0
Active as of 2023-08-23 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 0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(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
... basedOn 1..1Reference(ehealth-servicerequest) {r}Procedure that caused this media to be created
... subject 1..1Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device | Specimen)Who/What this Media is a record of
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... created[x] 1..1dateTime, PeriodWhen Media was collected
... operator 0..1Reference(ehealth-practitioner) {r}The person who generated the image
... device 0..1Reference(ehealth-device | ehealth-devicemetric) {r}Observing Device
... note
.... authorReference 0..1Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson)Individual responsible for the annotation
.... authorString 0..1stringIndividual responsible for the annotation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(EpisodeOfCare)Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... resolvedTiming 1..1(Complex)Resolved Timing
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... basedOn Σ1..1Reference(ehealth-servicerequest) {r}Procedure that caused this media to be created
... status ?!Σ1..1codepreparation | 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..1Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device | Specimen)Who/What this Media is a record of
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... created[x] Σ1..1When Media was collected
.... createdDateTimedateTime
.... createdPeriodPeriod
... operator Σ0..1Reference(ehealth-practitioner) {r}The person who generated the image
... device Σ0..1Reference(ehealth-device | ehealth-devicemetric) {r}Observing Device
... content Σ1..1AttachmentActual Media - reference or data

doco Documentation for this format

Terminology Bindings

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

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(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..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) for the image
... basedOn Σ1..1Reference(ehealth-servicerequest) {r}Procedure that caused this media to be created
... partOf Σ0..*Reference(Resource)Part of referenced event
... status ?!Σ1..1codepreparation | 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..1CodeableConceptClassification of media as image, video, or audio
Binding: MediaType (extensible): Codes for high level media categories.

... modality Σ0..1CodeableConceptThe 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..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior
Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image.

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

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter Σ0..1Reference(Encounter)Encounter associated with media
... created[x] Σ1..1When Media was collected
.... createdDateTimedateTime
.... createdPeriodPeriod
... issued Σ0..1instantDate/Time this version was made available
... operator Σ0..1Reference(ehealth-practitioner) {r}The person who generated the image
... reasonCode Σ0..*CodeableConceptWhy was event performed?
Binding: ProcedureReasonCodes (example): The reason for the media.


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

... deviceName Σ0..1stringName of the device/manufacturer
... device Σ0..1Reference(ehealth-device | ehealth-devicemetric) {r}Observing Device
... height Σ0..1positiveIntHeight of the image in pixels (photo/video)
... width Σ0..1positiveIntWidth of the image in pixels (photo/video)
... frames Σ0..1positiveIntNumber of frames if > 1 (photo)
... duration Σ0..1decimalLength in seconds (audio / video)
... content Σ1..1AttachmentActual Media - reference or data
... note 0..*AnnotationComments made about the media
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for author[x] Σ0..1Individual responsible for the annotation
Slice: Unordered, Closed by type:$this
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
..... author[x]:authorReference Σ0..1Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson)Individual responsible for the annotation
..... author[x]:authorString Σ0..1stringIndividual responsible for the annotation
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Media.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Media.statusrequiredEventStatus
Media.typeextensibleMediaType
Media.modalityexampleMediaModality
Media.viewexampleMediaCollectionView/Projection
Media.subject.typeextensibleResourceType
Media.reasonCodeexampleProcedureReasonCodes
Media.bodySiteexampleSNOMEDCTBodyStructures

Differential View

This structure is derived from Media

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(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
... basedOn 1..1Reference(ehealth-servicerequest) {r}Procedure that caused this media to be created
... subject 1..1Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device | Specimen)Who/What this Media is a record of
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... created[x] 1..1dateTime, PeriodWhen Media was collected
... operator 0..1Reference(ehealth-practitioner) {r}The person who generated the image
... device 0..1Reference(ehealth-device | ehealth-devicemetric) {r}Observing Device
... note
.... authorReference 0..1Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson)Individual responsible for the annotation
.... authorString 0..1stringIndividual responsible for the annotation

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Media 0..*MediaA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(EpisodeOfCare)Associated Encounter episode of care
URL: http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
... resolvedTiming 1..1(Complex)Resolved Timing
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-resolved-timing
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... basedOn Σ1..1Reference(ehealth-servicerequest) {r}Procedure that caused this media to be created
... status ?!Σ1..1codepreparation | 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..1Reference(ehealth-patient | ehealth-practitioner | Group | ehealth-device | Specimen)Who/What this Media is a record of
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... created[x] Σ1..1When Media was collected
.... createdDateTimedateTime
.... createdPeriodPeriod
... operator Σ0..1Reference(ehealth-practitioner) {r}The person who generated the image
... device Σ0..1Reference(ehealth-device | ehealth-devicemetric) {r}Observing Device
... content Σ1..1AttachmentActual Media - reference or data

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Media.statusrequiredEventStatus

Snapshot View

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

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... episodeOfCare 1..1Reference(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..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) for the image
... basedOn Σ1..1Reference(ehealth-servicerequest) {r}Procedure that caused this media to be created
... partOf Σ0..*Reference(Resource)Part of referenced event
... status ?!Σ1..1codepreparation | 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..1CodeableConceptClassification of media as image, video, or audio
Binding: MediaType (extensible): Codes for high level media categories.

... modality Σ0..1CodeableConceptThe 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..1CodeableConceptImaging view, e.g. Lateral or Antero-posterior
Binding: MediaCollectionView/Projection (example): Imaging view (projection) used when collecting an image.

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

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter Σ0..1Reference(Encounter)Encounter associated with media
... created[x] Σ1..1When Media was collected
.... createdDateTimedateTime
.... createdPeriodPeriod
... issued Σ0..1instantDate/Time this version was made available
... operator Σ0..1Reference(ehealth-practitioner) {r}The person who generated the image
... reasonCode Σ0..*CodeableConceptWhy was event performed?
Binding: ProcedureReasonCodes (example): The reason for the media.


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

... deviceName Σ0..1stringName of the device/manufacturer
... device Σ0..1Reference(ehealth-device | ehealth-devicemetric) {r}Observing Device
... height Σ0..1positiveIntHeight of the image in pixels (photo/video)
... width Σ0..1positiveIntWidth of the image in pixels (photo/video)
... frames Σ0..1positiveIntNumber of frames if > 1 (photo)
... duration Σ0..1decimalLength in seconds (audio / video)
... content Σ1..1AttachmentActual Media - reference or data
... note 0..*AnnotationComments made about the media
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for author[x] Σ0..1Individual responsible for the annotation
Slice: Unordered, Closed by type:$this
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
..... author[x]:authorReference Σ0..1Reference(ehealth-practitioner | ehealth-patient | ehealth-relatedperson)Individual responsible for the annotation
..... author[x]:authorString Σ0..1stringIndividual responsible for the annotation
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Media.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Media.statusrequiredEventStatus
Media.typeextensibleMediaType
Media.modalityexampleMediaModality
Media.viewexampleMediaCollectionView/Projection
Media.subject.typeextensibleResourceType
Media.reasonCodeexampleProcedureReasonCodes
Media.bodySiteexampleSNOMEDCTBodyStructures

 

Other representations of profile: CSV, Excel, Schematron