Package org.hl7.fhir.dstu2.model
Class Media
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.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 Description static classMedia.DigitalMediaTypestatic classMedia.DigitalMediaTypeEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected AttachmentcontentThe actual content of the media - inline or by direct reference to the media source file.protected StringTypedeviceNameThe name of the device / manufacturer of the device that was used to make the recording.protected UnsignedIntTypedurationThe duration of the recording in seconds - for audio and video.protected PositiveIntTypeframesThe number of frames in a photo.protected PositiveIntTypeheightHeight of the image in pixels (photo/video).protected List<Identifier>identifierIdentifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g.protected ReferenceoperatorThe person who administered the collection of the image.protected PractitioneroperatorTargetThe actual object that is the target of the reference (The person who administered the collection of the image.)static StringSP_CREATEDstatic StringSP_IDENTIFIERstatic StringSP_OPERATORstatic StringSP_PATIENTstatic StringSP_SUBJECTstatic StringSP_SUBTYPEstatic StringSP_TYPEstatic StringSP_VIEWprotected ReferencesubjectWho/What this Media is a record of.protected ResourcesubjectTargetThe actual object that is the target of the reference (Who/What this Media is a record of.)protected CodeableConceptsubtypeDetails of the type of the media - usually, how it was acquired (what type of device).protected Enumeration<Media.DigitalMediaType>typeWhether the media is a photo (still image), an audio recording, or a video recording.protected CodeableConceptviewThe name of the imaging view e.g.protected PositiveIntTypewidthWidth of the image in pixels (photo/video).-
Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Media()Media(Enumeration<Media.DigitalMediaType> type, Attachment content)
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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
-
-
-
-
Field Detail
-
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.
-
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.
-
subjectTarget
protected Resource subjectTarget
The actual object that is the target of the reference (Who/What this Media is a record of.)
-
operatorTarget
protected Practitioner operatorTarget
The actual object that is the target of the reference (The person who administered the collection of the image.)
-
view
protected CodeableConcept view
The name of the imaging view e.g. Lateral or Antero-posterior (AP).
-
deviceName
protected StringType deviceName
The name of the device / manufacturer of the device that was used to make the recording.
-
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.
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
- See Also:
- Constant Field Values
-
SP_VIEW
public static final String SP_VIEW
- See Also:
- Constant Field Values
-
SP_SUBTYPE
public static final String SP_SUBTYPE
- See Also:
- Constant Field Values
-
SP_CREATED
public static final String SP_CREATED
- See Also:
- Constant Field Values
-
SP_SUBJECT
public static final String SP_SUBJECT
- See Also:
- Constant Field Values
-
SP_PATIENT
public static final String SP_PATIENT
- See Also:
- Constant Field Values
-
SP_TYPE
public static final String SP_TYPE
- See Also:
- Constant Field Values
-
SP_OPERATOR
public static final String SP_OPERATOR
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Media
public Media()
-
Media
public Media(Enumeration<Media.DigitalMediaType> type, Attachment content)
-
-
Method Detail
-
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.)
-
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.)
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
- 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.)
-
addIdentifier
public Media addIdentifier(Identifier t)
-
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:
subjectThe 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-subjectThe 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.)
-
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:
operatorThe 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-operatorThe 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.)
-
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).)
-
getDeviceNameElement
public StringType getDeviceNameElement()
- Returns:
deviceName(The name of the device / manufacturer of the device that was used to make the recording.). This is the underlying object with id, value and extensions. The accessor "getDeviceName" gives direct access to the value
-
hasDeviceNameElement
public boolean hasDeviceNameElement()
-
hasDeviceName
public boolean hasDeviceName()
-
setDeviceNameElement
public Media setDeviceNameElement(StringType value)
- Parameters:
value-deviceName(The name of the device / manufacturer of the device that was used to make the recording.). This is the underlying object with id, value and extensions. The accessor "getDeviceName" gives direct access to the value
-
getDeviceName
public String getDeviceName()
- Returns:
- The name of the device / manufacturer of the device that was used to make the recording.
-
setDeviceName
public Media setDeviceName(String value)
- Parameters:
value- The name of the device / manufacturer of the device that was used to make the recording.
-
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.)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Media copy()
- Specified by:
copyin classDomainResource
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-