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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Device 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 manufacturers other organizations or owners.
definitionReferenceThe reference to the definition for the device.
udiCarrierarray(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.
statusactive|inactive|entered-in-error|unknownStatus of the Device availability.
statusReasonarray(CodeableConcept)Reason for the dtatus of the Device availability.
distinctIdentifierstringThe distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
manufacturerstringA name of the manufacturer.
manufactureDatedateTimeThe date and time when the device was manufactured.
expirationDatedateTimeThe date and time beyond which this device is no longer valid or should not be used (if applicable).
lotNumberstringLot number assigned by the manufacturer.
serialNumberstringThe serial number assigned by the organization when the device was manufactured.
deviceNamearray(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.
modelNumberstringThe model number for the device.
partNumberstringThe part number of the device.
typeCodeableConceptThe kind or type of device.
specializationarray(Device_Specialization)The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
versionarray(Device_Version)The actual design of the device or software version running on the device.
propertyarray(Device_Property)The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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.
urluriA 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.
parentReferenceThe parent device.

Response

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*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 Device 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 manufacturers other organizations or owners.
definitionReferenceThe reference to the definition for the device.
udiCarrierarray(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.
statusactive|inactive|entered-in-error|unknownStatus of the Device availability.
statusReasonarray(CodeableConcept)Reason for the dtatus of the Device availability.
distinctIdentifierstringThe distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
manufacturerstringA name of the manufacturer.
manufactureDatedateTimeThe date and time when the device was manufactured.
expirationDatedateTimeThe date and time beyond which this device is no longer valid or should not be used (if applicable).
lotNumberstringLot number assigned by the manufacturer.
serialNumberstringThe serial number assigned by the organization when the device was manufactured.
deviceNamearray(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.
modelNumberstringThe model number for the device.
partNumberstringThe part number of the device.
typeCodeableConceptThe kind or type of device.
specializationarray(Device_Specialization)The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
versionarray(Device_Version)The actual design of the device or software version running on the device.
propertyarray(Device_Property)The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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.
urluriA 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.
parentReferenceThe parent device.

Response

Read Device

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

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

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

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

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Device/_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

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*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*This is a Device 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 manufacturers other organizations or owners.
definitionReferenceThe reference to the definition for the device.
udiCarrierarray(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.
statusactive|inactive|entered-in-error|unknownStatus of the Device availability.
statusReasonarray(CodeableConcept)Reason for the dtatus of the Device availability.
distinctIdentifierstringThe distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
manufacturerstringA name of the manufacturer.
manufactureDatedateTimeThe date and time when the device was manufactured.
expirationDatedateTimeThe date and time beyond which this device is no longer valid or should not be used (if applicable).
lotNumberstringLot number assigned by the manufacturer.
serialNumberstringThe serial number assigned by the organization when the device was manufactured.
deviceNamearray(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.
modelNumberstringThe model number for the device.
partNumberstringThe part number of the device.
typeCodeableConceptThe kind or type of device.
specializationarray(Device_Specialization)The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
versionarray(Device_Version)The actual design of the device or software version running on the device.
propertyarray(Device_Property)The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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.
urluriA 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.
parentReferenceThe parent device.

Response

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*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 Device 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 manufacturers other organizations or owners.
definitionReferenceThe reference to the definition for the device.
udiCarrierarray(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.
statusactive|inactive|entered-in-error|unknownStatus of the Device availability.
statusReasonarray(CodeableConcept)Reason for the dtatus of the Device availability.
distinctIdentifierstringThe distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
manufacturerstringA name of the manufacturer.
manufactureDatedateTimeThe date and time when the device was manufactured.
expirationDatedateTimeThe date and time beyond which this device is no longer valid or should not be used (if applicable).
lotNumberstringLot number assigned by the manufacturer.
serialNumberstringThe serial number assigned by the organization when the device was manufactured.
deviceNamearray(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.
modelNumberstringThe model number for the device.
partNumberstringThe part number of the device.
typeCodeableConceptThe kind or type of device.
specializationarray(Device_Specialization)The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
versionarray(Device_Version)The actual design of the device or software version running on the device.
propertyarray(Device_Property)The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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.
urluriA 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.
parentReferenceThe parent device.

Response