Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Class Details

Parameters (5)
Properties (19)
Inherited Members

Show private members

HS.FHIR.DTL.vSTU3.Model.Resource.Media

class HS.FHIR.DTL.vSTU3.Model.Resource.Media extends HS.FHIR.DTL.vSTU3.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

basedOn
bodySite
content
context
device
duration
frames
height
identifier
note
occurrenceDateTime
occurrencePeriod
operator
reasonCode
subject
subtype
type
view
width

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.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");

Reference

Procedure that caused this media to be created.

ProcedureRequest

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()

property bodySite as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "bodySite", XMLPROJECTION = "ELEMENT");

CodeableConcept

Body part in media.

any FHIR3 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.vSTU3.Model.Datatype.Attachment (XMLNAME = "content", XMLPROJECTION = "ELEMENT") [ Required ];

Attachment

Actual Media - reference or data.

Property methods: contentGet(), contentGetSwizzled(), contentIsValid(), contentNewObject(), contentSet()

property context as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");

Reference

Encounter / Episode associated with media.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()

property device as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "device", XMLPROJECTION = "ELEMENT");

Reference

Observing Device.

Device | DeviceMetric

Property methods: deviceGet(), deviceGetSwizzled(), deviceIsValid(), deviceNewObject(), deviceSet()

property duration as %Integer (XMLNAME = "duration", XMLPROJECTION = "ATTRIBUTE");

unsignedInt

Length in seconds (audio / video)

Property methods: durationDisplayToLogical(), durationGet(), durationIsValid(), durationLogicalToDisplay(), durationNormalize(), durationSet(), durationXSDToLogical()

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.vSTU3.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 note as list of HS.FHIR.DTL.vSTU3.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 occurrenceDateTime as %String (MAXLEN = 1000000, XMLNAME = "occurrenceDateTime", XMLPROJECTION = "ATTRIBUTE");

dateTime

When Media was collected.

Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()

property occurrencePeriod as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "occurrencePeriod", XMLPROJECTION = "ELEMENT");

Period

When Media was collected.

Property methods: occurrencePeriodGet(), occurrencePeriodGetSwizzled(), occurrencePeriodIsValid(), occurrencePeriodNewObject(), occurrencePeriodSet()

property operator as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "operator", XMLPROJECTION = "ELEMENT");

Reference

The person who generated the image.

Practitioner

Property methods: operatorGet(), operatorGetSwizzled(), operatorIsValid(), operatorNewObject(), operatorSet()

property reasonCode as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");

CodeableConcept

Why was event performed?

any FHIR3 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 subject as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");

Reference

Who/What this Media is a record of.

Patient | Practitioner | Group | Device | Specimen

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()

property subtype as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "subtype", XMLPROJECTION = "ELEMENT");

CodeableConcept

The type of acquisition equipment/process.

any FHIR3 code may be used; digital-media-subtype shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: subtypeGet(), subtypeGetSwizzled(), subtypeIsValid(), subtypeNewObject(), subtypeSet()

property type as %String (MAXLEN = 1000000, XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE") [ Required ];

code

photo | video | audio

digital-media-type is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend digital-media-type and you may NOT use codes from other ValueSets.

Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()

property view as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "view", XMLPROJECTION = "ELEMENT");

CodeableConcept

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

any FHIR3 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

Feedback