device components
Create Device Component
post
/organizations/{organizationId}/fhir/3/DeviceComponent
The characteristics, operational status and capabilities of a medical-related component of a medical device.
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 | DeviceComponent | This is a DeviceComponent resource |
| identifier* | Identifier | The locally assigned unique identification by the software. For example: handle ID. | |
| type* | CodeableConcept | The component type as defined in the object-oriented or metric nomenclature partition. | |
| lastSystemChange | string | The timestamp for the most recent system change which includes device configuration or setting change. | |
| source | Reference | The link to the source Device that contains administrative device information such as manufacture, serial number, etc. | |
| parent | Reference | The link to the parent resource. For example: Channel is linked to its VMD parent. | |
| operationalStatus | array(CodeableConcept) | The current operational status of the device. For example: On, Off, Standby, etc. | |
| parameterGroup | CodeableConcept | The parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular. | |
| measurementPrinciple | string | other|chemical|electrical|impedance|nuclear|optical|thermal|biological|mechanical|acoustical|manual | The physical principle of the measurement. For example: thermal, chemical, acoustical, etc. |
| productionSpecification | array(DeviceComponent_ProductionSpecification) | The production specification such as component revision, serial number, etc. | |
| languageCode | CodeableConcept | The language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US. |
Response
keyboard_arrow_down
Patch Device Component
patch
/organizations/{organizationId}/fhir/3/DeviceComponent/{resourceId}
The characteristics, operational status and capabilities of a medical-related component of a 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* | string | DeviceComponent | This is a DeviceComponent resource |
| identifier* | Identifier | The locally assigned unique identification by the software. For example: handle ID. | |
| type* | CodeableConcept | The component type as defined in the object-oriented or metric nomenclature partition. | |
| lastSystemChange | string | The timestamp for the most recent system change which includes device configuration or setting change. | |
| source | Reference | The link to the source Device that contains administrative device information such as manufacture, serial number, etc. | |
| parent | Reference | The link to the parent resource. For example: Channel is linked to its VMD parent. | |
| operationalStatus | array(CodeableConcept) | The current operational status of the device. For example: On, Off, Standby, etc. | |
| parameterGroup | CodeableConcept | The parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular. | |
| measurementPrinciple | string | other|chemical|electrical|impedance|nuclear|optical|thermal|biological|mechanical|acoustical|manual | The physical principle of the measurement. For example: thermal, chemical, acoustical, etc. |
| productionSpecification | array(DeviceComponent_ProductionSpecification) | The production specification such as component revision, serial number, etc. | |
| languageCode | CodeableConcept | The language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US. |
Response
keyboard_arrow_down
Read Device Component
get
/organizations/{organizationId}/fhir/3/DeviceComponent/{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
keyboard_arrow_down
Read History Device Component
get
/organizations/{organizationId}/fhir/3/DeviceComponent/{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
keyboard_arrow_down
Read Version Device Component
get
/organizations/{organizationId}/fhir/3/DeviceComponent/{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
keyboard_arrow_down
Remove Device Component
delete
/organizations/{organizationId}/fhir/3/DeviceComponent/{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
keyboard_arrow_down
Search Get Device Component
get
/organizations/{organizationId}/fhir/3/DeviceComponent
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 | ||
| identifier | string | ||
| parent | string | ||
| source | string | ||
| type | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Device Component
get
/organizations/{organizationId}/fhir/3/DeviceComponent/_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
keyboard_arrow_down
Search Post Device Component
post
/organizations/{organizationId}/fhir/3/DeviceComponent/_search
The characteristics, operational status and capabilities of a medical-related component of a 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 | ||
| identifier | string | ||
| parent | string | ||
| source | string | ||
| type | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | DeviceComponent | This is a DeviceComponent resource |
| identifier* | Identifier | The locally assigned unique identification by the software. For example: handle ID. | |
| type* | CodeableConcept | The component type as defined in the object-oriented or metric nomenclature partition. | |
| lastSystemChange | string | The timestamp for the most recent system change which includes device configuration or setting change. | |
| source | Reference | The link to the source Device that contains administrative device information such as manufacture, serial number, etc. | |
| parent | Reference | The link to the parent resource. For example: Channel is linked to its VMD parent. | |
| operationalStatus | array(CodeableConcept) | The current operational status of the device. For example: On, Off, Standby, etc. | |
| parameterGroup | CodeableConcept | The parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular. | |
| measurementPrinciple | string | other|chemical|electrical|impedance|nuclear|optical|thermal|biological|mechanical|acoustical|manual | The physical principle of the measurement. For example: thermal, chemical, acoustical, etc. |
| productionSpecification | array(DeviceComponent_ProductionSpecification) | The production specification such as component revision, serial number, etc. | |
| languageCode | CodeableConcept | The language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US. |
Response
keyboard_arrow_down
Update Device Component
put
/organizations/{organizationId}/fhir/3/DeviceComponent/{resourceId}
The characteristics, operational status and capabilities of a medical-related component of a medical device.
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 | DeviceComponent | This is a DeviceComponent resource |
| identifier* | Identifier | The locally assigned unique identification by the software. For example: handle ID. | |
| type* | CodeableConcept | The component type as defined in the object-oriented or metric nomenclature partition. | |
| lastSystemChange | string | The timestamp for the most recent system change which includes device configuration or setting change. | |
| source | Reference | The link to the source Device that contains administrative device information such as manufacture, serial number, etc. | |
| parent | Reference | The link to the parent resource. For example: Channel is linked to its VMD parent. | |
| operationalStatus | array(CodeableConcept) | The current operational status of the device. For example: On, Off, Standby, etc. | |
| parameterGroup | CodeableConcept | The parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular. | |
| measurementPrinciple | string | other|chemical|electrical|impedance|nuclear|optical|thermal|biological|mechanical|acoustical|manual | The physical principle of the measurement. For example: thermal, chemical, acoustical, etc. |
| productionSpecification | array(DeviceComponent_ProductionSpecification) | The production specification such as component revision, serial number, etc. | |
| languageCode | CodeableConcept | The language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US. |
Response
keyboard_arrow_down