Skip to main content

Device

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.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

InteractionMethodPath
ReadGET/fhir/R4/Device/[id]
VreadGET/fhir/R4/Device/[id]/_history/[vid]
UpdatePUT/fhir/R4/Device/[id]
PatchPATCH/fhir/R4/Device/[id]
DeleteDELETE/fhir/R4/Device/[id]
CreatePOST/fhir/R4/Device
SearchGET/fhir/R4/Device
HistoryGET/fhir/R4/Device/[id]/_history

Top-level elements​

ElementTypeCardinalityDescription
idstring0..1Logical id of this artifact
metaMeta0..1Metadata about the resource
implicitRulesuri0..1A set of rules under which this content was created
languagecode0..1Language of the resource content
textNarrative0..1Text summary of the resource, for human interpretation
containedResource0..*Contained, inline Resources
extensionExtension0..*Additional content defined by implementations
modifierExtensionExtension0..*Extensions that cannot be ignored
identifierIdentifier0..*Instance identifier
definitionReference0..1The reference to the definition for the device
udiCarrierBackboneElement0..*Unique Device Identifier (UDI) Barcode string
statuscode0..1active | inactive | entered-in-error | unknown
statusReasonCodeableConcept0..*online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
distinctIdentifierstring0..1The distinct identification string
manufacturerstring0..1Name of device manufacturer
manufactureDatedateTime0..1Date when the device was made
expirationDatedateTime0..1Date and time of expiry of this device (if applicable)
lotNumberstring0..1Lot number of manufacture
serialNumberstring0..1Serial number assigned by the manufacturer
deviceNameBackboneElement0..*The name of the device as given by the manufacturer
modelNumberstring0..1The model number for the device
partNumberstring0..1The part number of the device
typeCodeableConcept0..1The kind or type of device
specializationBackboneElement0..*The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
versionBackboneElement0..*The actual design of the device or software version running on the device
propertyBackboneElement0..*The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
patientReference0..1Patient to whom Device is affixed
ownerReference0..1Organization responsible for device
contactContactPoint0..*Details for human/organization for support
locationReference0..1Where the device is found
urluri0..1Network address to contact device
noteAnnotation0..*Device notes and comments
safetyCodeableConcept0..*Safety Characteristics of Device
parentReference0..1The parent device

Resource-specific search parameters​

ParameterTypeDescription
device-namestringA server defined search that may match any of the string fields in Device.deviceName or Device.type.
dintokenThe donation identification number (DIN)
identifiertokenInstance id from manufacturer, owner, and others
locationreferenceA location, where the resource is found
manufacturerstringThe manufacturer of the device
modelstringThe model of the device
organizationreferenceThe organization responsible for the device
patientreferencePatient information, if the resource is affixed to a person
statustokenactive | inactive | entered-in-error | unknown
typetokenThe type of the device
udi-carrierstringUDI Barcode (RFID or other technology) string in *HRF; format.
udi-distringThe udi Device Identifier (DI)
urluriNetwork address to contact device

Reference​

Official FHIR R4 spec: Device.
Maturity: Trial Use 2 (FMM 2).