Private OptionalidentifierDevice.identifier Element
FHIR Specification
IdentifierPrivate OptionaldisplayDevice.displayName Element
FHIR Specification
stringPrivate OptionaldefinitionDevice.definition Element
FHIR Specification
CodeableReference
Private OptionaludiDevice.udiCarrier Element
FHIR Specification
BackboneElementPrivate ReadonlydeviceFHIR CodeSystem: DeviceStatus
Private OptionalstatusDevice.status Element
FHIR Specification
codeCodeSystem Enumeration: DeviceStatusEnum
Private OptionalavailabilityDevice.availabilityStatus Element
Private OptionalbiologicalDevice.biologicalSourceEvent Element
FHIR Specification
IdentifierPrivate OptionalmanufacturerDevice.manufacturer Element
Private OptionalmanufactureDevice.manufactureDate Element
Private OptionalexpirationDevice.expirationDate Element
Private OptionallotDevice.lotNumber Element
Private OptionalserialDevice.serialNumber Element
FHIR Specification
stringPrivate OptionalnameDevice.name Element
FHIR Specification
BackboneElementPrivate OptionalmodelDevice.modelNumber Element
Private OptionalpartDevice.partNumber Element
Private OptionalcategoryDevice.category Element
Private Optionaltype_Device.type Element
FHIR Specification
CodeableConceptPrivate OptionalversionDevice.version Element
Private OptionalconformsDevice.conformsTo Element
FHIR Specification
BackboneElementPrivate OptionalpropertyDevice.property Element
FHIR Specification
BackboneElementPrivate OptionalmodeDevice.mode Element
Private OptionalcycleDevice.cycle Element
Private OptionaldurationDevice.duration Element
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 OptionalendpointDevice.endpoint Element
FHIR Specification
Reference
Private OptionalgatewayDevice.gateway Element
FHIR Specification
CodeableReference
Private 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 displayName property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the displayName property.
the displayName value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the displayName property exists and has a value; false otherwise
the displayName property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the displayName property.
the displayName value
this
PrimitiveTypeError for invalid primitive types
true if the displayName property exists and has a value; false otherwise
the definition property value as a CodeableReference object if defined; else an empty CodeableReference object
Assigns the provided Definition object value to the definition property.
the definition object value
this
InvalidTypeError for invalid data types
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 availabilityStatus property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided AvailabilityStatus object value to the availabilityStatus property.
the availabilityStatus object value
this
InvalidTypeError for invalid data types
true if the availabilityStatus property exists and has a value; false otherwise
the biologicalSourceEvent property value as a Identifier object if defined; else an empty Identifier object
Assigns the provided BiologicalSourceEvent object value to the biologicalSourceEvent property.
the biologicalSourceEvent object value
this
InvalidTypeError for invalid data types
true if the biologicalSourceEvent 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 name property value as a DeviceNameComponent array
Assigns the provided DeviceNameComponent array value to the name property.
the name array value
this
InvalidTypeError for invalid data types
Add the provided DeviceNameComponent value to the name array property.
the name value
this
InvalidTypeError for invalid data types
true if the name 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 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 type_ property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the type_ property.
the type_ array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the type_ array property.
the type_ value
this
InvalidTypeError for invalid data types
true if the type_ 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 conformsTo property value as a DeviceConformsToComponent array
Assigns the provided DeviceConformsToComponent array value to the conformsTo property.
the conformsTo array value
this
InvalidTypeError for invalid data types
Add the provided DeviceConformsToComponent value to the conformsTo array property.
the conformsTo value
this
InvalidTypeError for invalid data types
true if the conformsTo 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 mode property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Mode object value to the mode property.
the mode object value
this
InvalidTypeError for invalid data types
true if the mode property exists and has a value; false otherwise
the cycle property value as a Count object if defined; else an empty Count object
Assigns the provided Cycle object value to the cycle property.
the cycle object value
this
InvalidTypeError for invalid data types
true if the cycle property exists and has a value; false otherwise
the duration property value as a Duration object if defined; else an empty Duration object
Assigns the provided Duration object value to the duration property.
the duration object value
this
InvalidTypeError for invalid data types
true if the duration 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 endpoint property value as a Reference array
Assigns the provided Reference array value to the endpoint property.
the endpoint array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the endpoint array property.
the endpoint value
this
InvalidTypeError for invalid data type or reference value
true if the endpoint property exists and has a value; false otherwise
the gateway property value as a CodeableReference array
Assigns the provided CodeableReference array value to the gateway property.
the gateway array value
this
InvalidTypeError for invalid data types
Add the provided CodeableReference value to the gateway array property.
the gateway value
this
InvalidTypeError for invalid data types
true if the gateway 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 name property
PrivateinitInitialize the category property
PrivateinitInitialize the type_ property
PrivateinitInitialize the version property
PrivateinitInitialize the conformsTo property
PrivateinitInitialize the property property
PrivateinitInitialize the contact property
PrivateinitInitialize the endpoint property
PrivateinitInitialize the gateway property
PrivateinitInitialize the note property
PrivateinitInitialize the safety property
Device Class
Remarks
This resource describes the properties (regulated, has real time clock, etc.), adminstrative (manufacturer name, model number, serial number, firmware, etc.), and type (knee replacement, blood pressure cuff, MRI, etc.) of a physical unit (these values do not change much within a given module, for example the serail number, manufacturer name, and model number). An actual unit may consist of several modules in a distinct hierarchy and these are represented by multiple Device resources and bound through the 'parent' element.
Allows institutions to track their devices.
FHIR Specification
See
FHIR Device