Class Media

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

    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.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> 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.
      • basedOn

        protected List<Reference> basedOn
        A procedure that is fulfilled in whole or in part by the creation of this media.
      • basedOnTarget

        protected List<ProcedureRequest> basedOnTarget
        The actual objects that are the target of the reference (A procedure that is fulfilled in whole or in part by the creation of this media.)
      • subtype

        protected CodeableConcept subtype
        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.
      • view

        protected CodeableConcept view
        The name of the imaging view e.g. Lateral or Antero-posterior (AP).
      • subjectTarget

        protected Resource subjectTarget
        The actual object that is the target of the reference (Who/What this Media is a record of.)
      • context

        protected Reference context
        The encounter or episode of care that establishes the context for this media.
      • contextTarget

        protected Resource contextTarget
        The actual object that is the target of the reference (The encounter or episode of care that establishes the context for this media.)
      • occurrence

        protected Type occurrence
        The date and time(s) at which the media was collected.
      • operator

        protected Reference operator
        The person who administered the collection of the image.
      • operatorTarget

        protected Practitioner operatorTarget
        The actual object that is the target of the reference (The person who administered the collection of the image.)
      • bodySite

        protected CodeableConcept bodySite
        Indicates the site on the subject's body where the media was collected (i.e. the target site).
      • deviceTarget

        protected Resource deviceTarget
        The actual object that is the target of the reference (The device used to collect the media.)
      • frames

        protected PositiveIntType 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.
      • content

        protected Attachment content
        The actual content of the media - inline or by direct reference to the media source file.
      • note

        protected List<Annotation> note
        Comments made about the media by the performer, subject or other participants.
      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: When Media was collected
        Type: date
        Path: Media.occurrence[x]

        See Also:
        Constant Field Values
      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description: When Media was collected
        Type: date
        Path: Media.occurrence[x]

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: Identifier(s) for the image
        Type: token
        Path: Media.identifier

      • SP_CREATED

        public static final String SP_CREATED
        Search parameter: created

        Description: Date attachment was first created
        Type: date
        Path: Media.content.creation

        See Also:
        Constant Field Values
      • CREATED

        public static final ca.uhn.fhir.rest.gclient.DateClientParam CREATED
        Fluent Client search parameter constant for created

        Description: Date attachment was first created
        Type: date
        Path: Media.content.creation

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: Who/What this Media is a record of
        Type: reference
        Path: Media.subject

        See Also:
        Constant Field Values
      • SUBJECT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
        Fluent Client search parameter constant for subject

        Description: Who/What this Media is a record of
        Type: reference
        Path: Media.subject

      • INCLUDE_SUBJECT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:subject".
      • TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
        Fluent Client search parameter constant for type

        Description: photo | video | audio
        Type: token
        Path: Media.type

      • SP_OPERATOR

        public static final String SP_OPERATOR
        Search parameter: operator

        Description: The person who generated the image
        Type: reference
        Path: Media.operator

        See Also:
        Constant Field Values
      • OPERATOR

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam OPERATOR
        Fluent Client search parameter constant for operator

        Description: The person who generated the image
        Type: reference
        Path: Media.operator

      • INCLUDE_OPERATOR

        public static final ca.uhn.fhir.model.api.Include INCLUDE_OPERATOR
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:operator".
      • SP_VIEW

        public static final String SP_VIEW
        Search parameter: view

        Description: Imaging view, e.g. Lateral or Antero-posterior
        Type: token
        Path: Media.view

        See Also:
        Constant Field Values
      • VIEW

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam VIEW
        Fluent Client search parameter constant for view

        Description: Imaging view, e.g. Lateral or Antero-posterior
        Type: token
        Path: Media.view

      • SITE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SITE
        Fluent Client search parameter constant for site

        Description: Body part in media
        Type: token
        Path: Media.bodySite

      • SP_BASED_ON

        public static final String SP_BASED_ON
        Search parameter: based-on

        Description: Procedure that caused this media to be created
        Type: reference
        Path: Media.basedOn

        See Also:
        Constant Field Values
      • BASED_ON

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
        Fluent Client search parameter constant for based-on

        Description: Procedure that caused this media to be created
        Type: reference
        Path: Media.basedOn

      • INCLUDE_BASED_ON

        public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:based-on".
      • SP_SUBTYPE

        public static final String SP_SUBTYPE
        Search parameter: subtype

        Description: The type of acquisition equipment/process
        Type: token
        Path: Media.subtype

        See Also:
        Constant Field Values
      • SUBTYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SUBTYPE
        Fluent Client search parameter constant for subtype

        Description: The type of acquisition equipment/process
        Type: token
        Path: Media.subtype

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: Who/What this Media is a record of
        Type: reference
        Path: Media.subject

        See Also:
        Constant Field Values
      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: Who/What this Media is a record of
        Type: reference
        Path: Media.subject

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:patient".
      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: Encounter / Episode associated with media
        Type: reference
        Path: Media.context

        See Also:
        Constant Field Values
      • CONTEXT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTEXT
        Fluent Client search parameter constant for context

        Description: Encounter / Episode associated with media
        Type: reference
        Path: Media.context

      • INCLUDE_CONTEXT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:context".
      • DEVICE

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEVICE
        Fluent Client search parameter constant for device

        Description: Observing Device
        Type: reference
        Path: Media.device

      • INCLUDE_DEVICE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_DEVICE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:device".
    • Method Detail

      • getIdentifier

        public List<IdentifiergetIdentifier()
        Returns:
        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.)
      • getBasedOn

        public List<ReferencegetBasedOn()
        Returns:
        basedOn (A procedure that is fulfilled in whole or in part by the creation of this media.)
      • getTypeElement

        public Enumeration<Media.DigitalMediaTypegetTypeElement()
        Returns:
        type (Whether the media is a photo (still image), an audio recording, or a video recording.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
      • hasType

        public boolean hasType()
      • setTypeElement

        public Media setTypeElement​(Enumeration<Media.DigitalMediaType> value)
        Parameters:
        value - type (Whether the media is a photo (still image), an audio recording, or a video recording.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
      • getType

        public Media.DigitalMediaType getType()
        Returns:
        Whether the media is a photo (still image), an audio recording, or a video recording.
      • setType

        public Media setType​(Media.DigitalMediaType value)
        Parameters:
        value - Whether the media is a photo (still image), an audio recording, or a video recording.
      • getSubtype

        public CodeableConcept getSubtype()
        Returns:
        subtype (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.)
      • setSubtype

        public Media setSubtype​(CodeableConcept value)
        Parameters:
        value - subtype (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.)
      • hasView

        public boolean hasView()
      • getSubjectTarget

        public Resource getSubjectTarget()
        Returns:
        subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Who/What this Media is a record of.)
      • setSubjectTarget

        public Media setSubjectTarget​(Resource value)
        Parameters:
        value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Who/What this Media is a record of.)
      • getContext

        public Reference getContext()
        Returns:
        context (The encounter or episode of care that establishes the context for this media.)
      • setContext

        public Media setContext​(Reference value)
        Parameters:
        value - context (The encounter or episode of care that establishes the context for this media.)
      • getContextTarget

        public Resource getContextTarget()
        Returns:
        context The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The encounter or episode of care that establishes the context for this media.)
      • setContextTarget

        public Media setContextTarget​(Resource value)
        Parameters:
        value - context The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The encounter or episode of care that establishes the context for this media.)
      • getOccurrenceDateTimeType

        public DateTimeType getOccurrenceDateTimeType()
                                               throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        occurrence (The date and time(s) at which the media was collected.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getOccurrencePeriod

        public Period getOccurrencePeriod()
                                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        occurrence (The date and time(s) at which the media was collected.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • setOccurrence

        public Media setOccurrence​(Type value)
                            throws org.hl7.fhir.exceptions.FHIRFormatError
        Parameters:
        value - occurrence (The date and time(s) at which the media was collected.)
        Throws:
        org.hl7.fhir.exceptions.FHIRFormatError
      • getOperatorTarget

        public Practitioner getOperatorTarget()
        Returns:
        operator The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The person who administered the collection of the image.)
      • setOperatorTarget

        public Media setOperatorTarget​(Practitioner value)
        Parameters:
        value - operator The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The person who administered the collection of the image.)
      • getDeviceTarget

        public Resource getDeviceTarget()
        Returns:
        device The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The device used to collect the media.)
      • setDeviceTarget

        public Media setDeviceTarget​(Resource value)
        Parameters:
        value - device The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The device used to collect the media.)
      • getHeightElement

        public PositiveIntType getHeightElement()
        Returns:
        height (Height of the image in pixels (photo/video).). This is the underlying object with id, value and extensions. The accessor "getHeight" gives direct access to the value
      • setHeightElement

        public Media setHeightElement​(PositiveIntType value)
        Parameters:
        value - height (Height of the image in pixels (photo/video).). This is the underlying object with id, value and extensions. The accessor "getHeight" gives direct access to the value
      • getHeight

        public int getHeight()
        Returns:
        Height of the image in pixels (photo/video).
      • setHeight

        public Media setHeight​(int value)
        Parameters:
        value - Height of the image in pixels (photo/video).
      • getWidthElement

        public PositiveIntType getWidthElement()
        Returns:
        width (Width of the image in pixels (photo/video).). This is the underlying object with id, value and extensions. The accessor "getWidth" gives direct access to the value
      • setWidthElement

        public Media setWidthElement​(PositiveIntType value)
        Parameters:
        value - width (Width of the image in pixels (photo/video).). This is the underlying object with id, value and extensions. The accessor "getWidth" gives direct access to the value
      • getWidth

        public int getWidth()
        Returns:
        Width of the image in pixels (photo/video).
      • setWidth

        public Media setWidth​(int value)
        Parameters:
        value - Width of the image in pixels (photo/video).
      • getFramesElement

        public PositiveIntType getFramesElement()
        Returns:
        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.). This is the underlying object with id, value and extensions. The accessor "getFrames" gives direct access to the value
      • setFramesElement

        public Media setFramesElement​(PositiveIntType value)
        Parameters:
        value - 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.). This is the underlying object with id, value and extensions. The accessor "getFrames" gives direct access to the value
      • getFrames

        public int getFrames()
        Returns:
        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.
      • setFrames

        public Media setFrames​(int value)
        Parameters:
        value - 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.
      • getDurationElement

        public UnsignedIntType getDurationElement()
        Returns:
        duration (The duration of the recording in seconds - for audio and video.). This is the underlying object with id, value and extensions. The accessor "getDuration" gives direct access to the value
      • setDurationElement

        public Media setDurationElement​(UnsignedIntType value)
        Parameters:
        value - duration (The duration of the recording in seconds - for audio and video.). This is the underlying object with id, value and extensions. The accessor "getDuration" gives direct access to the value
      • getDuration

        public int getDuration()
        Returns:
        The duration of the recording in seconds - for audio and video.
      • setDuration

        public Media setDuration​(int value)
        Parameters:
        value - The duration of the recording in seconds - for audio and video.
      • getContent

        public Attachment getContent()
        Returns:
        content (The actual content of the media - inline or by direct reference to the media source file.)
      • setContent

        public Media setContent​(Attachment value)
        Parameters:
        value - content (The actual content of the media - inline or by direct reference to the media source file.)
      • getNote

        public List<AnnotationgetNote()
        Returns:
        note (Comments made about the media by the performer, subject or other participants.)
      • hasNote

        public boolean hasNote()
      • getNoteFirstRep

        public Annotation getNoteFirstRep()
        Returns:
        The first repetition of repeating field note, creating it if it does not already exist
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource