Skip to main content

Device

Trial Use 2 Specialized — Devices

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.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Device
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​

ElementType(s)CardinalityDescription
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 modifier
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
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
device-namestringhttp://hl7.org/fhir/SearchParameter/Device-device-name
identifierstringhttp://hl7.org/fhir/SearchParameter/Device-identifier
locationstringhttp://hl7.org/fhir/SearchParameter/Device-location
manufacturerstringhttp://hl7.org/fhir/SearchParameter/Device-manufacturer
modelstringhttp://hl7.org/fhir/SearchParameter/Device-model
organizationstringhttp://hl7.org/fhir/SearchParameter/Device-organization
patientstringhttp://hl7.org/fhir/SearchParameter/Device-patient
statusstringhttp://hl7.org/fhir/SearchParameter/Device-status
typestringhttp://hl7.org/fhir/SearchParameter/Device-type
udi-carrierstringhttp://hl7.org/fhir/SearchParameter/Device-udi-carrier
udi-distringhttp://hl7.org/fhir/SearchParameter/Device-udi-di
urlstringhttp://hl7.org/fhir/SearchParameter/Device-url

Reference​

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