Media (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.BaseResource
  - - org.hl7.fhir.dstu3.model.Resource
    - - org.hl7.fhir.dstu3.model.DomainResource
      - org.hl7.fhir.dstu3.model.Media

All Implemented Interfaces:

IElement, Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, 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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Media.DigitalMediaType

static class Media.DigitalMediaTypeEnumFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`Media.DigitalMediaType`
`static class`	`Media.DigitalMediaTypeEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`static ReferenceClientParam`	`BASED_ON` Fluent Client search parameter constant for based-on
`protected List<Reference>`	`basedOn` A procedure that is fulfilled in whole or in part by the creation of this media.
`protected List<ProcedureRequest>`	`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.)
`protected CodeableConcept`	`bodySite` Indicates the site on the subject's body where the media was collected (i.e.
`protected Attachment`	`content` The actual content of the media - inline or by direct reference to the media source file.
`protected Reference`	`context` The encounter or episode of care that establishes the context for this media.
`static ReferenceClientParam`	`CONTEXT` Fluent Client search parameter constant for context
`protected Resource`	`contextTarget` The actual object that is the target of the reference (The encounter or episode of care that establishes the context for this media.)
`static DateClientParam`	`CREATED` Fluent Client search parameter constant for created
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`protected Reference`	`device` The device used to collect the media.
`static ReferenceClientParam`	`DEVICE` Fluent Client search parameter constant for device
`protected Resource`	`deviceTarget` The actual object that is the target of the reference (The device used to collect the media.)
`protected UnsignedIntType`	`duration` The duration of the recording in seconds - for audio and video.
`protected PositiveIntType`	`frames` The number of frames in a photo.
`protected PositiveIntType`	`height` Height of the image in pixels (photo/video).
`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.
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_BASED_ON` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_CONTEXT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_DEVICE` Constant for fluent queries to be used to add include statements.
`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.
`protected List<Annotation>`	`note` Comments made about the media by the performer, subject or other participants.
`protected Type`	`occurrence` The date and time(s) at which the media was collected.
`protected Reference`	`operator` The person who administered the collection of the image.
`static ReferenceClientParam`	`OPERATOR` Fluent Client search parameter constant for operator
`protected Practitioner`	`operatorTarget` The actual object that is the target of the reference (The person who administered the collection of the image.)
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected List<CodeableConcept>`	`reasonCode` Describes why the event occurred in coded or textual form.
`static TokenClientParam`	`SITE` Fluent Client search parameter constant for site
`static String`	`SP_BASED_ON` Search parameter: based-on
`static String`	`SP_CONTEXT` Search parameter: context
`static String`	`SP_CREATED` Search parameter: created
`static String`	`SP_DATE` Search parameter: date
`static String`	`SP_DEVICE` Search parameter: device
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_OPERATOR` Search parameter: operator
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_SITE` Search parameter: site
`static String`	`SP_SUBJECT` Search parameter: subject
`static String`	`SP_SUBTYPE` Search parameter: subtype
`static String`	`SP_TYPE` Search parameter: type
`static String`	`SP_VIEW` Search parameter: view
`protected Reference`	`subject` Who/What this Media is a record of.
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`protected Resource`	`subjectTarget` The actual object that is the target of the reference (Who/What this Media is a record of.)
`protected CodeableConcept`	`subtype` Details of the type of the media - usually, how it was acquired (what type of device).
`static TokenClientParam`	`SUBTYPE` Fluent Client search parameter constant for subtype
`protected Enumeration<Media.DigitalMediaType>`	`type` Whether the media is a photo (still image), an audio recording, or a video recording.
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type
`protected CodeableConcept`	`view` The name of the imaging view e.g.
`static TokenClientParam`	`VIEW` Fluent Client search parameter constant for view
`protected PositiveIntType`	`width` Width of the image in pixels (photo/video).

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
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()
Constructor

Media(Enumeration<Media.DigitalMediaType> type, Attachment content)
Constructor

Constructors
Constructor and Description
`Media()` Constructor
`Media(Enumeration<Media.DigitalMediaType> type, Attachment content)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Reference`	`addBasedOn()`
`Media`	`addBasedOn(Reference t)`
`ProcedureRequest`	`addBasedOnTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`Media`	`addIdentifier(Identifier t)`
`Annotation`	`addNote()`
`Media`	`addNote(Annotation t)`
`CodeableConcept`	`addReasonCode()`
`Media`	`addReasonCode(CodeableConcept t)`
`Media`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`List<Reference>`	`getBasedOn()`
`Reference`	`getBasedOnFirstRep()`
`List<ProcedureRequest>`	`getBasedOnTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`CodeableConcept`	`getBodySite()`
`Attachment`	`getContent()`
`Reference`	`getContext()`
`Resource`	`getContextTarget()`
`Reference`	`getDevice()`
`Resource`	`getDeviceTarget()`
`int`	`getDuration()`
`UnsignedIntType`	`getDurationElement()`
`int`	`getFrames()`
`PositiveIntType`	`getFramesElement()`
`int`	`getHeight()`
`PositiveIntType`	`getHeightElement()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`List<Annotation>`	`getNote()`
`Annotation`	`getNoteFirstRep()`
`Type`	`getOccurrence()`
`DateTimeType`	`getOccurrenceDateTimeType()`
`Period`	`getOccurrencePeriod()`
`Reference`	`getOperator()`
`Practitioner`	`getOperatorTarget()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<CodeableConcept>`	`getReasonCode()`
`CodeableConcept`	`getReasonCodeFirstRep()`
`ResourceType`	`getResourceType()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`CodeableConcept`	`getSubtype()`
`Media.DigitalMediaType`	`getType()`
`Enumeration<Media.DigitalMediaType>`	`getTypeElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`CodeableConcept`	`getView()`
`int`	`getWidth()`
`PositiveIntType`	`getWidthElement()`
`boolean`	`hasBasedOn()`
`boolean`	`hasBodySite()`
`boolean`	`hasContent()`
`boolean`	`hasContext()`
`boolean`	`hasDevice()`
`boolean`	`hasDuration()`
`boolean`	`hasDurationElement()`
`boolean`	`hasFrames()`
`boolean`	`hasFramesElement()`
`boolean`	`hasHeight()`
`boolean`	`hasHeightElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasNote()`
`boolean`	`hasOccurrence()`
`boolean`	`hasOccurrenceDateTimeType()`
`boolean`	`hasOccurrencePeriod()`
`boolean`	`hasOperator()`
`boolean`	`hasReasonCode()`
`boolean`	`hasSubject()`
`boolean`	`hasSubtype()`
`boolean`	`hasType()`
`boolean`	`hasTypeElement()`
`boolean`	`hasView()`
`boolean`	`hasWidth()`
`boolean`	`hasWidthElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Media`	`setBasedOn(List<Reference> theBasedOn)`
`Media`	`setBodySite(CodeableConcept value)`
`Media`	`setContent(Attachment value)`
`Media`	`setContext(Reference value)`
`Media`	`setContextTarget(Resource value)`
`Media`	`setDevice(Reference value)`
`Media`	`setDeviceTarget(Resource value)`
`Media`	`setDuration(int value)`
`Media`	`setDurationElement(UnsignedIntType value)`
`Media`	`setFrames(int value)`
`Media`	`setFramesElement(PositiveIntType value)`
`Media`	`setHeight(int value)`
`Media`	`setHeightElement(PositiveIntType value)`
`Media`	`setIdentifier(List<Identifier> theIdentifier)`
`Media`	`setNote(List<Annotation> theNote)`
`Media`	`setOccurrence(Type value)`
`Media`	`setOperator(Reference value)`
`Media`	`setOperatorTarget(Practitioner value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Media`	`setReasonCode(List<CodeableConcept> theReasonCode)`
`Media`	`setSubject(Reference value)`
`Media`	`setSubjectTarget(Resource value)`
`Media`	`setSubtype(CodeableConcept value)`
`Media`	`setType(Media.DigitalMediaType value)`
`Media`	`setTypeElement(Enumeration<Media.DigitalMediaType> value)`
`Media`	`setView(CodeableConcept value)`
`Media`	`setWidth(int value)`
`Media`	`setWidthElement(PositiveIntType value)`
`protected Media`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- 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<ProcedureRequest> 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.)
  - type
```
protected Enumeration<Media.DigitalMediaType> type
```
    Whether the media is a photo (still image), an audio recording, or a video recording.
  - 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).
  - subject
```
protected Reference subject
```
    Who/What this Media is a record of.
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (Who/What this Media is a record of.)
  - context
```
protected Reference context
```
    The encounter or episode of care that establishes the context for this media.
  - contextTarget
```
protected Resource contextTarget
```
    The actual object that is the target of the reference (The encounter or episode of care that establishes the context for this media.)
  - occurrence
```
protected Type occurrence
```
    The date and time(s) at which the media was collected.
  - 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.)
  - reasonCode
```
protected List<CodeableConcept> reasonCode
```
    Describes why the event occurred in coded or textual form.
  - bodySite
```
protected CodeableConcept bodySite
```
    Indicates the site on the subject's body where the media was collected (i.e. the target site).
  - device
```
protected Reference device
```
    The device used to collect the media.
  - deviceTarget
```
protected Resource deviceTarget
```
    The actual object that is the target of the reference (The device used to collect the media.)
  - height
```
protected PositiveIntType height
```
    Height of the image in pixels (photo/video).
  - width
```
protected PositiveIntType width
```
    Width of the image in pixels (photo/video).
  - 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 UnsignedIntType 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.
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: When Media was collected
    Type: date
    Path: Media.occurrence[x]
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: When Media was collected
    Type: date
    Path: Media.occurrence[x]
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: Identifier(s) for the image
    Type: token
    Path: Media.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Identifier(s) for the image
    Type: token
    Path: Media.identifier
  - 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 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 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 Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:subject".
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter: type
    Description: photo | video | audio
    Type: token
    Path: Media.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: photo | video | 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 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 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 TokenClientParam VIEW
```
    Fluent Client search parameter constant for view
    Description: Imaging view, e.g. Lateral or Antero-posterior
    Type: token
    Path: Media.view
  - SP_SITE
```
public static final String SP_SITE
```
    Search parameter: site
    Description: Body part in media
    Type: token
    Path: Media.bodySite
    
    See Also:
    
    Constant Field Values
  - SITE
```
public static final TokenClientParam SITE
```
    Fluent Client search parameter constant for site
    Description: Body part in media
    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 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 Include INCLUDE_BASED_ON
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:based-on".
  - 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 TokenClientParam SUBTYPE
```
    Fluent Client search parameter constant for subtype
    Description: The type of acquisition equipment/process
    Type: token
    Path: Media.subtype
  - 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 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 Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:patient".
  - SP_CONTEXT
```
public static final String SP_CONTEXT
```
    Search parameter: context
    Description: Encounter / Episode associated with media
    Type: reference
    Path: Media.context
    
    See Also:
    
    Constant Field Values
  - CONTEXT
```
public static final ReferenceClientParam CONTEXT
```
    Fluent Client search parameter constant for context
    Description: Encounter / Episode associated with media
    Type: reference
    Path: Media.context
  - INCLUDE_CONTEXT
```
public static final Include INCLUDE_CONTEXT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:context".
  - SP_DEVICE
```
public static final String SP_DEVICE
```
    Search parameter: device
    Description: Observing Device
    Type: reference
    Path: Media.device
    
    See Also:
    
    Constant Field Values
  - DEVICE
```
public static final ReferenceClientParam DEVICE
```
    Fluent Client search parameter constant for device
    Description: Observing Device
    Type: reference
    Path: Media.device
  - INCLUDE_DEVICE
```
public static final Include INCLUDE_DEVICE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:device".
- Constructor Detail
  - Media
```
public Media()
```
    Constructor
  - Media
```
public Media(Enumeration<Media.DigitalMediaType> type,
             Attachment content)
```
    Constructor
- 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.)
  - setIdentifier
```
public Media setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public Media addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - getBasedOn
```
public List<Reference> getBasedOn()
```
    Returns:
    
    basedOn (A procedure that is fulfilled in whole or in part by the creation of this media.)
  - setBasedOn
```
public Media setBasedOn(List<Reference> theBasedOn)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasBasedOn
```
public boolean hasBasedOn()
```
  - addBasedOn
```
public Reference addBasedOn()
```
  - addBasedOn
```
public Media addBasedOn(Reference t)
```
  - getBasedOnFirstRep
```
public Reference getBasedOnFirstRep()
```
    Returns:
    
    The first repetition of repeating field basedOn, creating it if it does not already exist
  - getBasedOnTarget
```
@Deprecated
public List<ProcedureRequest> getBasedOnTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - addBasedOnTarget
```
@Deprecated
public ProcedureRequest addBasedOnTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - 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
  - hasTypeElement
```
public boolean hasTypeElement()
```
  - 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.)
  - hasSubtype
```
public boolean hasSubtype()
```
  - 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.)
  - getView
```
public CodeableConcept getView()
```
    Returns:
    
    view (The name of the imaging view e.g. Lateral or Antero-posterior (AP).)
  - hasView
```
public boolean hasView()
```
  - setView
```
public Media setView(CodeableConcept value)
```
    Parameters:
    
    value - view (The name of the imaging view e.g. Lateral or Antero-posterior (AP).)
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (Who/What this Media is a record of.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public Media setSubject(Reference value)
```
    Parameters:
    
    value - subject (Who/What this Media is a record of.)
  - 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.)
  - getContext
```
public Reference getContext()
```
    Returns:
    
    context (The encounter or episode of care that establishes the context for this media.)
  - hasContext
```
public boolean hasContext()
```
  - setContext
```
public Media setContext(Reference value)
```
    Parameters:
    
    value - context (The encounter or episode of care that establishes the context for this media.)
  - getContextTarget
```
public Resource getContextTarget()
```
    Returns:
    
    context 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 or episode of care that establishes the context for this media.)
  - setContextTarget
```
public Media setContextTarget(Resource value)
```
    Parameters:
    
    value - context 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 or episode of care that establishes the context for this media.)
  - getOccurrence
```
public Type getOccurrence()
```
    Returns:
    
    occurrence (The date and time(s) at which the media was collected.)
  - getOccurrenceDateTimeType
```
public DateTimeType getOccurrenceDateTimeType()
                                       throws FHIRException
```
    Returns:
    
    occurrence (The date and time(s) at which the media was collected.)
    
    Throws:
    
    FHIRException
  - hasOccurrenceDateTimeType
```
public boolean hasOccurrenceDateTimeType()
```
  - getOccurrencePeriod
```
public Period getOccurrencePeriod()
                           throws FHIRException
```
    Returns:
    
    occurrence (The date and time(s) at which the media was collected.)
    
    Throws:
    
    FHIRException
  - hasOccurrencePeriod
```
public boolean hasOccurrencePeriod()
```
  - hasOccurrence
```
public boolean hasOccurrence()
```
  - setOccurrence
```
public Media setOccurrence(Type value)
```
    Parameters:
    
    value - occurrence (The date and time(s) at which the media was collected.)
  - getOperator
```
public Reference getOperator()
```
    Returns:
    
    operator (The person who administered the collection of the image.)
  - hasOperator
```
public boolean hasOperator()
```
  - setOperator
```
public Media setOperator(Reference value)
```
    Parameters:
    
    value - operator (The person who administered the collection of the image.)
  - 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.)
  - getReasonCode
```
public List<CodeableConcept> getReasonCode()
```
    Returns:
    
    reasonCode (Describes why the event occurred in coded or textual form.)
  - setReasonCode
```
public Media setReasonCode(List<CodeableConcept> theReasonCode)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasReasonCode
```
public boolean hasReasonCode()
```
  - addReasonCode
```
public CodeableConcept addReasonCode()
```
  - addReasonCode
```
public Media addReasonCode(CodeableConcept t)
```
  - getReasonCodeFirstRep
```
public CodeableConcept getReasonCodeFirstRep()
```
    Returns:
    
    The first repetition of repeating field reasonCode, creating it if it does not already exist
  - getBodySite
```
public CodeableConcept getBodySite()
```
    Returns:
    
    bodySite (Indicates the site on the subject's body where the media was collected (i.e. the target site).)
  - hasBodySite
```
public boolean hasBodySite()
```
  - setBodySite
```
public Media setBodySite(CodeableConcept value)
```
    Parameters:
    
    value - bodySite (Indicates the site on the subject's body where the media was collected (i.e. the target site).)
  - getDevice
```
public Reference getDevice()
```
    Returns:
    
    device (The device used to collect the media.)
  - hasDevice
```
public boolean hasDevice()
```
  - setDevice
```
public Media setDevice(Reference value)
```
    Parameters:
    
    value - device (The device used to collect the media.)
  - 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
  - hasHeightElement
```
public boolean hasHeightElement()
```
  - hasHeight
```
public boolean hasHeight()
```
  - 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
  - hasWidthElement
```
public boolean hasWidthElement()
```
  - hasWidth
```
public boolean hasWidth()
```
  - 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
  - hasFramesElement
```
public boolean hasFramesElement()
```
  - hasFrames
```
public boolean hasFrames()
```
  - 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
  - hasDurationElement
```
public boolean hasDurationElement()
```
  - hasDuration
```
public boolean hasDuration()
```
  - 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.)
  - hasContent
```
public boolean hasContent()
```
  - 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.)
  - setNote
```
public Media setNote(List<Annotation> theNote)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasNote
```
public boolean hasNote()
```
  - addNote
```
public Annotation addNote()
```
  - addNote
```
public Media addNote(Annotation t)
```
  - getNoteFirstRep
```
public Annotation getNoteFirstRep()
```
    Returns:
    
    The first repetition of repeating field note, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Media copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected Media typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Media

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

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

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

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

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

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

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

Field Detail

identifier

basedOn

basedOnTarget

type

subtype

view

subject

subjectTarget

context

contextTarget

occurrence

operator

operatorTarget

reasonCode

bodySite

device

deviceTarget

height

width

frames

duration

content

note

SP_DATE

DATE

SP_IDENTIFIER

IDENTIFIER

SP_CREATED

CREATED

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_TYPE

TYPE

SP_OPERATOR

OPERATOR

INCLUDE_OPERATOR

SP_VIEW

VIEW

SP_SITE

SITE

SP_BASED_ON

BASED_ON

INCLUDE_BASED_ON

SP_SUBTYPE

SUBTYPE

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_CONTEXT

CONTEXT

INCLUDE_CONTEXT

SP_DEVICE

DEVICE

INCLUDE_DEVICE

Constructor Detail

Media

Media

Method Detail

getIdentifier

setIdentifier

hasIdentifier