Private OptionalidentifierDeviceDispense.identifier Element
Private OptionalbasedDeviceDispense.basedOn Element
FHIR Specification
Reference
Private OptionalpartDeviceDispense.partOf Element
FHIR Specification
Reference
Private ReadonlydevicedispenseFHIR CodeSystem: DevicedispenseStatus
PrivatestatusDeviceDispense.status Element
FHIR Specification
codeCodeSystem Enumeration: DevicedispenseStatusEnum
Private OptionalstatusDeviceDispense.statusReason Element
FHIR Specification
CodeableReference
Private OptionalcategoryDeviceDispense.category Element
FHIR Specification
CodeableConceptPrivatedeviceDeviceDispense.device Element
FHIR Specification
CodeableReference
PrivatesubjectDeviceDispense.subject Element
FHIR Specification
Reference
Private OptionalreceiverDeviceDispense.receiver Element
FHIR Specification
Reference
Private OptionalencounterDeviceDispense.encounter Element
FHIR Specification
Reference
Private OptionalsupportingDeviceDispense.supportingInformation Element
FHIR Specification
Reference
Private OptionalperformerDeviceDispense.performer Element
Private OptionallocationDeviceDispense.location Element
FHIR Specification
Reference
Private Optionaltype_DeviceDispense.type Element
Private OptionalquantityDeviceDispense.quantity Element
Private OptionalpreparedDeviceDispense.preparedDate Element
Private OptionalwhenDeviceDispense.whenHandedOver Element
Private OptionaldestinationDeviceDispense.destination Element
FHIR Specification
Reference
Private OptionalnoteDeviceDispense.note Element
Private OptionalusageDeviceDispense.usageInstruction Element
FHIR Specification
markdownPrivate OptionaleventDeviceDispense.eventHistory Element
FHIR Specification
Reference
StaticparseParse the provided DeviceDispense JSON to instantiate the DeviceDispense data model.
JSON representing FHIR DeviceDispense
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to DeviceDispense
DeviceDispense data model or undefined for DeviceDispense
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: DevicedispenseStatusEnum
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: DevicedispenseStatusEnum
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: DevicedispenseStatusEnum
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: DevicedispenseStatusEnum
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: DevicedispenseStatusEnum
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: DevicedispenseStatusEnum
true if the status property exists and has a value; false otherwise
the statusReason property value as a CodeableReference object if defined; else an empty CodeableReference object
Assigns the provided StatusReason object value to the statusReason property.
the statusReason object value
this
InvalidTypeError for invalid data types
true if the statusReason property exists and has a value; false otherwise
the category property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the category property.
the category array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the category array property.
the category value
this
InvalidTypeError for invalid data types
true if the category property exists and has a value; false otherwise
the device property value as a CodeableReference object if defined; else an empty CodeableReference object
Assigns the provided CodeableReference object value to the device property.
the device object value
this
InvalidTypeError for invalid data types
true if the device property exists and has a value; false otherwise
the subject property value as a Reference object if defined; else an empty Reference object
Assigns the provided Subject object value to the subject property.
the subject object value
this
InvalidTypeError for invalid data type or reference value
true if the subject property exists and has a value; false otherwise
the receiver property value as a Reference object; else an empty Reference object
Assigns the provided Receiver object value to the receiver property.
the receiver object value
this
@ReferenceTargets('DeviceDispense.receiver', ['Patient','Practitioner','RelatedPerson','Location','PractitionerRole',])
InvalidTypeError for invalid data type or reference value
true if the receiver 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 supportingInformation property value as a Reference array
Assigns the provided Reference array value to the supportingInformation property.
the supportingInformation array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the supportingInformation array property.
the supportingInformation value
this
InvalidTypeError for invalid data type or reference value
true if the supportingInformation property exists and has a value; false otherwise
the performer property value as a DeviceDispensePerformerComponent array
Assigns the provided DeviceDispensePerformerComponent array value to the performer property.
the performer array value
this
InvalidTypeError for invalid data types
Add the provided DeviceDispensePerformerComponent value to the performer array property.
the performer value
this
InvalidTypeError for invalid data types
true if the performer property exists and has a value; false otherwise
the location property value as a Reference object; else an empty Reference object
Assigns the provided Location object value to the location property.
the location object value
this
InvalidTypeError for invalid data type or reference value
true if the location 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 quantity property value as a Quantity object if defined; else an empty Quantity object
Assigns the provided Quantity object value to the quantity property.
the quantity object value
this
InvalidTypeError for invalid data types
true if the quantity property exists and has a value; false otherwise
the preparedDate property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the preparedDate property.
the preparedDate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the preparedDate property exists and has a value; false otherwise
the preparedDate property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the preparedDate property.
the preparedDate value
this
PrimitiveTypeError for invalid primitive types
true if the preparedDate property exists and has a value; false otherwise
the whenHandedOver property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the whenHandedOver property.
the whenHandedOver value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the whenHandedOver property exists and has a value; false otherwise
the whenHandedOver property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the whenHandedOver property.
the whenHandedOver value
this
PrimitiveTypeError for invalid primitive types
true if the whenHandedOver property exists and has a value; false otherwise
the destination property value as a Reference object; else an empty Reference object
Assigns the provided Destination object value to the destination property.
the destination object value
this
InvalidTypeError for invalid data type or reference value
true if the destination 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 usageInstruction property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the usageInstruction property.
the usageInstruction value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the usageInstruction property exists and has a value; false otherwise
the usageInstruction property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the usageInstruction property.
the usageInstruction value
this
PrimitiveTypeError for invalid primitive types
true if the usageInstruction property exists and has a value; false otherwise
the eventHistory property value as a Reference array
Assigns the provided Reference array value to the eventHistory property.
the eventHistory array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the eventHistory array property.
the eventHistory value
this
InvalidTypeError for invalid data type or reference value
true if the eventHistory 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 category property
PrivateinitInitialize the supportingInformation property
PrivateinitInitialize the performer property
PrivateinitInitialize the note property
PrivateinitInitialize the eventHistory property
DeviceDispense Class
Remarks
Indicates that a device is to be or has been dispensed for a named person/patient. This includes a description of the product (supply) provided and the instructions for using the device.
FHIR Specification
See
FHIR DeviceDispense