Health eData 1 Sandbox, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/argonautproject/USCDIV7/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-devicerequest | Version: 0.1.0 | |||
| Active as of 2026-05-15 | Maturity Level: 3 | Computable Name: USCoreDeviceRequestProfile | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.75 | ||||
The US Core DeviceRequest Profile inherits from the FHIR DeviceRequest resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Medical Device Order Data Element of the Orders Data Class. It sets minimum expectations for the DeviceRequest resource to record, search, and fetch orders for medical devices for a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.
Example Usage Scenarios:
The following are example usage scenarios for the US Core DeviceRequest profile:
The following data elements must always be present ([Mandatory] definition) or must be supported if the data is present in the sending system ([Must Support] definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The [Formal Views] below provides the formal summary, definitions, and terminology requirements.
Each DeviceRequest Must Have:
Each DeviceRequest Must Support:
This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.
{% include structure-table.md sd=sd source="differential" show_must_support=true show_uscdi=true %}
The US Core DeviceRequest Profile inherits from the FHIR DeviceRequest resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Medical Device Order Data Element of the Orders Data Class. It sets minimum expectations for the DeviceRequest resource to record, search, and fetch orders for medical devices for a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.
http://hl7.org/fhir/us/core/StructureDefinition/us-core-devicerequestDeviceRequesthttp://hl7.org/fhir/StructureDefinition/DeviceRequest| Element | Must Support | Add'l USCDI | Cardinality | Type | Description |
|---|---|---|---|---|---|
DeviceRequest |
0..* | Medical device request 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. |
|||
↳ identifier |
✅ | 0..* | Identifier |
External Request identifier Identifiers assigned to this order by the orderer or by the receiver. |
|
↳ status |
✅ | 1..1 | code |
draft | active | on-hold | revoked | completed | entered-in-error | unknown The status of the request. Binding: http://hl7.org/fhir/ValueSet/request-status\|4.0.1 (required) — Codes representing the status of the request. |
|
↳ intent |
✅ | 1..1 | code |
proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Whether the request is a proposal, plan, an original order or a reflex order. Binding: http://hl7.org/fhir/ValueSet/request-intent\|4.0.1 (required) — The kind of diagnostic request. |
|
↳ code[x] |
✅ | 1..1 | CodeableConceptReferencetarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device |
Device requested The details of the device to be used. Binding: http://hl7.org/fhir/ValueSet/device-kind (preferred) |
|
↳ subject |
✅ | 1..1 | Referencetarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient target: http://hl7.org/fhir/StructureDefinition/Group target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device |
Focus of request The patient who will use the device. |
|
↳ authoredOn |
✅ | 0..1 | dateTime |
When recorded When the request transitioned to being actionable. |
|
↳ requester |
✅ | 0..1 | Referencetarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device |
Who/what is requesting diagnostics The individual who initiated the request and has responsibility for its activation. |
## USCoreDeviceRequestProfile — US Core DeviceRequest Profile
The US Core DeviceRequest Profile inherits from the FHIR [DeviceRequest](https://hl7.org/fhir/R4/devicerequest.html) resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) *Medical Device Order Data Element of the Orders Data Class*. It sets minimum expectations for the DeviceRequest resource to record, search, and fetch orders for medical devices for a patient. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.
- **URL:** `http://hl7.org/fhir/us/core/StructureDefinition/us-core-devicerequest`
- **Version:** 0.1.0
- **Status:** active
- **Kind:** resource
- **Type:** `DeviceRequest`
- **Base Definition:** `http://hl7.org/fhir/StructureDefinition/DeviceRequest`
- **Derivation:** constraint
### Elements (differential)
| Element | Must Support | Add'l USCDI | Cardinality | Type | Description |
|---|:---:|:---:|---|---|---|
| `DeviceRequest` | | | 0..* | | **Medical device request**<br/>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. |
| <span style="padding-left: 1.5em;">↳</span> `identifier` | ✅ | | 0..* | `Identifier` | **External Request identifier**<br/>Identifiers assigned to this order by the orderer or by the receiver. |
| <span style="padding-left: 1.5em;">↳</span> `status` | ✅ | | 1..1 | `code` | **draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown**<br/>The status of the request.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/request-status\|4.0.1` (required) — Codes representing the status of the request.</span> |
| <span style="padding-left: 1.5em;">↳</span> `intent` | ✅ | | 1..1 | `code` | **proposal \| plan \| directive \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option**<br/>Whether the request is a proposal, plan, an original order or a reflex order.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/request-intent\|4.0.1` (required) — The kind of diagnostic request.</span> |
| <span style="padding-left: 1.5em;">↳</span> `code[x]` | ✅ | | 1..1 | `CodeableConcept`<br/>`Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device</span> | **Device requested**<br/>The details of the device to be used.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/device-kind` (preferred)</span> |
| <span style="padding-left: 1.5em;">↳</span> `subject` | ✅ | | 1..1 | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/StructureDefinition/Group</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device</span> | **Focus of request**<br/>The patient who will use the device. |
| <span style="padding-left: 1.5em;">↳</span> `authoredOn` | ✅ | | 0..1 | `dateTime` | **When recorded**<br/>When the request transitioned to being actionable. |
| <span style="padding-left: 1.5em;">↳</span> `requester` | ✅ | | 0..1 | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device</span> | **Who/what is requesting diagnostics**<br/>The individual who initiated the request and has responsibility for its activation. |
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DeviceRequest | Medical device request | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..* | Identifier | External Request identifier |
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes representing the status of the request. |
![]() ![]() |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of diagnostic request. |
![]() ![]() |
SΣ | 1..1 | Device requested Binding: FHIRDeviceTypes (preferred) | |
![]() ![]() ![]() |
CodeableConcept S | |||
![]() ![]() ![]() |
Reference(US Core Device Profile) | |||
![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(9.0.0-ballot) S | Group | US Core Location Profile | US Core Device Profile) | Focus of request |
![]() ![]() |
SΣ | 0..1 | dateTime | When recorded |
![]() ![]() |
SΣ | 0..1 | Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | US Core Organization Profile | US Core Device Profile) | Who/what is requesting diagnostics |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| DeviceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| DeviceRequest.code[x] | Base | preferred | FHIR Device Types | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DeviceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DeviceRequest | Medical device request | |
![]() ![]() |
S | 0..* | Identifier | External Request identifier |
![]() ![]() |
S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
![]() ![]() |
S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
![]() ![]() |
S | 1..1 | Device requested Binding: FHIRDeviceTypes (preferred) | |
![]() ![]() ![]() |
CodeableConcept S | |||
![]() ![]() ![]() |
Reference(US Core Device Profile) | |||
![]() ![]() |
S | 1..1 | Reference(US Core Patient Profile(9.0.0-ballot) S | Group | US Core Location Profile | US Core Device Profile) | Focus of request |
![]() ![]() |
S | 0..1 | dateTime | When recorded |
![]() ![]() |
S | 0..1 | Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | US Core Organization Profile | US Core Device Profile) | Who/what is requesting diagnostics |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceRequest.code[x] | Base | preferred | FHIR Device Types | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DeviceRequest | Medical device request | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | External Request identifier | ||||
![]() ![]() |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | What request fulfills | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | What request replaces | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Identifier of composite request | ||||
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes representing the status of the request. | ||||
![]() ![]() |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of diagnostic request. | ||||
![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
![]() ![]() |
SΣ | 1..1 | Device requested Binding: FHIRDeviceTypes (preferred) | |||||
![]() ![]() ![]() |
CodeableConcept S | |||||||
![]() ![]() ![]() |
Reference(US Core Device Profile) | |||||||
![]() ![]() |
0..* | BackboneElement | Device details | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Device detail Binding Description: (example): A code that identifies the device detail. | |||||
![]() ![]() ![]() |
0..1 | Value of detail | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(9.0.0-ballot) S | Group | US Core Location Profile | US Core Device Profile) | Focus of request | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter motivating request | ||||
![]() ![]() |
Σ | 0..1 | Desired time or schedule for use | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Timing | |||||||
![]() ![]() |
SΣ | 0..1 | dateTime | When recorded | ||||
![]() ![]() |
SΣ | 0..1 | Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | US Core Organization Profile | US Core Device Profile) | Who/what is requesting diagnostics | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Filler role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested Filler | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (example): Diagnosis or problem codes justifying the reason for requesting the device. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Linked Reason for request | ||||
![]() ![]() |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
![]() ![]() |
0..* | Reference(Resource) | Additional clinical information | |||||
![]() ![]() |
0..* | Annotation | Notes or comments | |||||
![]() ![]() |
0..* | Reference(Provenance) | Request provenance | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DeviceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| DeviceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| DeviceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| DeviceRequest.code[x] | Base | preferred | FHIR Device Types | 📦4.0.1 | FHIR Std. |
| DeviceRequest.parameter.code | Base | example | Not State | Unknown | |
| DeviceRequest.performerType | Base | example | Participant Roles | 📍4.0.1 | FHIR Std. |
| DeviceRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DeviceRequest
Summary
Mandatory: 1 element
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DeviceRequest | Medical device request | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..* | Identifier | External Request identifier |
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes representing the status of the request. |
![]() ![]() |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of diagnostic request. |
![]() ![]() |
SΣ | 1..1 | Device requested Binding: FHIRDeviceTypes (preferred) | |
![]() ![]() ![]() |
CodeableConcept S | |||
![]() ![]() ![]() |
Reference(US Core Device Profile) | |||
![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(9.0.0-ballot) S | Group | US Core Location Profile | US Core Device Profile) | Focus of request |
![]() ![]() |
SΣ | 0..1 | dateTime | When recorded |
![]() ![]() |
SΣ | 0..1 | Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | US Core Organization Profile | US Core Device Profile) | Who/what is requesting diagnostics |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| DeviceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| DeviceRequest.code[x] | Base | preferred | FHIR Device Types | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from DeviceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DeviceRequest | Medical device request | |
![]() ![]() |
S | 0..* | Identifier | External Request identifier |
![]() ![]() |
S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
![]() ![]() |
S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
![]() ![]() |
S | 1..1 | Device requested Binding: FHIRDeviceTypes (preferred) | |
![]() ![]() ![]() |
CodeableConcept S | |||
![]() ![]() ![]() |
Reference(US Core Device Profile) | |||
![]() ![]() |
S | 1..1 | Reference(US Core Patient Profile(9.0.0-ballot) S | Group | US Core Location Profile | US Core Device Profile) | Focus of request |
![]() ![]() |
S | 0..1 | dateTime | When recorded |
![]() ![]() |
S | 0..1 | Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | US Core Organization Profile | US Core Device Profile) | Who/what is requesting diagnostics |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceRequest.code[x] | Base | preferred | FHIR Device Types | 📦4.0.1 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DeviceRequest | Medical device request | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | External Request identifier | ||||
![]() ![]() |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | What request fulfills | ||||
![]() ![]() |
Σ | 0..* | Reference(Resource) | What request replaces | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Identifier of composite request | ||||
![]() ![]() |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes representing the status of the request. | ||||
![]() ![]() |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of diagnostic request. | ||||
![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
![]() ![]() |
SΣ | 1..1 | Device requested Binding: FHIRDeviceTypes (preferred) | |||||
![]() ![]() ![]() |
CodeableConcept S | |||||||
![]() ![]() ![]() |
Reference(US Core Device Profile) | |||||||
![]() ![]() |
0..* | BackboneElement | Device details | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Device detail Binding Description: (example): A code that identifies the device detail. | |||||
![]() ![]() ![]() |
0..1 | Value of detail | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile(9.0.0-ballot) S | Group | US Core Location Profile | US Core Device Profile) | Focus of request | ||||
![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter motivating request | ||||
![]() ![]() |
Σ | 0..1 | Desired time or schedule for use | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Timing | |||||||
![]() ![]() |
SΣ | 0..1 | dateTime | When recorded | ||||
![]() ![]() |
SΣ | 0..1 | Reference(US Core Practitioner Profile S | US Core PractitionerRole Profile | US Core Organization Profile | US Core Device Profile) | Who/what is requesting diagnostics | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Filler role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested Filler | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (example): Diagnosis or problem codes justifying the reason for requesting the device. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Linked Reason for request | ||||
![]() ![]() |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
![]() ![]() |
0..* | Reference(Resource) | Additional clinical information | |||||
![]() ![]() |
0..* | Annotation | Notes or comments | |||||
![]() ![]() |
0..* | Reference(Provenance) | Request provenance | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DeviceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DeviceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| DeviceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| DeviceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| DeviceRequest.code[x] | Base | preferred | FHIR Device Types | 📦4.0.1 | FHIR Std. |
| DeviceRequest.parameter.code | Base | example | Not State | Unknown | |
| DeviceRequest.performerType | Base | example | Participant Roles | 📍4.0.1 | FHIR Std. |
| DeviceRequest.reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DeviceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DeviceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DeviceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DeviceRequest
Summary
Mandatory: 1 element
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron