Skip to main content

HS.FHIRModel.R4.Media

class HS.FHIRModel.R4.Media extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Media generated class schema
*****************************************
A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_MEDIA;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _createdDateTime as HS.FHIRModel.R4.Element;
Extensions for createdDateTime
Property methods: _createdDateTimeGet(), _createdDateTimeGetSwizzled(), _createdDateTimeIsValid(), _createdDateTimeNewObject(), _createdDateTimeSet()
property _deviceName as HS.FHIRModel.R4.Element;
Extensions for deviceName
Property methods: _deviceNameGet(), _deviceNameGetSwizzled(), _deviceNameIsValid(), _deviceNameNewObject(), _deviceNameSet()
property _duration as HS.FHIRModel.R4.Element;
Extensions for duration
Property methods: _durationGet(), _durationGetSwizzled(), _durationIsValid(), _durationNewObject(), _durationSet()
property _frames as HS.FHIRModel.R4.Element;
Extensions for frames
Property methods: _framesGet(), _framesGetSwizzled(), _framesIsValid(), _framesNewObject(), _framesSet()
property _height as HS.FHIRModel.R4.Element;
Extensions for height
Property methods: _heightGet(), _heightGetSwizzled(), _heightIsValid(), _heightNewObject(), _heightSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _issued as HS.FHIRModel.R4.Element;
Extensions for issued
Property methods: _issuedGet(), _issuedGetSwizzled(), _issuedIsValid(), _issuedNewObject(), _issuedSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _width as HS.FHIRModel.R4.Element;
Extensions for width
Property methods: _widthGet(), _widthGetSwizzled(), _widthIsValid(), _widthNewObject(), _widthSet()
property basedOn as HS.FHIRModel.R4.SeqOfReference;
A procedure that is fulfilled in whole or in part by the creation of this media.
Property methods: basedOnGet(), basedOnGetSwizzled(), basedOnIsValid(), basedOnNewObject(), basedOnSet()
property bodySite as HS.FHIRModel.R4.CodeableConcept;
Indicates the site on the subject's body where the observation was made (i.e. the target site).
Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property content as HS.FHIRModel.R4.Attachment [ Required ];
The actual content of the media - inline or by direct reference to the media source file.
Property methods: contentGet(), contentGetSwizzled(), contentIsValid(), contentNewObject(), contentSet()
property createdDateTime as %String;
The date and time(s) at which the media was collected.
Property methods: createdDateTimeDisplayToLogical(), createdDateTimeGet(), createdDateTimeIsValid(), createdDateTimeLogicalToDisplay(), createdDateTimeLogicalToOdbc(), createdDateTimeNormalize(), createdDateTimeSet()
property createdPeriod as HS.FHIRModel.R4.Period;
The date and time(s) at which the media was collected.
Property methods: createdPeriodGet(), createdPeriodGetSwizzled(), createdPeriodIsValid(), createdPeriodNewObject(), createdPeriodSet()
property device as HS.FHIRModel.R4.Reference;
The device used to collect the media.
Property methods: deviceGet(), deviceGetSwizzled(), deviceIsValid(), deviceNewObject(), deviceSet()
property deviceName as %String;
The name of the device / manufacturer of the device that was used to make the recording.
Property methods: deviceNameDisplayToLogical(), deviceNameGet(), deviceNameIsValid(), deviceNameLogicalToDisplay(), deviceNameLogicalToOdbc(), deviceNameNormalize(), deviceNameSet()
property duration as %Integer;
The duration of the recording in seconds - for audio and video.
Property methods: durationDisplayToLogical(), durationGet(), durationIsValid(), durationLogicalToDisplay(), durationNormalize(), durationSet(), durationXSDToLogical()
property encounter as HS.FHIRModel.R4.Reference;
The encounter that establishes the context for this media.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property frames as %Integer;
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.
Property methods: framesDisplayToLogical(), framesGet(), framesIsValid(), framesLogicalToDisplay(), framesNormalize(), framesSet(), framesXSDToLogical()
property height as %Integer;
Height of the image in pixels (photo/video).
Property methods: heightDisplayToLogical(), heightGet(), heightIsValid(), heightLogicalToDisplay(), heightNormalize(), heightSet(), heightXSDToLogical()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
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.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property issued as %String;
The date and time this version of the media was made available to providers, typically after having been reviewed.
Property methods: issuedDisplayToLogical(), issuedGet(), issuedIsValid(), issuedLogicalToDisplay(), issuedLogicalToOdbc(), issuedNormalize(), issuedSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modality as HS.FHIRModel.R4.CodeableConcept;
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.
Property methods: modalityGet(), modalityGetSwizzled(), modalityIsValid(), modalityNewObject(), modalitySet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Comments made about the media by the performer, subject or other participants.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property operator as HS.FHIRModel.R4.Reference;
The person who administered the collection of the image.
Property methods: operatorGet(), operatorGetSwizzled(), operatorIsValid(), operatorNewObject(), operatorSet()
property partOf as HS.FHIRModel.R4.SeqOfReference;
A larger event of which this particular event is a component or step.
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
Describes why the event occurred in coded or textual form.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property resourceType as %String [ InitialExpression = "Media" , Required ];
This is a Media resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String;
The current state of the {{title}}.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIRModel.R4.Reference;
Who/What this Media is a record of.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
A code that classifies whether the media is an image, video or audio recording or some other media category.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
The name of the imaging view e.g. Lateral or Antero-posterior (AP).
Property methods: viewGet(), viewGetSwizzled(), viewIsValid(), viewNewObject(), viewSet()
property width as %Integer;
Width of the image in pixels (photo/video).
Property methods: widthDisplayToLogical(), widthGet(), widthIsValid(), widthLogicalToDisplay(), widthNormalize(), widthSet(), widthXSDToLogical()

Methods

method IncludeBasedOn()
method IncludeBodySite()
method IncludeContained()
method IncludeContent()
method IncludeCreatedPeriod()
method IncludeDevice()
method IncludeEncounter()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMeta()
method IncludeModality()
method IncludeModifierExtension()
method IncludeNote()
method IncludeOperator()
method IncludePartOf()
method IncludeReasonCode()
method IncludeSubject()
method IncludeText()
method IncludeType()
method IncludeView()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.Media
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab