Package org.hl7.fhir.r4.model

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<Resource> 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.)

      • partOf

        protected List<Reference> partOf
        A larger event of which this particular event is a component or step.

      • partOfTarget

        protected List<Resource> partOfTarget
        The actual objects that are the target of the reference (A larger event of which this particular event is a component or step.)

      • type

        protected CodeableConcept type
        A code that classifies whether the media is an image, video or audio recording or some other media category.

      • modality

        protected CodeableConcept 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.

      • 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.)

      • encounter

        protected Reference encounter
        The encounter that establishes the context for this media.

      • encounterTarget

        protected Encounter encounterTarget
        The actual object that is the target of the reference (The encounter that establishes the context for this media.)

      • created

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

      • issued

        protected InstantType issued
        The date and time this version of the media was made available to providers, typically after having been reviewed.

      • operator

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

      • operatorTarget

        protected Resource 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 observation was made (i.e. the target site).

      • deviceName

        protected StringType deviceName
        The name of the device / manufacturer of the device that was used to make the recording.

      • 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.

      • duration

        protected DecimalType duration
        The duration of the recording in seconds - for audio and video.

      • 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.

      • 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_MODALITY

        public static final String SP_MODALITY
        Search parameter: modality

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

        See Also:
        Constant Field Values

      • MODALITY

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

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

      • 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".

      • CREATED

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

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

      • SP_ENCOUNTER

        public static final String SP_ENCOUNTER
        Search parameter: encounter

        Description: Encounter associated with media
        Type: reference
        Path: Media.encounter

        See Also:
        Constant Field Values

      • ENCOUNTER

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

        Description: Encounter associated with media
        Type: reference
        Path: Media.encounter

      • INCLUDE_ENCOUNTER

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

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: Classification of media as image, video, or audio
        Type: token
        Path: Media.type

        See Also:
        Constant Field Values

      • TYPE

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

        Description: Classification of media as image, video, or 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: Observed body part
        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_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".

      • 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".

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
        Type: token
        Path: Media.status

        See Also:
        Constant Field Values

      • STATUS

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

        Description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
        Type: token
        Path: Media.status

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        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<Reference> getBasedOn()
        Returns:
        basedOn (A procedure that is fulfilled in whole or in part by the creation of this media.)

      • getStatusElement

        public Enumeration<Media.MediaStatus> getStatusElement()
        Returns:
        status (The current state of the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

      • setStatusElement

        public Media setStatusElement​(Enumeration<Media.MediaStatus> value)
        Parameters:
        value - status (The current state of the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

      • getType

        public CodeableConcept getType()
        Returns:
        type (A code that classifies whether the media is an image, video or audio recording or some other media category.)

      • hasType

        public boolean hasType()

      • setType

        public Media setType​(CodeableConcept value)
        Parameters:
        value - type (A code that classifies whether the media is an image, video or audio recording or some other media category.)

      • getModality

        public CodeableConcept getModality()
        Returns:
        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.)

      • setModality

        public Media setModality​(CodeableConcept value)
        Parameters:
        value - 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.)

      • 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.)

      • getEncounterTarget

        public Encounter getEncounterTarget()
        Returns:
        encounter 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 that establishes the context for this media.)

      • setEncounterTarget

        public Media setEncounterTarget​(Encounter value)
        Parameters:
        value - encounter 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 that establishes the context for this media.)

      • getCreated

        public Type getCreated()
        Returns:
        created (The date and time(s) at which the media was collected.)

      • getCreatedDateTimeType

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

      • getCreatedPeriod

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

      • setCreated

        public Media setCreated​(Type value)
        Parameters:
        value - created (The date and time(s) at which the media was collected.)

      • getIssuedElement

        public InstantType getIssuedElement()
        Returns:
        issued (The date and time this version of the media was made available to providers, typically after having been reviewed.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value

      • setIssuedElement

        public Media setIssuedElement​(InstantType value)
        Parameters:
        value - issued (The date and time this version of the media was made available to providers, typically after having been reviewed.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value

      • getIssued

        public Date getIssued()
        Returns:
        The date and time this version of the media was made available to providers, typically after having been reviewed.

      • setIssued

        public Media setIssued​(Date value)
        Parameters:
        value - The date and time this version of the media was made available to providers, typically after having been reviewed.

      • getOperatorTarget

        public Resource 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​(Resource 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.)

      • getDeviceNameElement

        public StringType getDeviceNameElement()
        Returns:
        deviceName (The name of the device / manufacturer of the device that was used to make the recording.). This is the underlying object with id, value and extensions. The accessor "getDeviceName" gives direct access to the value

      • setDeviceNameElement

        public Media setDeviceNameElement​(StringType value)
        Parameters:
        value - deviceName (The name of the device / manufacturer of the device that was used to make the recording.). This is the underlying object with id, value and extensions. The accessor "getDeviceName" gives direct access to the value

      • getDeviceName

        public String getDeviceName()
        Returns:
        The name of the device / manufacturer of the device that was used to make the recording.

      • setDeviceName

        public Media setDeviceName​(String value)
        Parameters:
        value - The name of the device / manufacturer of the device that was used to make the recording.

      • 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 DecimalType 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​(DecimalType 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 BigDecimal getDuration()
        Returns:
        The duration of the recording in seconds - for audio and video.

      • setDuration

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

      • setDuration

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

      • setDuration

        public Media setDuration​(double 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<Annotation> getNote()
        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