Skip to main content

Device

PropertyValue
Publisher
NameDevice
URLhttp://hl7.org/fhir/StructureDefinition/Device
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Device0..*DeviceA 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.
Device.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Device.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Device.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Device.language0..1codeThe base language in which the resource is written.
Device.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Device.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Device.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Device.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Device.identifier0..*IdentifierUnique instance identifiers assigned to a device by manufacturers other organizations or owners.
Device.definition0..1ReferenceThe reference to the definition for the device.
Device.udiCarrier0..*BackboneElementUnique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
Device.udiCarrier.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Device.udiCarrier.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Device.udiCarrier.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Device.udiCarrier.deviceIdentifier0..1stringThe device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.
Device.udiCarrier.issuer0..1uriOrganization that is charged with issuing UDIs for devices. For example, the US FDA issuers include :1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC:http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers:http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices:http://hl7.org/fhir/NamingSystem/iccbba-other-di.
Device.udiCarrier.jurisdiction0..1uriThe identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.
Device.udiCarrier.carrierAIDC0..1base64BinaryThe full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.
Device.udiCarrier.carrierHRF0..1stringThe full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
Device.udiCarrier.entryType0..1codeA coded entry to indicate how the data was entered.
Device.status0..1codeStatus of the Device availability.
Device.statusReason0..*CodeableConceptReason for the dtatus of the Device availability.
Device.distinctIdentifier0..1stringThe distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
Device.manufacturer0..1stringA name of the manufacturer.
Device.manufactureDate0..1dateTimeThe date and time when the device was manufactured.
Device.expirationDate0..1dateTimeThe date and time beyond which this device is no longer valid or should not be used (if applicable).
Device.lotNumber0..1stringLot number assigned by the manufacturer.
Device.serialNumber0..1stringThe serial number assigned by the organization when the device was manufactured.
Device.deviceName0..*BackboneElementThis represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.
Device.deviceName.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Device.deviceName.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Device.deviceName.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Device.deviceName.name1..1stringThe name that identifies the device.
Device.deviceName.type1..1codeThe type of deviceName.UDILabelName / UserFriendlyName / PatientReportedName / ManufactureDeviceName / ModelName.
Device.modelNumber0..1stringThe manufacturer's model number for the device.
Device.partNumber0..1stringThe part number or catalog number of the device.
Device.type0..1CodeableConceptThe kind or type of device.
Device.specialization0..*BackboneElementThe capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
Device.specialization.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Device.specialization.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Device.specialization.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Device.specialization.systemType1..1CodeableConceptThe standard that is used to operate and communicate.
Device.specialization.version0..1stringThe version of the standard that is used to operate and communicate.
Device.version0..*BackboneElementThe actual design of the device or software version running on the device.
Device.version.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Device.version.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Device.version.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Device.version.type0..1CodeableConceptThe type of the device version, e.g. manufacturer, approved, internal.
Device.version.component0..1IdentifierA single component of the device version.
Device.version.value1..1stringThe version text.
Device.property0..*BackboneElementThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
Device.property.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Device.property.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Device.property.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Device.property.type1..1CodeableConceptCode that specifies the property DeviceDefinitionPropetyCode (Extensible).
Device.property.valueQuantity0..*QuantityProperty value as a quantity.
Device.property.valueCode0..*CodeableConceptProperty value as a code, e.g., NTP4 (synced to NTP).
Device.patient0..1ReferencePatient information, If the device is affixed to a person.
Device.owner0..1ReferenceAn organization that is responsible for the provision and ongoing maintenance of the device.
Device.contact0..*ContactPointContact details for an organization or a particular human that is responsible for the device.
Device.location0..1ReferenceThe place where the device can be found.
Device.url0..1uriA network address on which the device may be contacted directly.
Device.note0..*AnnotationDescriptive information, usage information or implantation information that is not captured in an existing element.
Device.safety0..*CodeableConceptProvides additional safety characteristics about a medical device. For example devices containing latex.
Device.parent0..1ReferenceThe device that this device is attached to or is part of.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
device-namestringA server defined search that may match any of the string fields in Device.deviceName or Device.type.Device.deviceName.name / Device.type.coding.display / Device.type.text
identifiertokenInstance id from manufacturer, owner, and othersDevice.identifier
locationreferenceA location, where the resource is foundDevice.location
manufacturerstringThe manufacturer of the deviceDevice.manufacturer
modelstringThe model of the deviceDevice.modelNumber
organizationreferenceThe organization responsible for the deviceDevice.owner
patientreferencePatient information, if the resource is affixed to a personDevice.patient
statustokenactive / inactive / entered-in-error / unknownDevice.status
typetokenThe type of the deviceDevice.type
udi-carrierstringUDI Barcode (RFID or other technology) string in HRF format.Device.udiCarrier.carrierHRF
udi-distringThe udi Device Identifier (DI)Device.udiCarrier.deviceIdentifier
urluriNetwork address to contact deviceDevice.url