Package com.ibm.fhir.model.resource

Class Media

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Media
extends DomainResource
    A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

    Maturity level: FMM1 (Trial Use)

    • Method Detail

      • getIdentifier

        public java.util.List<Identifier> getIdentifier()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getBasedOn

        public java.util.List<Reference> getBasedOn()
        A procedure that is fulfilled in whole or in part by the creation of this media.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getPartOf

        public java.util.List<Reference> getPartOf()
        A larger event of which this particular event is a component or step.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getStatus

        public MediaStatus getStatus()
        The current state of the {{title}}.
        Returns:
        An immutable object of type MediaStatus that is non-null.

      • getType

        public CodeableConcept getType()
        A code that classifies whether the media is an image, video or audio recording or some other media category.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getModality

        public CodeableConcept getModality()
        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.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getView

        public CodeableConcept getView()
        The name of the imaging view e.g. Lateral or Antero-posterior (AP).
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getSubject

        public Reference getSubject()
        Who/What this Media is a record of.
        Returns:
        An immutable object of type Reference that may be null.

      • getEncounter

        public Reference getEncounter()
        The encounter that establishes the context for this media.
        Returns:
        An immutable object of type Reference that may be null.

      • getCreated

        public Element getCreated()
        The date and time(s) at which the media was collected.
        Returns:
        An immutable object of type DateTime or Period that may be null.

      • getIssued

        public Instant getIssued()
        The date and time this version of the media was made available to providers, typically after having been reviewed.
        Returns:
        An immutable object of type Instant that may be null.

      • getOperator

        public Reference getOperator()
        The person who administered the collection of the image.
        Returns:
        An immutable object of type Reference that may be null.

      • getReasonCode

        public java.util.List<CodeableConcept> getReasonCode()
        Describes why the event occurred in coded or textual form.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getBodySite

        public CodeableConcept getBodySite()
        Indicates the site on the subject's body where the observation was made (i.e. the target site).
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getDeviceName

        public String getDeviceName()
        The name of the device / manufacturer of the device that was used to make the recording.
        Returns:
        An immutable object of type String that may be null.

      • getDevice

        public Reference getDevice()
        The device used to collect the media.
        Returns:
        An immutable object of type Reference that may be null.

      • getHeight

        public PositiveInt getHeight()
        Height of the image in pixels (photo/video).
        Returns:
        An immutable object of type PositiveInt that may be null.

      • getWidth

        public PositiveInt getWidth()
        Width of the image in pixels (photo/video).
        Returns:
        An immutable object of type PositiveInt that may be null.

      • getFrames

        public PositiveInt getFrames()
        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.
        Returns:
        An immutable object of type PositiveInt that may be null.

      • getDuration

        public Decimal getDuration()
        The duration of the recording in seconds - for audio and video.
        Returns:
        An immutable object of type Decimal that may be null.

      • getContent

        public Attachment getContent()
        The actual content of the media - inline or by direct reference to the media source file.
        Returns:
        An immutable object of type Attachment that is non-null.

      • getNote

        public java.util.List<Annotation> getNote()
        Comments made about the media by the performer, subject or other participants.
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • accept

        public void accept​(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object