Private OptionalidentifierDevice.identifier Element
FHIR Specification
IdentifierPrivate OptionaldefinitionDevice.definition Element
FHIR Specification
Reference
Private OptionaludiDevice.udiCarrier Element
FHIR Specification
BackboneElementPrivate ReadonlydeviceFHIR CodeSystem: DeviceStatus
Private OptionalstatusDevice.status Element
FHIR Specification
codeCodeSystem Enumeration: DeviceStatusEnum
Private OptionalstatusDevice.statusReason Element
Private OptionaldistinctDevice.distinctIdentifier Element
FHIR Specification
stringPrivate OptionalmanufacturerDevice.manufacturer Element
Private OptionalmanufactureDevice.manufactureDate Element
Private OptionalexpirationDevice.expirationDate Element
Private OptionallotDevice.lotNumber Element
Private OptionalserialDevice.serialNumber Element
Private OptionaldeviceDevice.deviceName Element
FHIR Specification
BackboneElementPrivate OptionalmodelDevice.modelNumber Element
Private OptionalpartDevice.partNumber Element
Private Optionaltype_Device.type Element
Private OptionalspecializationDevice.specialization Element
FHIR Specification
BackboneElementPrivate OptionalversionDevice.version Element
Private OptionalpropertyDevice.property Element
FHIR Specification
BackboneElementPrivate OptionalpatientDevice.patient Element
FHIR Specification
Reference
Private OptionalownerDevice.owner Element
FHIR Specification
Reference
Private OptionalcontactDevice.contact Element
Private OptionallocationDevice.location Element
FHIR Specification
Reference
Private OptionalurlDevice.url Element
FHIR Specification
uriPrivate OptionalnoteDevice.note Element
Private OptionalsafetyDevice.safety Element
Private OptionalparentDevice.parent Element
FHIR Specification
Reference
StaticparseParse the provided Device JSON to instantiate the Device data model.
JSON representing FHIR Device
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Device
Device data model or undefined for Device
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 definition property value as a Reference object; else an empty Reference object
Assigns the provided Definition object value to the definition property.
the definition object value
this
InvalidTypeError for invalid data type or reference value
true if the definition property exists and has a value; false otherwise
the udiCarrier property value as a DeviceUdiCarrierComponent array
Assigns the provided DeviceUdiCarrierComponent array value to the udiCarrier property.
the udiCarrier array value
this
InvalidTypeError for invalid data types
Add the provided DeviceUdiCarrierComponent value to the udiCarrier array property.
the udiCarrier value
this
InvalidTypeError for invalid data types
true if the udiCarrier property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: DeviceStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: DeviceStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else undefined
CodeSystem Enumeration: DeviceStatusEnum
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: DeviceStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: DeviceStatusEnum
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: DeviceStatusEnum
true if the status property exists and has a value; false otherwise
the statusReason property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the statusReason property.
the statusReason array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the statusReason array property.
the statusReason value
this
InvalidTypeError for invalid data types
true if the statusReason property exists and has a value; false otherwise
the distinctIdentifier property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the distinctIdentifier property.
the distinctIdentifier value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the distinctIdentifier property exists and has a value; false otherwise
the distinctIdentifier property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the distinctIdentifier property.
the distinctIdentifier value
this
PrimitiveTypeError for invalid primitive types
true if the distinctIdentifier property exists and has a value; false otherwise
the manufacturer property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the manufacturer property.
the manufacturer value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the manufacturer property exists and has a value; false otherwise
the manufacturer property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the manufacturer property.
the manufacturer value
this
PrimitiveTypeError for invalid primitive types
true if the manufacturer property exists and has a value; false otherwise
the manufactureDate property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the manufactureDate property.
the manufactureDate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the manufactureDate property exists and has a value; false otherwise
the manufactureDate property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the manufactureDate property.
the manufactureDate value
this
PrimitiveTypeError for invalid primitive types
true if the manufactureDate property exists and has a value; false otherwise
the expirationDate property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the expirationDate property.
the expirationDate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the expirationDate property exists and has a value; false otherwise
the expirationDate property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the expirationDate property.
the expirationDate value
this
PrimitiveTypeError for invalid primitive types
true if the expirationDate property exists and has a value; false otherwise
the lotNumber property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the lotNumber property.
the lotNumber value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the lotNumber property exists and has a value; false otherwise
the lotNumber property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the lotNumber property.
the lotNumber value
this
PrimitiveTypeError for invalid primitive types
true if the lotNumber property exists and has a value; false otherwise
the serialNumber property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the serialNumber property.
the serialNumber value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the serialNumber property exists and has a value; false otherwise
the serialNumber property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the serialNumber property.
the serialNumber value
this
PrimitiveTypeError for invalid primitive types
true if the serialNumber property exists and has a value; false otherwise
the deviceName property value as a DeviceDeviceNameComponent array
Assigns the provided DeviceDeviceNameComponent array value to the deviceName property.
the deviceName array value
this
InvalidTypeError for invalid data types
Add the provided DeviceDeviceNameComponent value to the deviceName array property.
the deviceName value
this
InvalidTypeError for invalid data types
true if the deviceName property exists and has a value; false otherwise
the modelNumber property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the modelNumber property.
the modelNumber value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the modelNumber property exists and has a value; false otherwise
the modelNumber property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the modelNumber property.
the modelNumber value
this
PrimitiveTypeError for invalid primitive types
true if the modelNumber property exists and has a value; false otherwise
the partNumber property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the partNumber property.
the partNumber value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the partNumber property exists and has a value; false otherwise
the partNumber property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the partNumber property.
the partNumber value
this
PrimitiveTypeError for invalid primitive types
true if the partNumber 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 specialization property value as a DeviceSpecializationComponent array
Assigns the provided DeviceSpecializationComponent array value to the specialization property.
the specialization array value
this
InvalidTypeError for invalid data types
Add the provided DeviceSpecializationComponent value to the specialization array property.
the specialization value
this
InvalidTypeError for invalid data types
true if the specialization property exists and has a value; false otherwise
the version property value as a DeviceVersionComponent array
Assigns the provided DeviceVersionComponent array value to the version property.
the version array value
this
InvalidTypeError for invalid data types
Add the provided DeviceVersionComponent value to the version array property.
the version value
this
InvalidTypeError for invalid data types
true if the version property exists and has a value; false otherwise
the property property value as a DevicePropertyComponent array
Assigns the provided DevicePropertyComponent array value to the property property.
the property array value
this
InvalidTypeError for invalid data types
Add the provided DevicePropertyComponent value to the property array property.
the property value
this
InvalidTypeError for invalid data types
true if the property property exists and has a value; false otherwise
the patient property value as a Reference object; else an empty Reference object
Assigns the provided Patient object value to the patient property.
the patient object value
this
InvalidTypeError for invalid data type or reference value
true if the patient property exists and has a value; false otherwise
the owner property value as a Reference object; else an empty Reference object
Assigns the provided Owner object value to the owner property.
the owner object value
this
InvalidTypeError for invalid data type or reference value
true if the owner property exists and has a value; false otherwise
the contact property value as a ContactPoint array
Assigns the provided ContactPoint array value to the contact property.
the contact array value
this
InvalidTypeError for invalid data types
Add the provided ContactPoint value to the contact array property.
the contact value
this
InvalidTypeError for invalid data types
true if the contact 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 url property value as a UriType object if defined; else an empty UriType object
Assigns the provided PrimitiveType value to the url property.
the url value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the url property value as a fhirUri if defined; else undefined
Assigns the provided primitive value to the url property.
the url value
this
PrimitiveTypeError for invalid primitive types
true if the url 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 safety property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the safety property.
the safety array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the safety array property.
the safety value
this
InvalidTypeError for invalid data types
true if the safety property exists and has a value; false otherwise
the parent property value as a Reference object; else an empty Reference object
Assigns the provided Parent object value to the parent property.
the parent object value
this
InvalidTypeError for invalid data type or reference value
true if the parent property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if 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 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
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 udiCarrier property
PrivateinitInitialize the statusReason property
PrivateinitInitialize the deviceName property
PrivateinitInitialize the specialization property
PrivateinitInitialize the version property
PrivateinitInitialize the property property
PrivateinitInitialize the contact property
PrivateinitInitialize the note property
PrivateinitInitialize the safety property
Device Class
Remarks
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
Allows institutions to track their devices.
FHIR Specification
See
FHIR Device