Media (HAPI FHIR - Core Library 0.7 API)

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

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class Media
extends BaseResource
implements IResource
```
HAPI/FHIR Media Resource (A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference)
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

Field Summary

Fields
Modifier and Type	Field and Description
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`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_SUBJECT` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`OPERATOR` Fluent Client search parameter constant for operator
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_OPERATOR` Search parameter constant for operator
`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.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

Media()

Constructors
Constructor and Description
`Media()`

Method Summary

Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (Identifier(s) for the image)
`Media`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (Identifier(s) for the image)
`Media`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (Identifier(s) for the image)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`AttachmentDt`	`getContent()` Gets the value(s) for content (Actual Media - reference or data).
`DateTimeDt`	`getDateTime()` Gets the value(s) for dateTime (When the media was taken/recorded (end)).
`StringDt`	`getDeviceName()` Gets the value(s) for deviceName (Name of the device/manufacturer).
`IntegerDt`	`getFrames()` Gets the value(s) for frames (Number of frames if > 1 (photo)).
`IntegerDt`	`getHeight()` Gets the value(s) for height (Height of the image in pixels(photo/video)).
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (Identifier(s) for the image).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (Identifier(s) for the image), creating it if it does not already exist.
`IntegerDt`	`getLength()` Gets the value(s) for length (Length in seconds (audio / video)).
`ResourceReferenceDt`	`getOperator()` Gets the value(s) for operator (The person who generated the image).
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject (Who/What this Media is a record of).
`CodeableConceptDt`	`getSubtype()` Gets the value(s) for subtype (The type of acquisition equipment/process).
`BoundCodeDt<MediaTypeEnum>`	`getType()` Gets the value(s) for type (photo \| video \| audio).
`CodeableConceptDt`	`getView()` Gets the value(s) for view (Imaging view e.g Lateral or Antero-posterior).
`IntegerDt`	`getWidth()` Gets the value(s) for width (Width of the image in pixels (photo/video)).
`boolean`	`isEmpty()`
`Media`	`setContent(AttachmentDt theValue)` Sets the value(s) for content (Actual Media - reference or data)
`Media`	`setDateTime(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for dateTime (When the media was taken/recorded (end))
`Media`	`setDateTime(DateTimeDt theValue)` Sets the value(s) for dateTime (When the media was taken/recorded (end))
`Media`	`setDateTimeWithSecondsPrecision(Date theDate)` Sets the value for dateTime (When the media was taken/recorded (end))
`Media`	`setDeviceName(String theString)` Sets the value for deviceName (Name of the device/manufacturer)
`Media`	`setDeviceName(StringDt theValue)` Sets the value(s) for deviceName (Name of the device/manufacturer)
`Media`	`setFrames(int theInteger)` Sets the value for frames (Number of frames if > 1 (photo))
`Media`	`setFrames(IntegerDt theValue)` Sets the value(s) for frames (Number of frames if > 1 (photo))
`Media`	`setHeight(int theInteger)` Sets the value for height (Height of the image in pixels(photo/video))
`Media`	`setHeight(IntegerDt theValue)` Sets the value(s) for height (Height of the image in pixels(photo/video))
`Media`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (Identifier(s) for the image)
`Media`	`setLength(int theInteger)` Sets the value for length (Length in seconds (audio / video))
`Media`	`setLength(IntegerDt theValue)` Sets the value(s) for length (Length in seconds (audio / video))
`Media`	`setOperator(ResourceReferenceDt theValue)` Sets the value(s) for operator (The person who generated the image)
`Media`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject (Who/What this Media is a record of)
`Media`	`setSubtype(CodeableConceptDt theValue)` Sets the value(s) for subtype (The type of acquisition equipment/process)
`Media`	`setType(BoundCodeDt<MediaTypeEnum> theValue)` Sets the value(s) for type (photo \| video \| audio)
`Media`	`setType(MediaTypeEnum theValue)` Sets the value(s) for type (photo \| video \| audio)
`Media`	`setView(CodeableConceptDt theValue)` Sets the value(s) for view (Imaging view e.g Lateral or Antero-posterior)
`Media`	`setWidth(int theInteger)` Sets the value for width (Width of the image in pixels (photo/video))
`Media`	`setWidth(IntegerDt theValue)` Sets the value(s) for width (Width of the image in pixels (photo/video))

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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

- 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_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description:
    Type: date
    Path: Media.dateTime
    
    See Also:
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description:
    Type: date
    Path: Media.dateTime
  - 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
  - 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".
  - 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
  - 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".
  - 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
- Constructor Detail
  - Media
```
public Media()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getType
```
public BoundCodeDt<MediaTypeEnum> getType()
```
    Gets the value(s) for type (photo | video | audio). 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<MediaTypeEnum> theValue)
```
    Sets the value(s) for type (photo | video | audio)
    Definition: Whether the media is a photo (still image), an audio recording, or a video recording
  - setType
```
public Media setType(MediaTypeEnum theValue)
```
    Sets the value(s) for type (photo | video | audio)
    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 (The type of acquisition equipment/process). 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 (The type of acquisition equipment/process)
    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 (Identifier(s) for the image). 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 (Identifier(s) for the image)
    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 (Identifier(s) for the image)
    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
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (Identifier(s) for the image), 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
  - addIdentifier
```
public Media addIdentifier(IdentifierUseEnum theUse,
                  String theSystem,
                  String theValue,
                  String theLabel)
```
    Adds a new value for identifier (Identifier(s) for the image)
    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
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public Media addIdentifier(String theSystem,
                  String theValue)
```
    Adds a new value for identifier (Identifier(s) for the image)
    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
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getDateTime
```
public DateTimeDt getDateTime()
```
    Gets the value(s) for dateTime (When the media was taken/recorded (end)). creating it if it does not exist. Will not return null.
    Definition: When the media was originally recorded. For video and audio, if the length of the recording is not insignificant, this is the end of the recording
  - setDateTime
```
public Media setDateTime(DateTimeDt theValue)
```
    Sets the value(s) for dateTime (When the media was taken/recorded (end))
    Definition: When the media was originally recorded. For video and audio, if the length of the recording is not insignificant, this is the end of the recording
  - setDateTimeWithSecondsPrecision
```
public Media setDateTimeWithSecondsPrecision(Date theDate)
```
    Sets the value for dateTime (When the media was taken/recorded (end))
    Definition: When the media was originally recorded. For video and audio, if the length of the recording is not insignificant, this is the end of the recording
  - setDateTime
```
public Media setDateTime(Date theDate,
                TemporalPrecisionEnum thePrecision)
```
    Sets the value for dateTime (When the media was taken/recorded (end))
    Definition: When the media was originally recorded. For video and audio, if the length of the recording is not insignificant, this is the end of the recording
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (Who/What this Media is a record of). 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/What this Media is a record of)
    Definition: Who/What this Media is a record of
  - getOperator
```
public ResourceReferenceDt getOperator()
```
    Gets the value(s) for operator (The person who generated the image). 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 (The person who generated the image)
    Definition: The person who administered the collection of the image
  - getView
```
public CodeableConceptDt getView()
```
    Gets the value(s) for view (Imaging view e.g Lateral or Antero-posterior). 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 (Imaging view e.g Lateral or Antero-posterior)
    Definition: The name of the imaging view e.g Lateral or Antero-posterior (AP).
  - getDeviceName
```
public StringDt getDeviceName()
```
    Gets the value(s) for deviceName (Name of the device/manufacturer). 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 (Name of the device/manufacturer)
    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 (Name of the device/manufacturer)
    Definition: The name of the device / manufacturer of the device that was used to make the recording
  - getHeight
```
public IntegerDt getHeight()
```
    Gets the value(s) for height (Height of the image in pixels(photo/video)). creating it if it does not exist. Will not return null.
    Definition: Height of the image in pixels(photo/video)
  - setHeight
```
public Media setHeight(IntegerDt theValue)
```
    Sets the value(s) for height (Height of the image in pixels(photo/video))
    Definition: Height of the image in pixels(photo/video)
  - setHeight
```
public Media setHeight(int theInteger)
```
    Sets the value for height (Height of the image in pixels(photo/video))
    Definition: Height of the image in pixels(photo/video)
  - getWidth
```
public IntegerDt getWidth()
```
    Gets the value(s) for width (Width of the image in pixels (photo/video)). creating it if it does not exist. Will not return null.
    Definition: Width of the image in pixels (photo/video)
  - setWidth
```
public Media setWidth(IntegerDt theValue)
```
    Sets the value(s) for width (Width of the image in pixels (photo/video))
    Definition: Width of the image in pixels (photo/video)
  - setWidth
```
public Media setWidth(int theInteger)
```
    Sets the value for width (Width of the image in pixels (photo/video))
    Definition: Width of the image in pixels (photo/video)
  - getFrames
```
public IntegerDt getFrames()
```
    Gets the value(s) for frames (Number of frames if > 1 (photo)). 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(IntegerDt theValue)
```
    Sets the value(s) for frames (Number of frames if > 1 (photo))
    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 (Number of frames if > 1 (photo))
    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
  - getLength
```
public IntegerDt getLength()
```
    Gets the value(s) for length (Length in seconds (audio / video)). creating it if it does not exist. Will not return null.
    Definition: The length of the recording in seconds - for audio and video
  - setLength
```
public Media setLength(IntegerDt theValue)
```
    Sets the value(s) for length (Length in seconds (audio / video))
    Definition: The length of the recording in seconds - for audio and video
  - setLength
```
public Media setLength(int theInteger)
```
    Sets the value for length (Length in seconds (audio / video))
    Definition: The length of the recording in seconds - for audio and video
  - getContent
```
public AttachmentDt getContent()
```
    Gets the value(s) for content (Actual Media - reference or data). 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 (Actual Media - reference or data)
    Definition: The actual content of the media - inline or by direct reference to the media source file

Class Media

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.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

Field Detail

SP_TYPE

TYPE

SP_SUBTYPE

SUBTYPE

SP_IDENTIFIER

IDENTIFIER

SP_DATE

DATE

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_OPERATOR

OPERATOR

INCLUDE_OPERATOR

SP_VIEW

VIEW

Constructor Detail

Media

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getType

setType

setType

getSubtype

setSubtype

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getDateTime

setDateTime

setDateTimeWithSecondsPrecision

setDateTime

getSubject

setSubject

getOperator

setOperator

getView

setView

getDeviceName

setDeviceName

setDeviceName

getHeight

setHeight

setHeight

getWidth

setWidth

setWidth

getFrames

setFrames

setFrames

getLength

setLength

setLength

getContent

setContent