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*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	DeviceUseStatement	This is a DeviceUseStatement resource
identifier	array(Identifier)		An external identifier for this statement such as an IRI.
status	string	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.
whenUsed	Period		The time period over which the device was used.
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	string		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.
indication	array(CodeableConcept)		Reason or justification for the use of the device.
bodySite	CodeableConcept		Indicates the site on the subject's body where the device was used ( i.e. the target site).
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

201 400 401 404

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*	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*	string	DeviceUseStatement	This is a DeviceUseStatement resource
identifier	array(Identifier)		An external identifier for this statement such as an IRI.
status	string	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.
whenUsed	Period		The time period over which the device was used.
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	string		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.
indication	array(CodeableConcept)		Reason or justification for the use of the device.
bodySite	CodeableConcept		Indicates the site on the subject's body where the device was used ( i.e. the target site).
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

200 201 400 401 404 409

Read Device Use Statement

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Device Use Statement

get

/organizations/{organizationId}/fhir/3/DeviceUseStatement/{resourceId}/_history

Request

Headers


content-type*	string	application/json	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

200 401 404

Read Version Device Use Statement

get

/organizations/{organizationId}/fhir/3/DeviceUseStatement/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json	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

200 400 401 404

Remove Device Use Statement

delete

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Device Use Statement

get

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

Request

Headers


content-type*	string	application/json	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

200 401 404

Search History Device Use Statement

get

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

Request

Headers


content-type*	string	application/json	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

200 401 404

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*	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*	string	DeviceUseStatement	This is a DeviceUseStatement resource
identifier	array(Identifier)		An external identifier for this statement such as an IRI.
status	string	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.
whenUsed	Period		The time period over which the device was used.
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	string		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.
indication	array(CodeableConcept)		Reason or justification for the use of the device.
bodySite	CodeableConcept		Indicates the site on the subject's body where the device was used ( i.e. the target site).
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

200 401 404

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*	string	application/json	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*	string	DeviceUseStatement	This is a DeviceUseStatement resource
identifier	array(Identifier)		An external identifier for this statement such as an IRI.
status	string	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.
whenUsed	Period		The time period over which the device was used.
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	string		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.
indication	array(CodeableConcept)		Reason or justification for the use of the device.
bodySite	CodeableConcept		Indicates the site on the subject's body where the device was used ( i.e. the target site).
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

200 201 400 401 404 409