Class Media

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class Media
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR Media Resource (infrastructure.structure)

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

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/Media

    See Also:
    Serialized Form
    • Field Detail

      • TYPE

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

        Description:
        Type: token
        Path: Media.type

      • SUBTYPE

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

        Description:
        Type: token
        Path: Media.subtype

      • IDENTIFIER

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

        Description:
        Type: token
        Path: Media.identifier

      • CREATED

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

        Description:
        Type: date
        Path: Media.content.creation

      • SUBJECT

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

        Description:
        Type: reference
        Path: Media.subject

      • OPERATOR

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

        Description:
        Type: reference
        Path: Media.operator

      • VIEW

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

        Description:
        Type: token
        Path: Media.view

      • PATIENT

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

        Description:
        Type: reference
        Path: Media.subject

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

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getTypeElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<DigitalMediaTypeEnumgetTypeElement()
        Gets the value(s) for type (class). creating it if it does not exist. Will not return null.

        Definition: Whether the media is a photo (still image), an audio recording, or a video recording

      • getType

        public String getType()
        Gets the value(s) for type (class). creating it if it does not exist. This method may return null.

        Definition: Whether the media is a photo (still image), an audio recording, or a video recording

      • setType

        public Media setType​(ca.uhn.fhir.model.primitive.BoundCodeDt<DigitalMediaTypeEnum> theValue)
        Sets the value(s) for type (class)

        Definition: Whether the media is a photo (still image), an audio recording, or a video recording

      • setType

        public Media setType​(DigitalMediaTypeEnum theValue)
        Sets the value(s) for type (class)

        Definition: Whether the media is a photo (still image), an audio recording, or a video recording

      • getSubtype

        public CodeableConceptDt getSubtype()
        Gets the value(s) for subtype (class). creating it if it does not exist. Will not return null.

        Definition: 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​(CodeableConceptDt theValue)
        Sets the value(s) for subtype (class)

        Definition: 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

      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: 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

      • setIdentifier

        public Media setIdentifier​(List<IdentifierDt> theValue)
        Sets the value(s) for identifier (id)

        Definition: 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 IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: 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 Media addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: 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

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: 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

      • getSubject

        public ResourceReferenceDt getSubject()
        Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.

        Definition: Who/What this Media is a record of

      • getOperator

        public ResourceReferenceDt getOperator()
        Gets the value(s) for operator (who.actor). creating it if it does not exist. Will not return null.

        Definition: The person who administered the collection of the image

      • setOperator

        public Media setOperator​(ResourceReferenceDt theValue)
        Sets the value(s) for operator (who.actor)

        Definition: The person who administered the collection of the image

      • getView

        public CodeableConceptDt getView()
        Gets the value(s) for view (class). creating it if it does not exist. Will not return null.

        Definition: The name of the imaging view e.g. Lateral or Antero-posterior (AP).

      • setView

        public Media setView​(CodeableConceptDt theValue)
        Sets the value(s) for view (class)

        Definition: The name of the imaging view e.g. Lateral or Antero-posterior (AP).

      • getDeviceNameElement

        public ca.uhn.fhir.model.primitive.StringDt getDeviceNameElement()
        Gets the value(s) for deviceName (). creating it if it does not exist. Will not return null.

        Definition: The name of the device / manufacturer of the device that was used to make the recording

      • getDeviceName

        public String getDeviceName()
        Gets the value(s) for deviceName (). creating it if it does not exist. This method may return null.

        Definition: The name of the device / manufacturer of the device that was used to make the recording

      • setDeviceName

        public Media setDeviceName​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for deviceName ()

        Definition: The name of the device / manufacturer of the device that was used to make the recording

      • setDeviceName

        public Media setDeviceName​(String theString)
        Sets the value for deviceName ()

        Definition: The name of the device / manufacturer of the device that was used to make the recording

      • getHeightElement

        public ca.uhn.fhir.model.primitive.PositiveIntDt getHeightElement()
        Gets the value(s) for height (). creating it if it does not exist. Will not return null.

        Definition: Height of the image in pixels (photo/video)

      • getHeight

        public Integer getHeight()
        Gets the value(s) for height (). creating it if it does not exist. This method may return null.

        Definition: Height of the image in pixels (photo/video)

      • setHeight

        public Media setHeight​(ca.uhn.fhir.model.primitive.PositiveIntDt theValue)
        Sets the value(s) for height ()

        Definition: Height of the image in pixels (photo/video)

      • setHeight

        public Media setHeight​(int theInteger)
        Sets the value for height ()

        Definition: Height of the image in pixels (photo/video)

      • getWidthElement

        public ca.uhn.fhir.model.primitive.PositiveIntDt getWidthElement()
        Gets the value(s) for width (). creating it if it does not exist. Will not return null.

        Definition: Width of the image in pixels (photo/video)

      • getWidth

        public Integer getWidth()
        Gets the value(s) for width (). creating it if it does not exist. This method may return null.

        Definition: Width of the image in pixels (photo/video)

      • setWidth

        public Media setWidth​(ca.uhn.fhir.model.primitive.PositiveIntDt theValue)
        Sets the value(s) for width ()

        Definition: Width of the image in pixels (photo/video)

      • setWidth

        public Media setWidth​(int theInteger)
        Sets the value for width ()

        Definition: Width of the image in pixels (photo/video)

      • getFramesElement

        public ca.uhn.fhir.model.primitive.PositiveIntDt getFramesElement()
        Gets the value(s) for frames (). creating it if it does not exist. Will not return null.

        Definition: 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

      • getFrames

        public Integer getFrames()
        Gets the value(s) for frames (). creating it if it does not exist. This method may return null.

        Definition: 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​(ca.uhn.fhir.model.primitive.PositiveIntDt theValue)
        Sets the value(s) for frames ()

        Definition: 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 theInteger)
        Sets the value for frames ()

        Definition: 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 ca.uhn.fhir.model.primitive.UnsignedIntDt getDurationElement()
        Gets the value(s) for duration (). creating it if it does not exist. Will not return null.

        Definition: The duration of the recording in seconds - for audio and video

      • getDuration

        public Integer getDuration()
        Gets the value(s) for duration (). creating it if it does not exist. This method may return null.

        Definition: The duration of the recording in seconds - for audio and video

      • setDuration

        public Media setDuration​(ca.uhn.fhir.model.primitive.UnsignedIntDt theValue)
        Sets the value(s) for duration ()

        Definition: The duration of the recording in seconds - for audio and video

      • setDuration

        public Media setDuration​(int theInteger)
        Sets the value for duration ()

        Definition: The duration of the recording in seconds - for audio and video

      • getContent

        public AttachmentDt getContent()
        Gets the value(s) for content (). creating it if it does not exist. Will not return null.

        Definition: The actual content of the media - inline or by direct reference to the media source file

      • setContent

        public Media setContent​(AttachmentDt theValue)
        Sets the value(s) for content ()

        Definition: The actual content of the media - inline or by direct reference to the media source file

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource