
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
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 Description static ca.uhn.fhir.rest.gclient.DateClientParam
CREATED
Fluent Client search parameter constant for createdstatic ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_OPERATOR
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
OPERATOR
Fluent Client search parameter constant for operatorstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientstatic String
SP_CREATED
Search parameter constant for createdstatic String
SP_IDENTIFIER
Search parameter constant for identifierstatic String
SP_OPERATOR
Search parameter constant for operatorstatic String
SP_PATIENT
Search parameter constant for patientstatic String
SP_SUBJECT
Search parameter constant for subjectstatic String
SP_SUBTYPE
Search parameter constant for subtypestatic String
SP_TYPE
Search parameter constant for typestatic String
SP_VIEW
Search parameter constant for viewstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUBJECT
Fluent Client search parameter constant for subjectstatic ca.uhn.fhir.rest.gclient.TokenClientParam
SUBTYPE
Fluent Client search parameter constant for subtypestatic ca.uhn.fhir.rest.gclient.TokenClientParam
TYPE
Fluent Client search parameter constant for typestatic ca.uhn.fhir.rest.gclient.TokenClientParam
VIEW
Fluent Client search parameter constant for viewFields 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 Description Media()
-
Method Summary
Modifier and Type Method 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 ca.uhn.fhir.model.api.IElement>
List<T>getAllPopulatedChildElementsOfType(Class<T> theType)
AttachmentDt
getContent()
Gets the value(s) for content ().String
getDeviceName()
Gets the value(s) for deviceName ().ca.uhn.fhir.model.primitive.StringDt
getDeviceNameElement()
Gets the value(s) for deviceName ().Integer
getDuration()
Gets the value(s) for duration ().ca.uhn.fhir.model.primitive.UnsignedIntDt
getDurationElement()
Gets the value(s) for duration ().Integer
getFrames()
Gets the value(s) for frames ().ca.uhn.fhir.model.primitive.PositiveIntDt
getFramesElement()
Gets the value(s) for frames ().Integer
getHeight()
Gets the value(s) for height ().ca.uhn.fhir.model.primitive.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()
ca.uhn.fhir.context.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).ca.uhn.fhir.model.primitive.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 ().ca.uhn.fhir.model.primitive.PositiveIntDt
getWidthElement()
Gets the value(s) for width ().boolean
isEmpty()
Media
setContent(AttachmentDt theValue)
Sets the value(s) for content ()Media
setDeviceName(ca.uhn.fhir.model.primitive.StringDt theValue)
Sets the value(s) for deviceName ()Media
setDeviceName(String theString)
Sets the value for deviceName ()Media
setDuration(int theInteger)
Sets the value for duration ()Media
setDuration(ca.uhn.fhir.model.primitive.UnsignedIntDt theValue)
Sets the value(s) for duration ()Media
setFrames(int theInteger)
Sets the value for frames ()Media
setFrames(ca.uhn.fhir.model.primitive.PositiveIntDt theValue)
Sets the value(s) for frames ()Media
setHeight(int theInteger)
Sets the value for height ()Media
setHeight(ca.uhn.fhir.model.primitive.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(DigitalMediaTypeEnum theValue)
Sets the value(s) for type (class)Media
setType(ca.uhn.fhir.model.primitive.BoundCodeDt<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(ca.uhn.fhir.model.primitive.PositiveIntDt theValue)
Sets the value(s) for width ()Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getMeta, 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, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId
Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata
-
Field Details
-
SP_TYPE
Search parameter constant for typeDescription:
Type: token
Path: Media.type
- See Also:
- Constant Field Values
-
TYPE
Fluent Client search parameter constant for typeDescription:
Type: token
Path: Media.type
-
SP_SUBTYPE
Search parameter constant for subtypeDescription:
Type: token
Path: Media.subtype
- See Also:
- Constant Field Values
-
SUBTYPE
Fluent Client search parameter constant for subtypeDescription:
Type: token
Path: Media.subtype
-
SP_IDENTIFIER
Search parameter constant for identifierDescription:
Type: token
Path: Media.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription:
Type: token
Path: Media.identifier
-
SP_CREATED
Search parameter constant for createdDescription:
Type: date
Path: Media.content.creation
- See Also:
- Constant Field Values
-
CREATED
Fluent Client search parameter constant for createdDescription:
Type: date
Path: Media.content.creation
-
SP_SUBJECT
Search parameter constant for subjectDescription:
Type: reference
Path: Media.subject
- See Also:
- Constant Field Values
-
SUBJECT
Fluent Client search parameter constant for subjectDescription:
Type: reference
Path: Media.subject
-
SP_OPERATOR
Search parameter constant for operatorDescription:
Type: reference
Path: Media.operator
- See Also:
- Constant Field Values
-
OPERATOR
Fluent Client search parameter constant for operatorDescription:
Type: reference
Path: Media.operator
-
SP_VIEW
Search parameter constant for viewDescription:
Type: token
Path: Media.view
- See Also:
- Constant Field Values
-
VIEW
Fluent Client search parameter constant for viewDescription:
Type: token
Path: Media.view
-
SP_PATIENT
Search parameter constant for patientDescription:
Type: reference
Path: Media.subject
- See Also:
- Constant Field Values
-
PATIENT
Fluent Client search parameter constant for patientDescription:
Type: reference
Path: Media.subject
-
INCLUDE_OPERATOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:operator". -
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:patient". -
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Media:subject".
-
-
Constructor Details
-
Media
public Media()
-
-
Method Details
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.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 interfaceca.uhn.fhir.model.api.ICompositeElement
-
getTypeElement
Gets the value(s) for type (class). creating it if it does not exist. Will not returnnull
.Definition: Whether the media is a photo (still image), an audio recording, or a video recording
-
getType
Gets the value(s) for type (class). creating it if it does not exist. This method may returnnull
.Definition: Whether the media is a photo (still image), an audio recording, or a video recording
-
setType
Sets the value(s) for type (class)Definition: Whether the media is a photo (still image), an audio recording, or a video recording
-
setType
Sets the value(s) for type (class)Definition: Whether the media is a photo (still image), an audio recording, or a video recording
-
getSubtype
Gets the value(s) for subtype (class). creating it if it does not exist. Will not returnnull
.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
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
Gets the value(s) for identifier (id). creating it if it does not exist. Will not returnnull
.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
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
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
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 benull
)
-
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
Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not returnnull
.Definition: Who/What this Media is a record of
-
setSubject
Sets the value(s) for subject (who.focus)Definition: Who/What this Media is a record of
-
getOperator
Gets the value(s) for operator (who.actor). creating it if it does not exist. Will not returnnull
.Definition: The person who administered the collection of the image
-
setOperator
Sets the value(s) for operator (who.actor)Definition: The person who administered the collection of the image
-
getView
Gets the value(s) for view (class). creating it if it does not exist. Will not returnnull
.Definition: The name of the imaging view e.g. Lateral or Antero-posterior (AP).
-
setView
Sets the value(s) for view (class)Definition: The name of the imaging view e.g. Lateral or Antero-posterior (AP).
-
getDeviceNameElement
Gets the value(s) for deviceName (). creating it if it does not exist. Will not returnnull
.Definition: The name of the device / manufacturer of the device that was used to make the recording
-
getDeviceName
Gets the value(s) for deviceName (). creating it if it does not exist. This method may returnnull
.Definition: The name of the device / manufacturer of the device that was used to make the recording
-
setDeviceName
Sets the value(s) for deviceName ()Definition: The name of the device / manufacturer of the device that was used to make the recording
-
setDeviceName
Sets the value for deviceName ()Definition: The name of the device / manufacturer of the device that was used to make the recording
-
getHeightElement
Gets the value(s) for height (). creating it if it does not exist. Will not returnnull
.Definition: Height of the image in pixels (photo/video)
-
getHeight
Gets the value(s) for height (). creating it if it does not exist. This method may returnnull
.Definition: Height of the image in pixels (photo/video)
-
setHeight
Sets the value(s) for height ()Definition: Height of the image in pixels (photo/video)
-
setHeight
Sets the value for height ()Definition: Height of the image in pixels (photo/video)
-
getWidthElement
Gets the value(s) for width (). creating it if it does not exist. Will not returnnull
.Definition: Width of the image in pixels (photo/video)
-
getWidth
Gets the value(s) for width (). creating it if it does not exist. This method may returnnull
.Definition: Width of the image in pixels (photo/video)
-
setWidth
Sets the value(s) for width ()Definition: Width of the image in pixels (photo/video)
-
setWidth
Sets the value for width ()Definition: Width of the image in pixels (photo/video)
-
getFramesElement
Gets the value(s) for frames (). creating it if it does not exist. Will not returnnull
.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
Gets the value(s) for frames (). creating it if it does not exist. This method may returnnull
.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
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
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
Gets the value(s) for duration (). creating it if it does not exist. Will not returnnull
.Definition: The duration of the recording in seconds - for audio and video
-
getDuration
Gets the value(s) for duration (). creating it if it does not exist. This method may returnnull
.Definition: The duration of the recording in seconds - for audio and video
-
setDuration
Sets the value(s) for duration ()Definition: The duration of the recording in seconds - for audio and video
-
setDuration
Sets the value for duration ()Definition: The duration of the recording in seconds - for audio and video
-
getContent
Gets the value(s) for content (). creating it if it does not exist. Will not returnnull
.Definition: The actual content of the media - inline or by direct reference to the media source file
-
setContent
Sets the value(s) for content ()Definition: The actual content of the media - inline or by direct reference to the media source file
-
getResourceName
- Specified by:
getResourceName
in interfaceca.uhn.fhir.model.api.IResource
-
getStructureFhirVersionEnum
- Specified by:
getStructureFhirVersionEnum
in interfaceorg.hl7.fhir.instance.model.api.IBaseResource
- Specified by:
getStructureFhirVersionEnum
in interfaceca.uhn.fhir.model.api.IResource
-