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

Params

organizationId*string|stringid|slug

Body

resourceType*stringDeviceComponentThis is a DeviceComponent resource
identifier*IdentifierThe locally assigned unique identification by the software. For example: handle ID.
type*CodeableConceptThe component type as defined in the object-oriented or metric nomenclature partition.
lastSystemChangestringThe timestamp for the most recent system change which includes device configuration or setting change.
sourceReferenceThe link to the source Device that contains administrative device information such as manufacture, serial number, etc.
parentReferenceThe link to the parent resource. For example: Channel is linked to its VMD parent.
operationalStatusarray(CodeableConcept)The current operational status of the device. For example: On, Off, Standby, etc.
parameterGroupCodeableConceptThe parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular.
measurementPrinciplestringother|chemical|electrical|impedance|nuclear|optical|thermal|biological|mechanical|acoustical|manualThe physical principle of the measurement. For example: thermal, chemical, acoustical, etc.
productionSpecificationarray(DeviceComponent_ProductionSpecification)The production specification such as component revision, serial number, etc.
languageCodeCodeableConceptThe 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

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDeviceComponentThis is a DeviceComponent resource
identifier*IdentifierThe locally assigned unique identification by the software. For example: handle ID.
type*CodeableConceptThe component type as defined in the object-oriented or metric nomenclature partition.
lastSystemChangestringThe timestamp for the most recent system change which includes device configuration or setting change.
sourceReferenceThe link to the source Device that contains administrative device information such as manufacture, serial number, etc.
parentReferenceThe link to the parent resource. For example: Channel is linked to its VMD parent.
operationalStatusarray(CodeableConcept)The current operational status of the device. For example: On, Off, Standby, etc.
parameterGroupCodeableConceptThe parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular.
measurementPrinciplestringother|chemical|electrical|impedance|nuclear|optical|thermal|biological|mechanical|acoustical|manualThe physical principle of the measurement. For example: thermal, chemical, acoustical, etc.
productionSpecificationarray(DeviceComponent_ProductionSpecification)The production specification such as component revision, serial number, etc.
languageCodeCodeableConceptThe 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

Read Device Component

get
/organizations/{organizationId}/fhir/3/DeviceComponent/{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 Component

get
/organizations/{organizationId}/fhir/3/DeviceComponent/{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 Component

get
/organizations/{organizationId}/fhir/3/DeviceComponent/{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 Component

delete
/organizations/{organizationId}/fhir/3/DeviceComponent/{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 Component

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

Request

Headers

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

Query params

_idstring
_languagestring
identifierstring
parentstring
sourcestring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Device Component

get
/organizations/{organizationId}/fhir/3/DeviceComponent/_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 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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
identifierstring
parentstring
sourcestring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringDeviceComponentThis is a DeviceComponent resource
identifier*IdentifierThe locally assigned unique identification by the software. For example: handle ID.
type*CodeableConceptThe component type as defined in the object-oriented or metric nomenclature partition.
lastSystemChangestringThe timestamp for the most recent system change which includes device configuration or setting change.
sourceReferenceThe link to the source Device that contains administrative device information such as manufacture, serial number, etc.
parentReferenceThe link to the parent resource. For example: Channel is linked to its VMD parent.
operationalStatusarray(CodeableConcept)The current operational status of the device. For example: On, Off, Standby, etc.
parameterGroupCodeableConceptThe parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular.
measurementPrinciplestringother|chemical|electrical|impedance|nuclear|optical|thermal|biological|mechanical|acoustical|manualThe physical principle of the measurement. For example: thermal, chemical, acoustical, etc.
productionSpecificationarray(DeviceComponent_ProductionSpecification)The production specification such as component revision, serial number, etc.
languageCodeCodeableConceptThe 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

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDeviceComponentThis is a DeviceComponent resource
identifier*IdentifierThe locally assigned unique identification by the software. For example: handle ID.
type*CodeableConceptThe component type as defined in the object-oriented or metric nomenclature partition.
lastSystemChangestringThe timestamp for the most recent system change which includes device configuration or setting change.
sourceReferenceThe link to the source Device that contains administrative device information such as manufacture, serial number, etc.
parentReferenceThe link to the parent resource. For example: Channel is linked to its VMD parent.
operationalStatusarray(CodeableConcept)The current operational status of the device. For example: On, Off, Standby, etc.
parameterGroupCodeableConceptThe parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular.
measurementPrinciplestringother|chemical|electrical|impedance|nuclear|optical|thermal|biological|mechanical|acoustical|manualThe physical principle of the measurement. For example: thermal, chemical, acoustical, etc.
productionSpecificationarray(DeviceComponent_ProductionSpecification)The production specification such as component revision, serial number, etc.
languageCodeCodeableConceptThe 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