Media

@POJOBoilerplate
class Media(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val view: Option[CodeableConcept], val note: LitSeq[Annotation], val width: Option[PositiveInt], val partOf: LitSeq[Reference], val status: EVENT_STATUS, val issued: Option[ZonedDateTime], val device: Option[Reference], val height: Option[PositiveInt], val frames: Option[PositiveInt], val basedOn: LitSeq[Reference], val subject: Option[Reference], val content: Attachment, val language: Option[LANGUAGES], val modality: Option[CodeableConcept], val operator: Option[Reference], val bodySite: Option[CodeableConcept], val duration: Option[BigDecimal], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val created: Option[CreatedChoice], val reasonCode: LitSeq[CodeableConcept], val deviceName: Option[String], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

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

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • A code that classifies whether the media is an image, video or audio recording or some other media category.
basedOn
  • A procedure that is fulfilled in whole or in part by the creation of this media.
bodySite
  • Indicates the site on the subject's body where the observation was made (i.e. the target site).
contained
  • 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.
content
  • The actual content of the media - inline or by direct reference to the media source file.
created
  • The date and time(s) at which the media was collected.
device
  • The device used to collect the media.
deviceName
  • The name of the device / manufacturer of the device that was used to make the recording.
duration
  • The duration of the recording in seconds - for audio and video.
encounter
  • The encounter that establishes the context for this media.
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.
frames
  • 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.
height
  • Height of the image in pixels (photo/video).
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • 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.
implicitRules
  • 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.
issued
  • The date and time this version of the media was made available to providers, typically after having been reviewed.
language
  • The base language in which the resource is written.
meta
  • 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.
modality
  • 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.
modifierExtension
  • 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).
note
  • Comments made about the media by the performer, subject or other participants.
operator
  • The person who administered the collection of the image.
partOf
  • A larger event of which this particular event is a component or step.
reasonCode
  • Describes why the event occurred in coded or textual form.
status
  • The current state of the {{title}}.
subject
  • Who/What this Media is a record of.
text
  • 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.
view
  • The name of the imaging view e.g. Lateral or Antero-posterior (AP).
width
  • Width of the image in pixels (photo/video).
Constructor:

Introduces the fields type, view, note, width, partOf, status, issued, device, height, frames, basedOn, subject, content, modality, operator, bodySite, duration, encounter, identifier, created, reasonCode, deviceName.

Companion:
object
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from:
FHIRObject
object ids
Inherited from:
FHIRObject

Inherited types

type FieldToElementLookup = TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
Inherited from:
FHIRObject

Value members

Inherited methods

final def >>[T](fn: T => T)(implicit tt: LTag[T]): Media

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from:
FHIRObject
final def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[Media]
Inherited from:
FHIRObject
final def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from:
FHIRObject
final def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from:
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from:
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from:
Utils
def constructor: Constructor[_]
Inherited from:
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from:
Utils
override def equals(obj: Any): Boolean
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from:
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from:
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from:
FHIRComponent
def getIdentifier: Option[String]
Inherited from:
Resource
def getMostSpecificIdentifier: Option[String]
Inherited from:
Resource
def getVersionedIdentifier: Option[String]
Inherited from:
Resource
override def hashCode(): Int
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def modifyField[T : LTag, Up >: Media <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def modifyFieldUnsafe[T, Up >: Media <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
final def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from:
FHIRObject
final def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from:
FHIRObject
final def nodalMap[T](klass: Class[T], fn: T => T): Media

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from:
FHIRObject
def setFromField[T, UpType >: Media <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from:
FHIRObject
def thisClassName: String
Inherited from:
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from:
FHIRObject
override def toString: String
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from:
FHIRObject
def updateFromField[T, UpType >: Media <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from:
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): Media
Inherited from:
FHIRObject
def withField[T : LTag, Up >: Media <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFieldUnsafe[T, Up >: Media <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFields[Up >: Media <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): Media
Inherited from:
FHIRObject

Concrete fields

val `type`: Option[CodeableConcept]
val basedOn: LitSeq[Reference]
val bodySite: Option[CodeableConcept]
override val contained: LitSeq[Resource]
val content: Attachment
val created: Option[CreatedChoice]
val device: Option[Reference]
val deviceName: Option[String]
val duration: Option[BigDecimal]
val encounter: Option[Reference]
override val extension: LitSeq[Extension]
val frames: Option[PositiveInt]
val height: Option[PositiveInt]
override val id: Option[String]
val identifier: LitSeq[Identifier]
override val implicitRules: Option[UriStr]
val issued: Option[ZonedDateTime]
override val language: Option[LANGUAGES]
override val meta: Option[Meta]
val modality: Option[CodeableConcept]
override val modifierExtension: LitSeq[Extension]
val note: LitSeq[Annotation]
val operator: Option[Reference]
val partOf: LitSeq[Reference]
override val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
val reasonCode: LitSeq[CodeableConcept]
val subject: Option[Reference]
override val text: Option[Narrative]
override val thisTypeName: String
val view: Option[CodeableConcept]
val width: Option[PositiveInt]

Inherited fields

val companion: CompanionFor[Media]
Inherited from:
FHIRObject