device definitions

Create Device Definition

post
/organizations/{organizationId}/fhir/4/DeviceDefinition

The characteristics, operational status and capabilities of a medical-related component of a medical device.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a DeviceDefinition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.
udiDeviceIdentifierarray(DeviceDefinition_UdiDeviceIdentifier)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.
manufacturerStringstringA name of the manufacturer.
manufacturerReferenceReferenceA name of the manufacturer.
deviceNamearray(DeviceDefinition_DeviceName)A name given to the device to identify it.
modelNumberstringThe model number for the device.
typeCodeableConceptWhat kind of device or device system this is.
specializationarray(DeviceDefinition_Specialization)The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
versionarray(string)The available versions of the device, e.g., software versions.
safetyarray(CodeableConcept)Safety characteristics of the device.
shelfLifeStoragearray(ProductShelfLife)Shelf Life and storage information.
physicalCharacteristicsProdCharacteristicDimensions, color etc.
languageCodearray(CodeableConcept)Language code for the human-readable text strings produced by the device (all supported).
capabilityarray(DeviceDefinition_Capability)Device capabilities.
propertyarray(DeviceDefinition_Property)The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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.
urluriA network address on which the device may be contacted directly.
onlineInformationuriAccess to on-line information about the device.
notearray(Annotation)Descriptive information, usage information or implantation information that is not captured in an existing element.
quantityQuantityThe quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).
parentDeviceReferenceThe parent device it can be part of.
materialarray(DeviceDefinition_Material)A substance used to create the material(s) of which the device is made.

Response

Patch Device Definition

patch
/organizations/{organizationId}/fhir/4/DeviceDefinition/{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*This is a DeviceDefinition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.
udiDeviceIdentifierarray(DeviceDefinition_UdiDeviceIdentifier)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.
manufacturerStringstringA name of the manufacturer.
manufacturerReferenceReferenceA name of the manufacturer.
deviceNamearray(DeviceDefinition_DeviceName)A name given to the device to identify it.
modelNumberstringThe model number for the device.
typeCodeableConceptWhat kind of device or device system this is.
specializationarray(DeviceDefinition_Specialization)The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
versionarray(string)The available versions of the device, e.g., software versions.
safetyarray(CodeableConcept)Safety characteristics of the device.
shelfLifeStoragearray(ProductShelfLife)Shelf Life and storage information.
physicalCharacteristicsProdCharacteristicDimensions, color etc.
languageCodearray(CodeableConcept)Language code for the human-readable text strings produced by the device (all supported).
capabilityarray(DeviceDefinition_Capability)Device capabilities.
propertyarray(DeviceDefinition_Property)The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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.
urluriA network address on which the device may be contacted directly.
onlineInformationuriAccess to on-line information about the device.
notearray(Annotation)Descriptive information, usage information or implantation information that is not captured in an existing element.
quantityQuantityThe quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).
parentDeviceReferenceThe parent device it can be part of.
materialarray(DeviceDefinition_Material)A substance used to create the material(s) of which the device is made.

Response

Read Device Definition

get
/organizations/{organizationId}/fhir/4/DeviceDefinition/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Device Definition

get
/organizations/{organizationId}/fhir/4/DeviceDefinition/{resourceId}/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Device Definition

get
/organizations/{organizationId}/fhir/4/DeviceDefinition/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Device Definition

delete
/organizations/{organizationId}/fhir/4/DeviceDefinition/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Device Definition

get
/organizations/{organizationId}/fhir/4/DeviceDefinition

Request

Headers

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

Query params

_idstring
_languagestring
identifierstring
parentstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Device Definition

get
/organizations/{organizationId}/fhir/4/DeviceDefinition/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Device Definition

post
/organizations/{organizationId}/fhir/4/DeviceDefinition/_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
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a DeviceDefinition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.
udiDeviceIdentifierarray(DeviceDefinition_UdiDeviceIdentifier)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.
manufacturerStringstringA name of the manufacturer.
manufacturerReferenceReferenceA name of the manufacturer.
deviceNamearray(DeviceDefinition_DeviceName)A name given to the device to identify it.
modelNumberstringThe model number for the device.
typeCodeableConceptWhat kind of device or device system this is.
specializationarray(DeviceDefinition_Specialization)The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
versionarray(string)The available versions of the device, e.g., software versions.
safetyarray(CodeableConcept)Safety characteristics of the device.
shelfLifeStoragearray(ProductShelfLife)Shelf Life and storage information.
physicalCharacteristicsProdCharacteristicDimensions, color etc.
languageCodearray(CodeableConcept)Language code for the human-readable text strings produced by the device (all supported).
capabilityarray(DeviceDefinition_Capability)Device capabilities.
propertyarray(DeviceDefinition_Property)The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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.
urluriA network address on which the device may be contacted directly.
onlineInformationuriAccess to on-line information about the device.
notearray(Annotation)Descriptive information, usage information or implantation information that is not captured in an existing element.
quantityQuantityThe quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).
parentDeviceReferenceThe parent device it can be part of.
materialarray(DeviceDefinition_Material)A substance used to create the material(s) of which the device is made.

Response

Update Device Definition

put
/organizations/{organizationId}/fhir/4/DeviceDefinition/{resourceId}

The characteristics, operational status and capabilities of a medical-related component of a medical device.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a DeviceDefinition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.
udiDeviceIdentifierarray(DeviceDefinition_UdiDeviceIdentifier)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.
manufacturerStringstringA name of the manufacturer.
manufacturerReferenceReferenceA name of the manufacturer.
deviceNamearray(DeviceDefinition_DeviceName)A name given to the device to identify it.
modelNumberstringThe model number for the device.
typeCodeableConceptWhat kind of device or device system this is.
specializationarray(DeviceDefinition_Specialization)The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
versionarray(string)The available versions of the device, e.g., software versions.
safetyarray(CodeableConcept)Safety characteristics of the device.
shelfLifeStoragearray(ProductShelfLife)Shelf Life and storage information.
physicalCharacteristicsProdCharacteristicDimensions, color etc.
languageCodearray(CodeableConcept)Language code for the human-readable text strings produced by the device (all supported).
capabilityarray(DeviceDefinition_Capability)Device capabilities.
propertyarray(DeviceDefinition_Property)The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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.
urluriA network address on which the device may be contacted directly.
onlineInformationuriAccess to on-line information about the device.
notearray(Annotation)Descriptive information, usage information or implantation information that is not captured in an existing element.
quantityQuantityThe quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).
parentDeviceReferenceThe parent device it can be part of.
materialarray(DeviceDefinition_Material)A substance used to create the material(s) of which the device is made.

Response