device use statements

Create Device Use Statement

post
/organizations/{organizationId}/fhir/3/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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringDeviceUseStatementThis is a DeviceUseStatement resource
identifierarray(Identifier)An external identifier for this statement such as an IRI.
statusstringactive|completed|entered-in-error|intended|stopped|on-holdA 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*ReferenceThe patient who used the device.
whenUsedPeriodThe time period over which the device was used.
timingTimingTimingHow often the device was used.
timingPeriodPeriodHow often the device was used.
timingDateTimestringHow often the device was used.
recordedOnstringThe time at which the statement was made/recorded.
sourceReferenceWho reported the device was being used by the patient.
device*ReferenceThe details of the device used.
indicationarray(CodeableConcept)Reason or justification for the use of the device.
bodySiteCodeableConceptIndicates the site on the subject's body where the device was used ( i.e. the target site).
notearray(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

Patch Device Use Statement

patch
/organizations/{organizationId}/fhir/3/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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDeviceUseStatementThis is a DeviceUseStatement resource
identifierarray(Identifier)An external identifier for this statement such as an IRI.
statusstringactive|completed|entered-in-error|intended|stopped|on-holdA 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*ReferenceThe patient who used the device.
whenUsedPeriodThe time period over which the device was used.
timingTimingTimingHow often the device was used.
timingPeriodPeriodHow often the device was used.
timingDateTimestringHow often the device was used.
recordedOnstringThe time at which the statement was made/recorded.
sourceReferenceWho reported the device was being used by the patient.
device*ReferenceThe details of the device used.
indicationarray(CodeableConcept)Reason or justification for the use of the device.
bodySiteCodeableConceptIndicates the site on the subject's body where the device was used ( i.e. the target site).
notearray(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

Read Device Use Statement

get
/organizations/{organizationId}/fhir/3/DeviceUseStatement/{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 Use Statement

get
/organizations/{organizationId}/fhir/3/DeviceUseStatement/{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 Use Statement

get
/organizations/{organizationId}/fhir/3/DeviceUseStatement/{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 Use Statement

delete
/organizations/{organizationId}/fhir/3/DeviceUseStatement/{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 Use Statement

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

Request

Headers

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

Query params

_idstring
_languagestring
devicestring
identifierstring
patientstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Device Use Statement

get
/organizations/{organizationId}/fhir/3/DeviceUseStatement/_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 Use Statement

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

Query params

_idstring
_languagestring
devicestring
identifierstring
patientstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringDeviceUseStatementThis is a DeviceUseStatement resource
identifierarray(Identifier)An external identifier for this statement such as an IRI.
statusstringactive|completed|entered-in-error|intended|stopped|on-holdA 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*ReferenceThe patient who used the device.
whenUsedPeriodThe time period over which the device was used.
timingTimingTimingHow often the device was used.
timingPeriodPeriodHow often the device was used.
timingDateTimestringHow often the device was used.
recordedOnstringThe time at which the statement was made/recorded.
sourceReferenceWho reported the device was being used by the patient.
device*ReferenceThe details of the device used.
indicationarray(CodeableConcept)Reason or justification for the use of the device.
bodySiteCodeableConceptIndicates the site on the subject's body where the device was used ( i.e. the target site).
notearray(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

Update Device Use Statement

put
/organizations/{organizationId}/fhir/3/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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDeviceUseStatementThis is a DeviceUseStatement resource
identifierarray(Identifier)An external identifier for this statement such as an IRI.
statusstringactive|completed|entered-in-error|intended|stopped|on-holdA 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*ReferenceThe patient who used the device.
whenUsedPeriodThe time period over which the device was used.
timingTimingTimingHow often the device was used.
timingPeriodPeriodHow often the device was used.
timingDateTimestringHow often the device was used.
recordedOnstringThe time at which the statement was made/recorded.
sourceReferenceWho reported the device was being used by the patient.
device*ReferenceThe details of the device used.
indicationarray(CodeableConcept)Reason or justification for the use of the device.
bodySiteCodeableConceptIndicates the site on the subject's body where the device was used ( i.e. the target site).
notearray(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