Private OptionalidentifierMedia.identifier Element
FHIR Specification
IdentifierPrivate OptionalbasedMedia.basedOn Element
FHIR Specification
Reference
Private OptionalpartMedia.partOf Element
FHIR Specification
Reference
Private ReadonlyeventFHIR CodeSystem: EventStatus
PrivatestatusMedia.status Element
FHIR Specification
codeCodeSystem Enumeration: EventStatusEnum
Private Optionaltype_Media.type Element
FHIR Specification
CodeableConceptPrivate OptionalmodalityMedia.modality Element
FHIR Specification
CodeableConceptPrivate OptionalviewMedia.view Element
Private OptionalsubjectMedia.subject Element
FHIR Specification
Reference
Private OptionalencounterMedia.encounter Element
FHIR Specification
Reference
Private OptionalcreatedMedia.created[x] Element
Private OptionalissuedMedia.issued Element
FHIR Specification
lastUpdated time of the resource itself. For Observations that do require review and verification for certain updates, it might not be the same as the lastUpdated time of the resource itself due to a non-clinically significant update that does not require the new version to be reviewed and verified again.instantPrivate OptionaloperatorMedia.operator Element
FHIR Specification
Reference
Private OptionalreasonMedia.reasonCode Element
Private OptionalbodyMedia.bodySite Element
FHIR Specification
CodeableConceptPrivate OptionaldeviceMedia.deviceName Element
Private OptionaldeviceMedia.device Element
FHIR Specification
Reference
Private OptionalheightMedia.height Element
Private OptionalwidthMedia.width Element
Private OptionalframesMedia.frames Element
FHIR Specification
positiveIntPrivate OptionaldurationMedia.duration Element
PrivatecontentMedia.content Element
FHIR Specification
AttachmentPrivate OptionalnoteMedia.note Element
FHIR Specification
AnnotationStaticparseParse the provided Media JSON to instantiate the Media data model.
JSON representing FHIR Media
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Media
Media data model or undefined for Media
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the basedOn property value as a Reference array
Assigns the provided Reference array value to the basedOn property.
the basedOn array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the basedOn array property.
the basedOn value
this
InvalidTypeError for invalid data type or reference value
true if the basedOn property exists and has a value; false otherwise
the partOf property value as a Reference array
Assigns the provided Reference array value to the partOf property.
the partOf array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the partOf array property.
the partOf value
this
InvalidTypeError for invalid data type or reference value
true if the partOf property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: EventStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: EventStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: EventStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: EventStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: EventStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: EventStatusEnum
true if the status property exists and has a value; false otherwise
the type_ property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Type object value to the type_ property.
the type_ object value
this
InvalidTypeError for invalid data types
true if the type_ property exists and has a value; false otherwise
the modality property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Modality object value to the modality property.
the modality object value
this
InvalidTypeError for invalid data types
true if the modality property exists and has a value; false otherwise
the view property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided View object value to the view property.
the view object value
this
InvalidTypeError for invalid data types
true if the view property exists and has a value; false otherwise
the subject property value as a Reference object; else an empty Reference object
Assigns the provided Subject object value to the subject property.
the subject object value
this
@ReferenceTargets('Media.subject', ['Patient','Practitioner','PractitionerRole','Group','Device','Specimen','Location',])
InvalidTypeError for invalid data type or reference value
true if the subject property exists and has a value; false otherwise
the encounter property value as a Reference object; else an empty Reference object
Assigns the provided Encounter object value to the encounter property.
the encounter object value
this
InvalidTypeError for invalid data type or reference value
true if the encounter property exists and has a value; false otherwise
the created property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the created property.
the created object value
this
InvalidTypeError for invalid data types
true if the created property exists and has a value; false otherwise
the created property value as a DateTimeType object if defined; else undefined
true if the created property exists as a DateTimeType and has a value; false otherwise
the created property value as a Period object if defined; else undefined
true if the created property exists as a Period and has a value; false otherwise
the issued property value as a InstantType object if defined; else an empty InstantType object
Assigns the provided PrimitiveType value to the issued property.
the issued value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the issued property exists and has a value; false otherwise
the issued property value as a fhirInstant if defined; else undefined
Assigns the provided primitive value to the issued property.
the issued value
this
PrimitiveTypeError for invalid primitive types
true if the issued property exists and has a value; false otherwise
the operator property value as a Reference object; else an empty Reference object
Assigns the provided Operator object value to the operator property.
the operator object value
this
@ReferenceTargets('Media.operator', ['Practitioner','PractitionerRole','Organization','CareTeam','Patient','Device','RelatedPerson',])
InvalidTypeError for invalid data type or reference value
true if the operator property exists and has a value; false otherwise
the reasonCode property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the reasonCode property.
the reasonCode array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the reasonCode array property.
the reasonCode value
this
InvalidTypeError for invalid data types
true if the reasonCode property exists and has a value; false otherwise
the bodySite property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided BodySite object value to the bodySite property.
the bodySite object value
this
InvalidTypeError for invalid data types
true if the bodySite property exists and has a value; false otherwise
the deviceName property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the deviceName property.
the deviceName value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the deviceName property exists and has a value; false otherwise
the deviceName property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the deviceName property.
the deviceName value
this
PrimitiveTypeError for invalid primitive types
true if the deviceName property exists and has a value; false otherwise
the device property value as a Reference object; else an empty Reference object
Assigns the provided Device object value to the device property.
the device object value
this
InvalidTypeError for invalid data type or reference value
true if the device property exists and has a value; false otherwise
the height property value as a PositiveIntType object if defined; else an empty PositiveIntType object
Assigns the provided PrimitiveType value to the height property.
the height value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the height property exists and has a value; false otherwise
the height property value as a fhirPositiveInt if defined; else undefined
Assigns the provided primitive value to the height property.
the height value
this
PrimitiveTypeError for invalid primitive types
true if the height property exists and has a value; false otherwise
the width property value as a PositiveIntType object if defined; else an empty PositiveIntType object
Assigns the provided PrimitiveType value to the width property.
the width value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the width property exists and has a value; false otherwise
the width property value as a fhirPositiveInt if defined; else undefined
Assigns the provided primitive value to the width property.
the width value
this
PrimitiveTypeError for invalid primitive types
true if the width property exists and has a value; false otherwise
the frames property value as a PositiveIntType object if defined; else an empty PositiveIntType object
Assigns the provided PrimitiveType value to the frames property.
the frames value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the frames property exists and has a value; false otherwise
the frames property value as a fhirPositiveInt if defined; else undefined
Assigns the provided primitive value to the frames property.
the frames value
this
PrimitiveTypeError for invalid primitive types
true if the frames property exists and has a value; false otherwise
the duration property value as a DecimalType object if defined; else an empty DecimalType object
Assigns the provided PrimitiveType value to the duration property.
the duration value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the duration property exists and has a value; false otherwise
the duration property value as a fhirDecimal if defined; else undefined
Assigns the provided primitive value to the duration property.
the duration value
this
PrimitiveTypeError for invalid primitive types
true if the duration property exists and has a value; false otherwise
the content property value as a Attachment object if defined; else an empty Attachment object
Assigns the provided Attachment object value to the content property.
the content object value
this
InvalidTypeError for invalid data types
true if the content property exists and has a value; false otherwise
the note property value as a Annotation array
Assigns the provided Annotation array value to the note property.
the note array value
this
InvalidTypeError for invalid data types
Add the provided Annotation value to the note array property.
the note value
this
InvalidTypeError for invalid data types
true if the note property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the basedOn property
PrivateinitInitialize the partOf property
PrivateinitInitialize the reasonCode property
PrivateinitInitialize the note property
Media Class
Remarks
A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
FHIR Specification
See
FHIR Media