Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.Media

class HS.FHIR.DTL.vR4.Model.Resource.Media extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

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

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = Media;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = 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 basedOn as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

Procedure that caused this media to be created.

ServiceRequest | CarePlan

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property bodySite as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "bodySite", XMLPROJECTION = "ELEMENT");
CodeableConcept

Observed body part.

any FHIR4 code may be used; body-site shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property content as HS.FHIR.DTL.vR4.Model.Datatype.Attachment (XMLNAME = "content", XMLPROJECTION = "ELEMENT") [ Required ];
Attachment

Actual Media - reference or data.

Property methods: contentGet(), contentGetSwizzled(), contentIsValid(), contentNewObject(), contentSet()
property createdDateTime as %String (MAXLEN = 1000000, XMLNAME = "createdDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

When Media was collected.

Property methods: createdDateTimeDisplayToLogical(), createdDateTimeGet(), createdDateTimeIsValid(), createdDateTimeLogicalToDisplay(), createdDateTimeLogicalToOdbc(), createdDateTimeNormalize(), createdDateTimeSet()
property createdPeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "createdPeriod", XMLPROJECTION = "ELEMENT");
Period

When Media was collected.

Property methods: createdPeriodGet(), createdPeriodGetSwizzled(), createdPeriodIsValid(), createdPeriodNewObject(), createdPeriodSet()
property device as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "device", XMLPROJECTION = "ELEMENT");
Reference

Observing Device.

Device | DeviceMetric | Device

Property methods: deviceGet(), deviceGetSwizzled(), deviceIsValid(), deviceNameDisplayToLogical(), deviceNameGet(), deviceNameIsValid(), deviceNameLogicalToDisplay(), deviceNameLogicalToOdbc(), deviceNameNormalize(), deviceNameSet(), deviceNewObject(), deviceSet()
property deviceName as %String (MAXLEN = 1000000, XMLNAME = "deviceName", XMLPROJECTION = "ATTRIBUTE");
string

Name of the device/manufacturer.

Property methods: deviceNameDisplayToLogical(), deviceNameGet(), deviceNameIsValid(), deviceNameLogicalToDisplay(), deviceNameLogicalToOdbc(), deviceNameNormalize(), deviceNameSet()
property duration as %Decimal (XMLNAME = "duration", XMLPROJECTION = "ATTRIBUTE");
decimal

Length in seconds (audio / video)

Property methods: durationDisplayToLogical(), durationGet(), durationIsValid(), durationLogicalToDisplay(), durationNormalize(), durationSet(), durationXSDToLogical()
property encounter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

Encounter associated with media.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property frames as %Integer (XMLNAME = "frames", XMLPROJECTION = "ATTRIBUTE");
positiveInt

Number of frames if > 1 (photo)

Property methods: framesDisplayToLogical(), framesGet(), framesIsValid(), framesLogicalToDisplay(), framesNormalize(), framesSet(), framesXSDToLogical()
property height as %Integer (XMLNAME = "height", XMLPROJECTION = "ATTRIBUTE");
positiveInt

Height of the image in pixels (photo/video)

Property methods: heightDisplayToLogical(), heightGet(), heightIsValid(), heightLogicalToDisplay(), heightNormalize(), heightSet(), heightXSDToLogical()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Identifier(s) for the image.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property issued as %String (MAXLEN = 1000000, XMLNAME = "issued", XMLPROJECTION = "ATTRIBUTE");
instant

Date/Time this version was made available.

Property methods: issuedDisplayToLogical(), issuedGet(), issuedIsValid(), issuedLogicalToDisplay(), issuedLogicalToOdbc(), issuedNormalize(), issuedSet()
property modality as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "modality", XMLPROJECTION = "ELEMENT");
CodeableConcept

The type of acquisition equipment/process.

any FHIR4 code may be used; media-modality shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: modalityGet(), modalityGetSwizzled(), modalityIsValid(), modalityNewObject(), modalitySet()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Comments made about the media.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property operator as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "operator", XMLPROJECTION = "ELEMENT");
Reference

The person who generated the image.

Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson

Property methods: operatorGet(), operatorGetSwizzled(), operatorIsValid(), operatorNewObject(), operatorSet()
property partOf as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
Reference

Part of referenced event.

Any FHIR4 Resource may be indicated by this Reference

Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property reasonCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why was event performed?

any FHIR4 code may be used; procedure-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown

event-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend event-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
Reference

Who/What this Media is a record of.

Patient | Practitioner | PractitionerRole | Group | Device | Specimen | Location

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

Classification of media as image, video, or audio.

media-type is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in media-type, you may formally EXTEND media-type to add codes to it.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property view as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "view", XMLPROJECTION = "ELEMENT");
CodeableConcept

Imaging view, e.g. Lateral or Antero-posterior.

any FHIR4 code may be used; media-view shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: viewGet(), viewGetSwizzled(), viewIsValid(), viewNewObject(), viewSet()
property width as %Integer (XMLNAME = "width", XMLPROJECTION = "ATTRIBUTE");
positiveInt

Width of the image in pixels (photo/video)

Property methods: widthDisplayToLogical(), widthGet(), widthIsValid(), widthLogicalToDisplay(), widthNormalize(), widthSet(), widthXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab