device use statements
Create Device Use Statement
post
/organizations/{organizationId}/fhir/4/DeviceUseStatement
A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.
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 DeviceUseStatement 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) | An external identifier for this statement such as an IRI. | |
basedOn | array(Reference) | A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement. | |
status | active|completed|entered-in-error|intended|stopped|on-hold | A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed. | |
subject* | Reference | The patient who used the device. | |
derivedFrom | array(Reference) | Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement. | |
timingTiming | Timing | How often the device was used. | |
timingPeriod | Period | How often the device was used. | |
timingDateTime | string | How often the device was used. | |
recordedOn | dateTime | The time at which the statement was made/recorded. | |
source | Reference | Who reported the device was being used by the patient. | |
device* | Reference | The details of the device used. | |
reasonCode | array(CodeableConcept) | Reason or justification for the use of the device. | |
reasonReference | array(Reference) | Indicates another resource whose existence justifies this DeviceUseStatement. | |
bodySite | CodeableConcept | Indicates the anotomic location on the subject's body where the device was used ( i.e. the target). | |
note | array(Annotation) | Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement. |
Response
keyboard_arrow_down
Patch Device Use Statement
patch
/organizations/{organizationId}/fhir/4/DeviceUseStatement/{resourceId}
A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.
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 DeviceUseStatement 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) | An external identifier for this statement such as an IRI. | |
basedOn | array(Reference) | A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement. | |
status | active|completed|entered-in-error|intended|stopped|on-hold | A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed. | |
subject* | Reference | The patient who used the device. | |
derivedFrom | array(Reference) | Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement. | |
timingTiming | Timing | How often the device was used. | |
timingPeriod | Period | How often the device was used. | |
timingDateTime | string | How often the device was used. | |
recordedOn | dateTime | The time at which the statement was made/recorded. | |
source | Reference | Who reported the device was being used by the patient. | |
device* | Reference | The details of the device used. | |
reasonCode | array(CodeableConcept) | Reason or justification for the use of the device. | |
reasonReference | array(Reference) | Indicates another resource whose existence justifies this DeviceUseStatement. | |
bodySite | CodeableConcept | Indicates the anotomic location on the subject's body where the device was used ( i.e. the target). | |
note | array(Annotation) | Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement. |
Response
keyboard_arrow_down
Read Device Use Statement
get
/organizations/{organizationId}/fhir/4/DeviceUseStatement/{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
keyboard_arrow_down
Read History Device Use Statement
get
/organizations/{organizationId}/fhir/4/DeviceUseStatement/{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
keyboard_arrow_down
Read Version Device Use Statement
get
/organizations/{organizationId}/fhir/4/DeviceUseStatement/{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
keyboard_arrow_down
Remove Device Use Statement
delete
/organizations/{organizationId}/fhir/4/DeviceUseStatement/{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
keyboard_arrow_down
Search Get Device Use Statement
get
/organizations/{organizationId}/fhir/4/DeviceUseStatement
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 | string | ||
identifier | string | ||
patient | string | ||
subject | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Device Use Statement
get
/organizations/{organizationId}/fhir/4/DeviceUseStatement/_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
keyboard_arrow_down
Search Post Device Use Statement
post
/organizations/{organizationId}/fhir/4/DeviceUseStatement/_search
A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.
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 | string | ||
identifier | string | ||
patient | string | ||
subject | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a DeviceUseStatement 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) | An external identifier for this statement such as an IRI. | |
basedOn | array(Reference) | A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement. | |
status | active|completed|entered-in-error|intended|stopped|on-hold | A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed. | |
subject* | Reference | The patient who used the device. | |
derivedFrom | array(Reference) | Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement. | |
timingTiming | Timing | How often the device was used. | |
timingPeriod | Period | How often the device was used. | |
timingDateTime | string | How often the device was used. | |
recordedOn | dateTime | The time at which the statement was made/recorded. | |
source | Reference | Who reported the device was being used by the patient. | |
device* | Reference | The details of the device used. | |
reasonCode | array(CodeableConcept) | Reason or justification for the use of the device. | |
reasonReference | array(Reference) | Indicates another resource whose existence justifies this DeviceUseStatement. | |
bodySite | CodeableConcept | Indicates the anotomic location on the subject's body where the device was used ( i.e. the target). | |
note | array(Annotation) | Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement. |
Response
keyboard_arrow_down
Update Device Use Statement
put
/organizations/{organizationId}/fhir/4/DeviceUseStatement/{resourceId}
A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.
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 DeviceUseStatement 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) | An external identifier for this statement such as an IRI. | |
basedOn | array(Reference) | A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement. | |
status | active|completed|entered-in-error|intended|stopped|on-hold | A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed. | |
subject* | Reference | The patient who used the device. | |
derivedFrom | array(Reference) | Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement. | |
timingTiming | Timing | How often the device was used. | |
timingPeriod | Period | How often the device was used. | |
timingDateTime | string | How often the device was used. | |
recordedOn | dateTime | The time at which the statement was made/recorded. | |
source | Reference | Who reported the device was being used by the patient. | |
device* | Reference | The details of the device used. | |
reasonCode | array(CodeableConcept) | Reason or justification for the use of the device. | |
reasonReference | array(Reference) | Indicates another resource whose existence justifies this DeviceUseStatement. | |
bodySite | CodeableConcept | Indicates the anotomic location on the subject's body where the device was used ( i.e. the target). | |
note | array(Annotation) | Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement. |
Response
keyboard_arrow_down