Package org.hl7.fhir.dstu2016may.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.

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

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

      • deviceName

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

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

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

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

      • 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

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

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

      • addIdentifier

        public Identifier addIdentifier()
        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.)

      • getTypeElement

        public Enumeration<Media.DigitalMediaType> getTypeElement()
        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.)

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

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

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

      • 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

      • makeProperty

        public Base makeProperty​(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        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