devices

Create Device

post

/organizations/{organizationId}/fhir/3/Device

This resource identifies an instance or 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. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Device	This is a Device resource
identifier	array(Identifier)		Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
udi	Device_Udi		[Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.
status	string	active\|inactive\|entered-in-error\|unknown	Status of the Device availability.
type	CodeableConcept		Code or identifier to identify a kind of device.
lotNumber	string		Lot number assigned by the manufacturer.
manufacturer	string		A name of the manufacturer.
manufactureDate	string		The date and time when the device was manufactured.
expirationDate	string		The date and time beyond which this device is no longer valid or should not be used (if applicable).
model	string		The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.
version	string		The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.
patient	Reference		Patient information, If the device is affixed to a person.
owner	Reference		An organization that is responsible for the provision and ongoing maintenance of the device.
contact	array(ContactPoint)		Contact details for an organization or a particular human that is responsible for the device.
location	Reference		The place where the device can be found.
url	string		A network address on which the device may be contacted directly.
note	array(Annotation)		Descriptive information, usage information or implantation information that is not captured in an existing element.
safety	array(CodeableConcept)		Provides additional safety characteristics about a medical device. For example devices containing latex.

Response

201 400 401 404

Patch Device

patch

/organizations/{organizationId}/fhir/3/Device/{resourceId}

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Device	This is a Device resource
identifier	array(Identifier)		Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
udi	Device_Udi		[Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.
status	string	active\|inactive\|entered-in-error\|unknown	Status of the Device availability.
type	CodeableConcept		Code or identifier to identify a kind of device.
lotNumber	string		Lot number assigned by the manufacturer.
manufacturer	string		A name of the manufacturer.
manufactureDate	string		The date and time when the device was manufactured.
expirationDate	string		The date and time beyond which this device is no longer valid or should not be used (if applicable).
model	string		The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.
version	string		The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.
patient	Reference		Patient information, If the device is affixed to a person.
owner	Reference		An organization that is responsible for the provision and ongoing maintenance of the device.
contact	array(ContactPoint)		Contact details for an organization or a particular human that is responsible for the device.
location	Reference		The place where the device can be found.
url	string		A network address on which the device may be contacted directly.
note	array(Annotation)		Descriptive information, usage information or implantation information that is not captured in an existing element.
safety	array(CodeableConcept)		Provides additional safety characteristics about a medical device. For example devices containing latex.

Response

200 201 400 401 404 409

Read Device

get

/organizations/{organizationId}/fhir/3/Device/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Device

get

/organizations/{organizationId}/fhir/3/Device/{resourceId}/_history

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Device

get

/organizations/{organizationId}/fhir/3/Device/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Device

delete

/organizations/{organizationId}/fhir/3/Device/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Device

get

/organizations/{organizationId}/fhir/3/Device

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
device-name	string
identifier	string
location	string
manufacturer	string
model	string
organization	string
patient	string
status	string
type	string
udi-carrier	string
udi-di	string
url	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Device

get

/organizations/{organizationId}/fhir/3/Device/_history

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Device

post

/organizations/{organizationId}/fhir/3/Device/_search

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
device-name	string
identifier	string
location	string
manufacturer	string
model	string
organization	string
patient	string
status	string
type	string
udi-carrier	string
udi-di	string
url	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Device	This is a Device resource
identifier	array(Identifier)		Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
udi	Device_Udi		[Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.
status	string	active\|inactive\|entered-in-error\|unknown	Status of the Device availability.
type	CodeableConcept		Code or identifier to identify a kind of device.
lotNumber	string		Lot number assigned by the manufacturer.
manufacturer	string		A name of the manufacturer.
manufactureDate	string		The date and time when the device was manufactured.
expirationDate	string		The date and time beyond which this device is no longer valid or should not be used (if applicable).
model	string		The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.
version	string		The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.
patient	Reference		Patient information, If the device is affixed to a person.
owner	Reference		An organization that is responsible for the provision and ongoing maintenance of the device.
contact	array(ContactPoint)		Contact details for an organization or a particular human that is responsible for the device.
location	Reference		The place where the device can be found.
url	string		A network address on which the device may be contacted directly.
note	array(Annotation)		Descriptive information, usage information or implantation information that is not captured in an existing element.
safety	array(CodeableConcept)		Provides additional safety characteristics about a medical device. For example devices containing latex.

Response

200 401 404

Update Device

put

/organizations/{organizationId}/fhir/3/Device/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Device	This is a Device resource
identifier	array(Identifier)		Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
udi	Device_Udi		[Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.
status	string	active\|inactive\|entered-in-error\|unknown	Status of the Device availability.
type	CodeableConcept		Code or identifier to identify a kind of device.
lotNumber	string		Lot number assigned by the manufacturer.
manufacturer	string		A name of the manufacturer.
manufactureDate	string		The date and time when the device was manufactured.
expirationDate	string		The date and time beyond which this device is no longer valid or should not be used (if applicable).
model	string		The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.
version	string		The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.
patient	Reference		Patient information, If the device is affixed to a person.
owner	Reference		An organization that is responsible for the provision and ongoing maintenance of the device.
contact	array(ContactPoint)		Contact details for an organization or a particular human that is responsible for the device.
location	Reference		The place where the device can be found.
url	string		A network address on which the device may be contacted directly.
note	array(Annotation)		Descriptive information, usage information or implantation information that is not captured in an existing element.
safety	array(CodeableConcept)		Provides additional safety characteristics about a medical device. For example devices containing latex.

Response

200 201 400 401 404 409