Health eData 1 Sandbox
0.1.0 - CI Build United States of America flag

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

Resource Profile: US Core DeviceRequest Profile

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:

  • Query for DeviceRequest resources belonging to a Patient
  • [Record or update] a Patient DeviceRequest

Mandatory and Must Support Data Elements

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:

  1. an intent
  2. device requested
  3. focus of request

Each DeviceRequest Must Support:

  1. a status
  2. when recorded
  3. who or what is requesting the device

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

  • FOO

Liquid Script to Generate StructureDefinition All Nice N Pretty Like

{% include structure-table.md sd=sd source="differential" show_must_support=true show_uscdi=true %}

USCoreDeviceRequestProfile — US Core DeviceRequest Profile

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.

  • 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
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 CodeableConcept
Reference
target: 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 Reference
target: 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 Reference
target: 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

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceRequest 0..* DeviceRequest Medical device request
DeviceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DeviceRequest.identifier This element must be supported. This element is included in summaries. 0..* Identifier External Request identifier
DeviceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes representing the status of the request.
DeviceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of diagnostic request.
DeviceRequest.code[x] This element must be supported. This element is included in summaries. 1..1 Device requested
Binding: FHIRDeviceTypes (preferred)
DeviceRequest.code[x].codeCodeableConcept CodeableConcept This type must be supported.
DeviceRequest.code[x].codeReference Reference(US Core Device Profile)
DeviceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(9.0.0) This type must be supported. | Group | US Core Location Profile | US Core Device Profile) Focus of request
DeviceRequest.authoredOn This element must be supported. This element is included in summaries. 0..1 dateTime When recorded
DeviceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core Organization Profile | US Core Device Profile) Who/what is requesting diagnostics

doco Documentation for this format

Terminology Bindings

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.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceRequest 0..* DeviceRequest Medical device request
DeviceRequest.identifier This element must be supported. 0..* Identifier External Request identifier
DeviceRequest.status This element must be supported. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
DeviceRequest.intent This element must be supported. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
DeviceRequest.code[x].codeCodeableConcept CodeableConcept This type must be supported.
DeviceRequest.code[x].codeReference Reference(US Core Device Profile)
DeviceRequest.subject This element must be supported. 1..1 Reference(US Core Patient Profile(9.0.0) This type must be supported. | Group | US Core Location Profile | US Core Device Profile) Focus of request
DeviceRequest.authoredOn This element must be supported. 0..1 dateTime When recorded
DeviceRequest.requester This element must be supported. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core Organization Profile | US Core Device Profile) Who/what is requesting diagnostics

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DeviceRequest.code[x] Base preferred FHIR Device Types 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceRequest 0..* DeviceRequest Medical device request
DeviceRequest.id This element is included in summaries. 0..1 id Logical id of this artifact
DeviceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DeviceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceRequest.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
DeviceRequest.text 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
DeviceRequest.contained 0..* Resource Contained, inline Resources
DeviceRequest.extension 0..* Extension Additional content defined by implementations
DeviceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DeviceRequest.identifier This element must be supported. This element is included in summaries. 0..* Identifier External Request identifier
DeviceRequest.instantiatesCanonical This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
DeviceRequest.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
DeviceRequest.basedOn This element is included in summaries. 0..* Reference(Resource) What request fulfills
DeviceRequest.priorRequest This element is included in summaries. 0..* Reference(Resource) What request replaces
DeviceRequest.groupIdentifier This element is included in summaries. 0..1 Identifier Identifier of composite request
DeviceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes representing the status of the request.
DeviceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of diagnostic request.
DeviceRequest.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
DeviceRequest.code[x] This element must be supported. This element is included in summaries. 1..1 Device requested
Binding: FHIRDeviceTypes (preferred)
DeviceRequest.code[x].codeCodeableConcept CodeableConcept This type must be supported.
DeviceRequest.code[x].codeReference Reference(US Core Device Profile)
DeviceRequest.parameter 0..* BackboneElement Device details
DeviceRequest.parameter.id 0..1 string Unique id for inter-element referencing
DeviceRequest.parameter.extension 0..* Extension Additional content defined by implementations
DeviceRequest.parameter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DeviceRequest.parameter.code 0..1 CodeableConcept Device detail
Binding Description: (example): A code that identifies the device detail.
DeviceRequest.parameter.value[x] 0..1 Value of detail
DeviceRequest.parameter.value[x].valueCodeableConcept CodeableConcept
DeviceRequest.parameter.value[x].valueQuantity Quantity
DeviceRequest.parameter.value[x].valueRange Range
DeviceRequest.parameter.value[x].valueBoolean boolean
DeviceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(9.0.0) This type must be supported. | Group | US Core Location Profile | US Core Device Profile) Focus of request
DeviceRequest.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter motivating request
DeviceRequest.occurrence[x] This element is included in summaries. 0..1 Desired time or schedule for use
DeviceRequest.occurrence[x].occurrenceDateTime dateTime
DeviceRequest.occurrence[x].occurrencePeriod Period
DeviceRequest.occurrence[x].occurrenceTiming Timing
DeviceRequest.authoredOn This element must be supported. This element is included in summaries. 0..1 dateTime When recorded
DeviceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core Organization Profile | US Core Device Profile) Who/what is requesting diagnostics
DeviceRequest.performerType This element is included in summaries. 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.
DeviceRequest.performer This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested Filler
DeviceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Coded Reason for request
Binding: Condition/Problem/DiagnosisCodes (example): Diagnosis or problem codes justifying the reason for requesting the device.
DeviceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Linked Reason for request
DeviceRequest.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
DeviceRequest.supportingInfo 0..* Reference(Resource) Additional clinical information
DeviceRequest.note 0..* Annotation Notes or comments
DeviceRequest.relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

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.

Constraints

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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceRequest 0..* DeviceRequest Medical device request
DeviceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DeviceRequest.identifier This element must be supported. This element is included in summaries. 0..* Identifier External Request identifier
DeviceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes representing the status of the request.
DeviceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of diagnostic request.
DeviceRequest.code[x] This element must be supported. This element is included in summaries. 1..1 Device requested
Binding: FHIRDeviceTypes (preferred)
DeviceRequest.code[x].codeCodeableConcept CodeableConcept This type must be supported.
DeviceRequest.code[x].codeReference Reference(US Core Device Profile)
DeviceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(9.0.0) This type must be supported. | Group | US Core Location Profile | US Core Device Profile) Focus of request
DeviceRequest.authoredOn This element must be supported. This element is included in summaries. 0..1 dateTime When recorded
DeviceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core Organization Profile | US Core Device Profile) Who/what is requesting diagnostics

doco Documentation for this format

Terminology Bindings

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.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceRequest 0..* DeviceRequest Medical device request
DeviceRequest.identifier This element must be supported. 0..* Identifier External Request identifier
DeviceRequest.status This element must be supported. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
DeviceRequest.intent This element must be supported. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
DeviceRequest.code[x] This element must be supported. 1..1 Device requested
Binding: FHIRDeviceTypes (preferred)
DeviceRequest.code[x].codeCodeableConcept CodeableConcept This type must be supported.
DeviceRequest.code[x].codeReference Reference(US Core Device Profile)
DeviceRequest.subject This element must be supported. 1..1 Reference(US Core Patient Profile(9.0.0) This type must be supported. | Group | US Core Location Profile | US Core Device Profile) Focus of request
DeviceRequest.authoredOn This element must be supported. 0..1 dateTime When recorded
DeviceRequest.requester This element must be supported. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core Organization Profile | US Core Device Profile) Who/what is requesting diagnostics

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DeviceRequest.code[x] Base preferred FHIR Device Types 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DeviceRequest 0..* DeviceRequest Medical device request
DeviceRequest.id This element is included in summaries. 0..1 id Logical id of this artifact
DeviceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DeviceRequest.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DeviceRequest.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
DeviceRequest.text 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
DeviceRequest.contained 0..* Resource Contained, inline Resources
DeviceRequest.extension 0..* Extension Additional content defined by implementations
DeviceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DeviceRequest.identifier This element must be supported. This element is included in summaries. 0..* Identifier External Request identifier
DeviceRequest.instantiatesCanonical This element is included in summaries. 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
DeviceRequest.instantiatesUri This element is included in summaries. 0..* uri Instantiates external protocol or definition
DeviceRequest.basedOn This element is included in summaries. 0..* Reference(Resource) What request fulfills
DeviceRequest.priorRequest This element is included in summaries. 0..* Reference(Resource) What request replaces
DeviceRequest.groupIdentifier This element is included in summaries. 0..1 Identifier Identifier of composite request
DeviceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes representing the status of the request.
DeviceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of diagnostic request.
DeviceRequest.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
DeviceRequest.code[x] This element must be supported. This element is included in summaries. 1..1 Device requested
Binding: FHIRDeviceTypes (preferred)
DeviceRequest.code[x].codeCodeableConcept CodeableConcept This type must be supported.
DeviceRequest.code[x].codeReference Reference(US Core Device Profile)
DeviceRequest.parameter 0..* BackboneElement Device details
DeviceRequest.parameter.id 0..1 string Unique id for inter-element referencing
DeviceRequest.parameter.extension 0..* Extension Additional content defined by implementations
DeviceRequest.parameter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DeviceRequest.parameter.code 0..1 CodeableConcept Device detail
Binding Description: (example): A code that identifies the device detail.
DeviceRequest.parameter.value[x] 0..1 Value of detail
DeviceRequest.parameter.value[x].valueCodeableConcept CodeableConcept
DeviceRequest.parameter.value[x].valueQuantity Quantity
DeviceRequest.parameter.value[x].valueRange Range
DeviceRequest.parameter.value[x].valueBoolean boolean
DeviceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(9.0.0) This type must be supported. | Group | US Core Location Profile | US Core Device Profile) Focus of request
DeviceRequest.encounter This element is included in summaries. 0..1 Reference(Encounter) Encounter motivating request
DeviceRequest.occurrence[x] This element is included in summaries. 0..1 Desired time or schedule for use
DeviceRequest.occurrence[x].occurrenceDateTime dateTime
DeviceRequest.occurrence[x].occurrencePeriod Period
DeviceRequest.occurrence[x].occurrenceTiming Timing
DeviceRequest.authoredOn This element must be supported. This element is included in summaries. 0..1 dateTime When recorded
DeviceRequest.requester This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core Organization Profile | US Core Device Profile) Who/what is requesting diagnostics
DeviceRequest.performerType This element is included in summaries. 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.
DeviceRequest.performer This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested Filler
DeviceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Coded Reason for request
Binding: Condition/Problem/DiagnosisCodes (example): Diagnosis or problem codes justifying the reason for requesting the device.
DeviceRequest.reasonReference This element is included in summaries. 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Linked Reason for request
DeviceRequest.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
DeviceRequest.supportingInfo 0..* Reference(Resource) Additional clinical information
DeviceRequest.note 0..* Annotation Notes or comments
DeviceRequest.relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

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.

Constraints

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()

 

Other representations of profile: CSV, Excel, Schematron