device requests

Create Device Request

post
/organizations/{organizationId}/fhir/4/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/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a DeviceRequest 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)Identifiers assigned to this order by the orderer or by the receiver.
instantiatesCanonicalarray(canonical)The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
instantiatesUriarray(uri)The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
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.
statuscodeThe status of the request.
intentcodeWhether the request is a proposal, plan, an original order or a reflex order.
prioritycodeIndicates 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.
parameterarray(DeviceRequest_Parameter)Specific parameters for the ordered item. For example, the prism value for lenses.
subject*ReferenceThe patient who will use the device.
encounterReferenceAn 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".
authoredOndateTimeWhen the request transitioned to being actionable.
requesterReferenceThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the diagnostic testing.
performerReferenceThe desired performer 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.
insurancearray(Reference)Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
supportingInfoarray(Reference)Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body 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/4/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*This is a DeviceRequest 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)Identifiers assigned to this order by the orderer or by the receiver.
instantiatesCanonicalarray(canonical)The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
instantiatesUriarray(uri)The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
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.
statuscodeThe status of the request.
intentcodeWhether the request is a proposal, plan, an original order or a reflex order.
prioritycodeIndicates 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.
parameterarray(DeviceRequest_Parameter)Specific parameters for the ordered item. For example, the prism value for lenses.
subject*ReferenceThe patient who will use the device.
encounterReferenceAn 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".
authoredOndateTimeWhen the request transitioned to being actionable.
requesterReferenceThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the diagnostic testing.
performerReferenceThe desired performer 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.
insurancearray(Reference)Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
supportingInfoarray(Reference)Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body 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/4/DeviceRequest/{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 Request

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

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

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

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

Request

Headers

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

Query params

_idstring
_languagestring
authored-onstring
based-onstring
codestring
devicestring
encounterstring
event-datestring
group-identifierstring
identifierstring
instantiates-canonicalstring
instantiates-uri string
insurancesstring
intentstring
patientstring
performerstring
priorrequeststring
requesterstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Device Request

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

post
/organizations/{organizationId}/fhir/4/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
devicestring
encounterstring
event-datestring
group-identifierstring
identifierstring
instantiates-canonicalstring
instantiates-uri string
insurancesstring
intentstring
patientstring
performerstring
priorrequeststring
requesterstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a DeviceRequest 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)Identifiers assigned to this order by the orderer or by the receiver.
instantiatesCanonicalarray(canonical)The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
instantiatesUriarray(uri)The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
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.
statuscodeThe status of the request.
intentcodeWhether the request is a proposal, plan, an original order or a reflex order.
prioritycodeIndicates 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.
parameterarray(DeviceRequest_Parameter)Specific parameters for the ordered item. For example, the prism value for lenses.
subject*ReferenceThe patient who will use the device.
encounterReferenceAn 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".
authoredOndateTimeWhen the request transitioned to being actionable.
requesterReferenceThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the diagnostic testing.
performerReferenceThe desired performer 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.
insurancearray(Reference)Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
supportingInfoarray(Reference)Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body 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/4/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|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a DeviceRequest 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)Identifiers assigned to this order by the orderer or by the receiver.
instantiatesCanonicalarray(canonical)The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
instantiatesUriarray(uri)The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
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.
statuscodeThe status of the request.
intentcodeWhether the request is a proposal, plan, an original order or a reflex order.
prioritycodeIndicates 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.
parameterarray(DeviceRequest_Parameter)Specific parameters for the ordered item. For example, the prism value for lenses.
subject*ReferenceThe patient who will use the device.
encounterReferenceAn 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".
authoredOndateTimeWhen the request transitioned to being actionable.
requesterReferenceThe individual who initiated the request and has responsibility for its activation.
performerTypeCodeableConceptDesired type of performer for doing the diagnostic testing.
performerReferenceThe desired performer 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.
insurancearray(Reference)Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
supportingInfoarray(Reference)Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body 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