device requests

Create Device Request

post
/organizations/{organizationId}/fhir/3/DeviceRequest

Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringDeviceRequestThis is a DeviceRequest resource
identifierarray(Identifier)Identifiers assigned to this order by the orderer or by the receiver.
definitionarray(Reference)Protocol or definition followed by this request. For example: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.
basedOnarray(Reference)Plan/proposal/order fulfilled by this request.
priorRequestarray(Reference)The request takes the place of the referenced completed or terminated request(s).
groupIdentifierIdentifierComposite request this is part of.
statusstringThe status of the request.
intent*CodeableConceptWhether the request is a proposal, plan, an original order or a reflex order.
prioritystringIndicates how quickly the {{title}} should be addressed with respect to other requests.
codeReferenceReferenceThe details of the device to be used.
codeCodeableConceptCodeableConceptThe details of the device to be used.
subject*ReferenceThe patient who will use the device.
contextReferenceAn encounter that provides additional context in which this request is made.
occurrenceDateTimestringThe timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
occurrencePeriodPeriodThe timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
occurrenceTimingTimingThe timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
authoredOnstringWhen the request transitioned to being actionable.
requesterDeviceRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the diagnostic testing.
performerReferenceThe desired perfomer for doing the diagnostic testing.
reasonCodearray(CodeableConcept)Reason or justification for the use of this device.
reasonReferencearray(Reference)Reason or justification for the use of this device.
supportingInfoarray(Reference)Additional clinical information about the patient that may influence the request fulfilment. For example, this may includes body where on the subject's the device will be used ( i.e. the target site).
notearray(Annotation)Details about this request 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.
relevantHistoryarray(Reference)Key events in the history of the request.

Response

Patch Device Request

patch
/organizations/{organizationId}/fhir/3/DeviceRequest/{resourceId}

Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.

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*stringDeviceRequestThis is a DeviceRequest resource
identifierarray(Identifier)Identifiers assigned to this order by the orderer or by the receiver.
definitionarray(Reference)Protocol or definition followed by this request. For example: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.
basedOnarray(Reference)Plan/proposal/order fulfilled by this request.
priorRequestarray(Reference)The request takes the place of the referenced completed or terminated request(s).
groupIdentifierIdentifierComposite request this is part of.
statusstringThe status of the request.
intent*CodeableConceptWhether the request is a proposal, plan, an original order or a reflex order.
prioritystringIndicates how quickly the {{title}} should be addressed with respect to other requests.
codeReferenceReferenceThe details of the device to be used.
codeCodeableConceptCodeableConceptThe details of the device to be used.
subject*ReferenceThe patient who will use the device.
contextReferenceAn encounter that provides additional context in which this request is made.
occurrenceDateTimestringThe timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
occurrencePeriodPeriodThe timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
occurrenceTimingTimingThe timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
authoredOnstringWhen the request transitioned to being actionable.
requesterDeviceRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the diagnostic testing.
performerReferenceThe desired perfomer for doing the diagnostic testing.
reasonCodearray(CodeableConcept)Reason or justification for the use of this device.
reasonReferencearray(Reference)Reason or justification for the use of this device.
supportingInfoarray(Reference)Additional clinical information about the patient that may influence the request fulfilment. For example, this may includes body where on the subject's the device will be used ( i.e. the target site).
notearray(Annotation)Details about this request 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.
relevantHistoryarray(Reference)Key events in the history of the request.

Response

Read Device Request

get
/organizations/{organizationId}/fhir/3/DeviceRequest/{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 Request

get
/organizations/{organizationId}/fhir/3/DeviceRequest/{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 Request

get
/organizations/{organizationId}/fhir/3/DeviceRequest/{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 Request

delete
/organizations/{organizationId}/fhir/3/DeviceRequest/{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 Request

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

Request

Headers

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

Query params

_idstring
_languagestring
authored-onstring
based-onstring
codestring
definitionstring
devicestring
encounterstring
event-datestring
group-identifierstring
identifierstring
intentstring
patientstring
performerstring
priorrequeststring
requesterstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Device Request

get
/organizations/{organizationId}/fhir/3/DeviceRequest/_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 Request

post
/organizations/{organizationId}/fhir/3/DeviceRequest/_search

Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authored-onstring
based-onstring
codestring
definitionstring
devicestring
encounterstring
event-datestring
group-identifierstring
identifierstring
intentstring
patientstring
performerstring
priorrequeststring
requesterstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringDeviceRequestThis is a DeviceRequest resource
identifierarray(Identifier)Identifiers assigned to this order by the orderer or by the receiver.
definitionarray(Reference)Protocol or definition followed by this request. For example: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.
basedOnarray(Reference)Plan/proposal/order fulfilled by this request.
priorRequestarray(Reference)The request takes the place of the referenced completed or terminated request(s).
groupIdentifierIdentifierComposite request this is part of.
statusstringThe status of the request.
intent*CodeableConceptWhether the request is a proposal, plan, an original order or a reflex order.
prioritystringIndicates how quickly the {{title}} should be addressed with respect to other requests.
codeReferenceReferenceThe details of the device to be used.
codeCodeableConceptCodeableConceptThe details of the device to be used.
subject*ReferenceThe patient who will use the device.
contextReferenceAn encounter that provides additional context in which this request is made.
occurrenceDateTimestringThe timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
occurrencePeriodPeriodThe timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
occurrenceTimingTimingThe timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
authoredOnstringWhen the request transitioned to being actionable.
requesterDeviceRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the diagnostic testing.
performerReferenceThe desired perfomer for doing the diagnostic testing.
reasonCodearray(CodeableConcept)Reason or justification for the use of this device.
reasonReferencearray(Reference)Reason or justification for the use of this device.
supportingInfoarray(Reference)Additional clinical information about the patient that may influence the request fulfilment. For example, this may includes body where on the subject's the device will be used ( i.e. the target site).
notearray(Annotation)Details about this request 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.
relevantHistoryarray(Reference)Key events in the history of the request.

Response

Update Device Request

put
/organizations/{organizationId}/fhir/3/DeviceRequest/{resourceId}

Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDeviceRequestThis is a DeviceRequest resource
identifierarray(Identifier)Identifiers assigned to this order by the orderer or by the receiver.
definitionarray(Reference)Protocol or definition followed by this request. For example: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.
basedOnarray(Reference)Plan/proposal/order fulfilled by this request.
priorRequestarray(Reference)The request takes the place of the referenced completed or terminated request(s).
groupIdentifierIdentifierComposite request this is part of.
statusstringThe status of the request.
intent*CodeableConceptWhether the request is a proposal, plan, an original order or a reflex order.
prioritystringIndicates how quickly the {{title}} should be addressed with respect to other requests.
codeReferenceReferenceThe details of the device to be used.
codeCodeableConceptCodeableConceptThe details of the device to be used.
subject*ReferenceThe patient who will use the device.
contextReferenceAn encounter that provides additional context in which this request is made.
occurrenceDateTimestringThe timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
occurrencePeriodPeriodThe timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
occurrenceTimingTimingThe timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
authoredOnstringWhen the request transitioned to being actionable.
requesterDeviceRequest_RequesterThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the diagnostic testing.
performerReferenceThe desired perfomer for doing the diagnostic testing.
reasonCodearray(CodeableConcept)Reason or justification for the use of this device.
reasonReferencearray(Reference)Reason or justification for the use of this device.
supportingInfoarray(Reference)Additional clinical information about the patient that may influence the request fulfilment. For example, this may includes body where on the subject's the device will be used ( i.e. the target site).
notearray(Annotation)Details about this request 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.
relevantHistoryarray(Reference)Key events in the history of the request.

Response