devices

Create Device

post

/organizations/{organizationId}/fhir/4/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.

Request

Headers


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

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a Device resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A 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.
language	code		The base language in which the resource is written.
text	Narrative		A 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.
contained	array(ResourceList)		These 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.
extension	array(Extension)		May 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.
modifierExtension	array(Extension)		May 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).
identifier	array(Identifier)		Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
definition	Reference		The reference to the definition for the device.
udiCarrier	array(Device_UdiCarrier)		Unique 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.
status		active\|inactive\|entered-in-error\|unknown	Status of the Device availability.
statusReason	array(CodeableConcept)		Reason for the dtatus of the Device availability.
distinctIdentifier	string		The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
manufacturer	string		A name of the manufacturer.
manufactureDate	dateTime		The date and time when the device was manufactured.
expirationDate	dateTime		The date and time beyond which this device is no longer valid or should not be used (if applicable).
lotNumber	string		Lot number assigned by the manufacturer.
serialNumber	string		The serial number assigned by the organization when the device was manufactured.
deviceName	array(Device_DeviceName)		This 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.
modelNumber	string		The model number for the device.
partNumber	string		The part number of the device.
type	CodeableConcept		The kind or type of device.
specialization	array(Device_Specialization)		The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
version	array(Device_Version)		The actual design of the device or software version running on the device.
property	array(Device_Property)		The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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	uri		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.
parent	Reference		The parent device.

Response

201 400 401 404

Patch Device

patch

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

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.

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*			This is a Device resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A 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.
language	code		The base language in which the resource is written.
text	Narrative		A 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.
contained	array(ResourceList)		These 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.
extension	array(Extension)		May 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.
modifierExtension	array(Extension)		May 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).
identifier	array(Identifier)		Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
definition	Reference		The reference to the definition for the device.
udiCarrier	array(Device_UdiCarrier)		Unique 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.
status		active\|inactive\|entered-in-error\|unknown	Status of the Device availability.
statusReason	array(CodeableConcept)		Reason for the dtatus of the Device availability.
distinctIdentifier	string		The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
manufacturer	string		A name of the manufacturer.
manufactureDate	dateTime		The date and time when the device was manufactured.
expirationDate	dateTime		The date and time beyond which this device is no longer valid or should not be used (if applicable).
lotNumber	string		Lot number assigned by the manufacturer.
serialNumber	string		The serial number assigned by the organization when the device was manufactured.
deviceName	array(Device_DeviceName)		This 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.
modelNumber	string		The model number for the device.
partNumber	string		The part number of the device.
type	CodeableConcept		The kind or type of device.
specialization	array(Device_Specialization)		The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
version	array(Device_Version)		The actual design of the device or software version running on the device.
property	array(Device_Property)		The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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	uri		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.
parent	Reference		The parent device.

Response

200 201 400 401 404 409

Read Device

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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/4/Device/{resourceId}/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	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/4/Device/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	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/4/Device/{resourceId}

Request

Headers


content-type*	string	application/json\|application/json+fhir	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/4/Device

Request

Headers


content-type*	string	application/json\|application/json+fhir	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/4/Device/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	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/4/Device/_search

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.

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*			This is a Device resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A 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.
language	code		The base language in which the resource is written.
text	Narrative		A 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.
contained	array(ResourceList)		These 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.
extension	array(Extension)		May 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.
modifierExtension	array(Extension)		May 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).
identifier	array(Identifier)		Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
definition	Reference		The reference to the definition for the device.
udiCarrier	array(Device_UdiCarrier)		Unique 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.
status		active\|inactive\|entered-in-error\|unknown	Status of the Device availability.
statusReason	array(CodeableConcept)		Reason for the dtatus of the Device availability.
distinctIdentifier	string		The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
manufacturer	string		A name of the manufacturer.
manufactureDate	dateTime		The date and time when the device was manufactured.
expirationDate	dateTime		The date and time beyond which this device is no longer valid or should not be used (if applicable).
lotNumber	string		Lot number assigned by the manufacturer.
serialNumber	string		The serial number assigned by the organization when the device was manufactured.
deviceName	array(Device_DeviceName)		This 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.
modelNumber	string		The model number for the device.
partNumber	string		The part number of the device.
type	CodeableConcept		The kind or type of device.
specialization	array(Device_Specialization)		The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
version	array(Device_Version)		The actual design of the device or software version running on the device.
property	array(Device_Property)		The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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	uri		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.
parent	Reference		The parent device.

Response

200 401 404

Update Device

put

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

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.

Request

Headers


content-type*	string	application/json\|application/json+fhir	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*			This is a Device resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The 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.
implicitRules	uri		A 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.
language	code		The base language in which the resource is written.
text	Narrative		A 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.
contained	array(ResourceList)		These 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.
extension	array(Extension)		May 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.
modifierExtension	array(Extension)		May 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).
identifier	array(Identifier)		Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
definition	Reference		The reference to the definition for the device.
udiCarrier	array(Device_UdiCarrier)		Unique 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.
status		active\|inactive\|entered-in-error\|unknown	Status of the Device availability.
statusReason	array(CodeableConcept)		Reason for the dtatus of the Device availability.
distinctIdentifier	string		The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
manufacturer	string		A name of the manufacturer.
manufactureDate	dateTime		The date and time when the device was manufactured.
expirationDate	dateTime		The date and time beyond which this device is no longer valid or should not be used (if applicable).
lotNumber	string		Lot number assigned by the manufacturer.
serialNumber	string		The serial number assigned by the organization when the device was manufactured.
deviceName	array(Device_DeviceName)		This 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.
modelNumber	string		The model number for the device.
partNumber	string		The part number of the device.
type	CodeableConcept		The kind or type of device.
specialization	array(Device_Specialization)		The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
version	array(Device_Version)		The actual design of the device or software version running on the device.
property	array(Device_Property)		The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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	uri		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.
parent	Reference		The parent device.

Response

200 201 400 401 404 409