Media (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.Media

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class Media
extends BaseResource
implements 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 Summary

Fields
Modifier and Type	Field and Description
`static DateClientParam`	`CREATED` Fluent Client search parameter constant for created
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_OPERATOR` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`OPERATOR` Fluent Client search parameter constant for operator
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static String`	`SP_CREATED` Search parameter constant for created
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_OPERATOR` Search parameter constant for operator
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static String`	`SP_SUBTYPE` Search parameter constant for subtype
`static String`	`SP_TYPE` Search parameter constant for type
`static String`	`SP_VIEW` Search parameter constant for view
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`static TokenClientParam`	`SUBTYPE` Fluent Client search parameter constant for subtype
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type
`static TokenClientParam`	`VIEW` Fluent Client search parameter constant for view

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

Media()

Constructors
Constructor and Description
`Media()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (id)
`Media`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier (id)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`AttachmentDt`	`getContent()` Gets the value(s) for content ().
`String`	`getDeviceName()` Gets the value(s) for deviceName ().
`StringDt`	`getDeviceNameElement()` Gets the value(s) for deviceName ().
`Integer`	`getDuration()` Gets the value(s) for duration ().
`UnsignedIntDt`	`getDurationElement()` Gets the value(s) for duration ().
`Integer`	`getFrames()` Gets the value(s) for frames ().
`PositiveIntDt`	`getFramesElement()` Gets the value(s) for frames ().
`Integer`	`getHeight()` Gets the value(s) for height ().
`PositiveIntDt`	`getHeightElement()` Gets the value(s) for height ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (id).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (id), creating it if it does not already exist.
`ResourceReferenceDt`	`getOperator()` Gets the value(s) for operator (who.actor).
`String`	`getResourceName()`
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject (who.focus).
`CodeableConceptDt`	`getSubtype()` Gets the value(s) for subtype (class).
`String`	`getType()` Gets the value(s) for type (class).
`BoundCodeDt<DigitalMediaTypeEnum>`	`getTypeElement()` Gets the value(s) for type (class).
`CodeableConceptDt`	`getView()` Gets the value(s) for view (class).
`Integer`	`getWidth()` Gets the value(s) for width ().
`PositiveIntDt`	`getWidthElement()` Gets the value(s) for width ().
`boolean`	`isEmpty()`
`Media`	`setContent(AttachmentDt theValue)` Sets the value(s) for content ()
`Media`	`setDeviceName(String theString)` Sets the value for deviceName ()
`Media`	`setDeviceName(StringDt theValue)` Sets the value(s) for deviceName ()
`Media`	`setDuration(int theInteger)` Sets the value for duration ()
`Media`	`setDuration(UnsignedIntDt theValue)` Sets the value(s) for duration ()
`Media`	`setFrames(int theInteger)` Sets the value for frames ()
`Media`	`setFrames(PositiveIntDt theValue)` Sets the value(s) for frames ()
`Media`	`setHeight(int theInteger)` Sets the value for height ()
`Media`	`setHeight(PositiveIntDt theValue)` Sets the value(s) for height ()
`Media`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (id)
`Media`	`setOperator(ResourceReferenceDt theValue)` Sets the value(s) for operator (who.actor)
`Media`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject (who.focus)
`Media`	`setSubtype(CodeableConceptDt theValue)` Sets the value(s) for subtype (class)
`Media`	`setType(BoundCodeDt<DigitalMediaTypeEnum> theValue)` Sets the value(s) for type (class)
`Media`	`setType(DigitalMediaTypeEnum theValue)` Sets the value(s) for type (class)
`Media`	`setView(CodeableConceptDt theValue)` Sets the value(s) for view (class)
`Media`	`setWidth(int theInteger)` Sets the value for width ()
`Media`	`setWidth(PositiveIntDt theValue)` Sets the value(s) for width ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId

- Field Detail
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter constant for type
    Description:
    Type: token
    Path: Media.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description:
    Type: token
    Path: Media.type
  - SP_SUBTYPE
```
public static final String SP_SUBTYPE
```
    Search parameter constant for subtype
    Description:
    Type: token
    Path: Media.subtype
    
    See Also:
    
    Constant Field Values
  - SUBTYPE
```
public static final TokenClientParam SUBTYPE
```
    Fluent Client search parameter constant for subtype
    Description:
    Type: token
    Path: Media.subtype
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description:
    Type: token
    Path: Media.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description:
    Type: token
    Path: Media.identifier
  - SP_CREATED
```
public static final String SP_CREATED
```
    Search parameter constant for created
    Description:
    Type: date
    Path: Media.content.creation
    
    See Also:
    
    Constant Field Values
  - CREATED
```
public static final DateClientParam CREATED
```
    Fluent Client search parameter constant for created
    Description:
    Type: date
    Path: Media.content.creation
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description:
    Type: reference
    Path: Media.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description:
    Type: reference
    Path: Media.subject
  - SP_OPERATOR
```
public static final String SP_OPERATOR
```
    Search parameter constant for operator
    Description:
    Type: reference
    Path: Media.operator
    
    See Also:
    
    Constant Field Values
  - OPERATOR
```
public static final ReferenceClientParam OPERATOR
```
    Fluent Client search parameter constant for operator
    Description:
    Type: reference
    Path: Media.operator
  - SP_VIEW
```
public static final String SP_VIEW
```
    Search parameter constant for view
    Description:
    Type: token
    Path: Media.view
    
    See Also:
    
    Constant Field Values
  - VIEW
```
public static final TokenClientParam VIEW
```
    Fluent Client search parameter constant for view
    Description:
    Type: token
    Path: Media.view
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description:
    Type: reference
    Path: Media.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description:
    Type: reference
    Path: Media.subject
  - INCLUDE_OPERATOR
```
public static final 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 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 Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:subject".
- Constructor Detail
  - Media
```
public Media()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getTypeElement
```
public BoundCodeDt<DigitalMediaTypeEnum> getTypeElement()
```
    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. Will not return null.
    Definition: Whether the media is a photo (still image), an audio recording, or a video recording
  - setType
```
public Media setType(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<IdentifierDt> getIdentifier()
```
    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
  - setSubject
```
public Media setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject (who.focus)
    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 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. Will not return null.
    Definition: The name of the device / manufacturer of the device that was used to make the recording
  - setDeviceName
```
public Media setDeviceName(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 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. Will not return null.
    Definition: Height of the image in pixels (photo/video)
  - setHeight
```
public Media setHeight(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 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. Will not return null.
    Definition: Width of the image in pixels (photo/video)
  - setWidth
```
public Media setWidth(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 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. 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
  - setFrames
```
public Media setFrames(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 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. Will not return null.
    Definition: The duration of the recording in seconds - for audio and video
  - setDuration
```
public Media setDuration(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 IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class Media

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

SP_TYPE

TYPE

SP_SUBTYPE

SUBTYPE

SP_IDENTIFIER

IDENTIFIER

SP_CREATED

CREATED

SP_SUBJECT

SUBJECT

SP_OPERATOR

OPERATOR

SP_VIEW

VIEW

SP_PATIENT

PATIENT

INCLUDE_OPERATOR

INCLUDE_PATIENT

INCLUDE_SUBJECT

Constructor Detail

Media

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getTypeElement

getType

setType

setType

getSubtype

setSubtype

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getSubject

setSubject

getOperator

setOperator

getView

setView

getDeviceNameElement

getDeviceName

setDeviceName

setDeviceName

getHeightElement

getHeight

setHeight

setHeight

getWidthElement

getWidth

setWidth

setWidth

getFramesElement

getFrames

setFrames

setFrames

getDurationElement

getDuration

setDuration

setDuration

getContent

setContent

getResourceName

getStructureFhirVersionEnum