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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringDeviceThis is a Device resource
identifierarray(Identifier)Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
udiDevice_Udi[Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.
statusstringactive|inactive|entered-in-error|unknownStatus of the Device availability.
typeCodeableConceptCode or identifier to identify a kind of device.
lotNumberstringLot number assigned by the manufacturer.
manufacturerstringA name of the manufacturer.
manufactureDatestringThe date and time when the device was manufactured.
expirationDatestringThe date and time beyond which this device is no longer valid or should not be used (if applicable).
modelstringThe "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.
versionstringThe version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.
patientReferencePatient information, If the device is affixed to a person.
ownerReferenceAn organization that is responsible for the provision and ongoing maintenance of the device.
contactarray(ContactPoint)Contact details for an organization or a particular human that is responsible for the device.
locationReferenceThe place where the device can be found.
urlstringA network address on which the device may be contacted directly.
notearray(Annotation)Descriptive information, usage information or implantation information that is not captured in an existing element.
safetyarray(CodeableConcept)Provides additional safety characteristics about a medical device. For example devices containing latex.

Response

Patch Device

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

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDeviceThis is a Device resource
identifierarray(Identifier)Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
udiDevice_Udi[Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.
statusstringactive|inactive|entered-in-error|unknownStatus of the Device availability.
typeCodeableConceptCode or identifier to identify a kind of device.
lotNumberstringLot number assigned by the manufacturer.
manufacturerstringA name of the manufacturer.
manufactureDatestringThe date and time when the device was manufactured.
expirationDatestringThe date and time beyond which this device is no longer valid or should not be used (if applicable).
modelstringThe "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.
versionstringThe version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.
patientReferencePatient information, If the device is affixed to a person.
ownerReferenceAn organization that is responsible for the provision and ongoing maintenance of the device.
contactarray(ContactPoint)Contact details for an organization or a particular human that is responsible for the device.
locationReferenceThe place where the device can be found.
urlstringA network address on which the device may be contacted directly.
notearray(Annotation)Descriptive information, usage information or implantation information that is not captured in an existing element.
safetyarray(CodeableConcept)Provides additional safety characteristics about a medical device. For example devices containing latex.

Response

Read Device

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Device

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Device

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Device

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Device

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
device-namestring
identifierstring
locationstring
manufacturerstring
modelstring
organizationstring
patientstring
statusstring
typestring
udi-carrierstring
udi-distring
urlstring

Params

organizationId*string|stringid|slug

Response

Search History Device

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Device

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

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
device-namestring
identifierstring
locationstring
manufacturerstring
modelstring
organizationstring
patientstring
statusstring
typestring
udi-carrierstring
udi-distring
urlstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringDeviceThis is a Device resource
identifierarray(Identifier)Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
udiDevice_Udi[Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.
statusstringactive|inactive|entered-in-error|unknownStatus of the Device availability.
typeCodeableConceptCode or identifier to identify a kind of device.
lotNumberstringLot number assigned by the manufacturer.
manufacturerstringA name of the manufacturer.
manufactureDatestringThe date and time when the device was manufactured.
expirationDatestringThe date and time beyond which this device is no longer valid or should not be used (if applicable).
modelstringThe "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.
versionstringThe version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.
patientReferencePatient information, If the device is affixed to a person.
ownerReferenceAn organization that is responsible for the provision and ongoing maintenance of the device.
contactarray(ContactPoint)Contact details for an organization or a particular human that is responsible for the device.
locationReferenceThe place where the device can be found.
urlstringA network address on which the device may be contacted directly.
notearray(Annotation)Descriptive information, usage information or implantation information that is not captured in an existing element.
safetyarray(CodeableConcept)Provides additional safety characteristics about a medical device. For example devices containing latex.

Response

Update Device

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

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDeviceThis is a Device resource
identifierarray(Identifier)Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
udiDevice_Udi[Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.
statusstringactive|inactive|entered-in-error|unknownStatus of the Device availability.
typeCodeableConceptCode or identifier to identify a kind of device.
lotNumberstringLot number assigned by the manufacturer.
manufacturerstringA name of the manufacturer.
manufactureDatestringThe date and time when the device was manufactured.
expirationDatestringThe date and time beyond which this device is no longer valid or should not be used (if applicable).
modelstringThe "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.
versionstringThe version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.
patientReferencePatient information, If the device is affixed to a person.
ownerReferenceAn organization that is responsible for the provision and ongoing maintenance of the device.
contactarray(ContactPoint)Contact details for an organization or a particular human that is responsible for the device.
locationReferenceThe place where the device can be found.
urlstringA network address on which the device may be contacted directly.
notearray(Annotation)Descriptive information, usage information or implantation information that is not captured in an existing element.
safetyarray(CodeableConcept)Provides additional safety characteristics about a medical device. For example devices containing latex.

Response