This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-devicerequest
Profile of DeviceRequest for use with CPG Implementation Guide
This profile builds on DeviceRequest.
This profile was published on Thu Jun 06 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CDS WG.
Description of Profiles, Differentials, and Snapshots.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceRequest | 0..* | |||
cqf-strengthOfRecommendation | S | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | S | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
identifier | S | 1..* | Identifier | |
instantiatesCanonical | S | 0..* | canonical(ActivityDefinition | PlanDefinition) | |
status | S | 0..1 | code | |
intent | S | 1..1 | code | |
priority | S | 0..1 | code | |
code[x] | S | 1..1 | Reference(Device), CodeableConcept | |
subject | S | 1..1 | Reference(Patient | Group | Location | Device) | |
encounter | S | 0..1 | Reference(Encounter) | |
occurrence[x] | S | 0..1 | dateTime, Period, Timing | |
reasonCode | S | 0..* | CodeableConcept | |
reasonReference | S | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | |
supportingInfo | S | 0..* | Reference(Resource) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceRequest | I | 0..* | Medical device request | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cqf-strengthOfRecommendation | SI | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | SI | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | External Request identifier |
instantiatesCanonical | SΣ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
basedOn | Σ | 0..* | Reference(Resource) | What request fulfills |
priorRequest | Σ | 0..* | Reference(Resource) | What request replaces |
groupIdentifier | Σ | 0..1 | Identifier | Identifier of composite request |
status | ?!SΣ | 0..1 | code | draft | active | suspended | completed | entered-in-error | cancelled Binding: RequestStatus (required) |
intent | ?!SΣ | 1..1 | code | proposal | plan | original-order | encoded | reflex-order Binding: RequestIntent (required) |
priority | SΣ | 0..1 | code | Indicates how quickly the should be addressed with respect to other requests Binding: RequestPriority (required) |
code[x] | SΣ | 1..1 | Device requested Binding: FHIRDeviceTypes (example) | |
codeReference | Reference(http://hl7.org/fhir/R4/device.html) | |||
codeCodeableConcept | CodeableConcept | |||
parameter | I | 0..* | BackboneElement | Device details |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 0..1 | CodeableConcept | Device detail Binding: (unbound) (example) | |
value[x] | 0..1 | Value of detail | ||
valueCodeableConcept | CodeableConcept | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueBoolean | boolean | |||
subject | SΣ | 1..1 | Reference(Patient | Group | Location | Device) | Focus of request |
encounter | SΣ | 0..1 | Reference(Encounter) | Encounter motivating request |
occurrence[x] | SΣ | 0..1 | Desired time or schedule for use | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
authoredOn | Σ | 0..1 | dateTime | When recorded |
requester | Σ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Organization) | Who/what is requesting diagnostics |
performerType | Σ | 0..1 | CodeableConcept | Filler role Binding: ParticipantRoles (example) |
performer | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested Filler |
reasonCode | SΣ | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (example) |
reasonReference | SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Linked Reason for request |
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
note | 0..* | Annotation | Notes or comments | |
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
Documentation for this format |
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceRequest | 0..* | |||
cqf-strengthOfRecommendation | S | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | S | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
identifier | S | 1..* | Identifier | |
instantiatesCanonical | S | 0..* | canonical(ActivityDefinition | PlanDefinition) | |
status | S | 0..1 | code | |
intent | S | 1..1 | code | |
priority | S | 0..1 | code | |
code[x] | S | 1..1 | Reference(Device), CodeableConcept | |
subject | S | 1..1 | Reference(Patient | Group | Location | Device) | |
encounter | S | 0..1 | Reference(Encounter) | |
occurrence[x] | S | 0..1 | dateTime, Period, Timing | |
reasonCode | S | 0..* | CodeableConcept | |
reasonReference | S | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | |
supportingInfo | S | 0..* | Reference(Resource) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceRequest | I | 0..* | Medical device request | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
cqf-strengthOfRecommendation | SI | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | SI | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | External Request identifier |
instantiatesCanonical | SΣ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition |
basedOn | Σ | 0..* | Reference(Resource) | What request fulfills |
priorRequest | Σ | 0..* | Reference(Resource) | What request replaces |
groupIdentifier | Σ | 0..1 | Identifier | Identifier of composite request |
status | ?!SΣ | 0..1 | code | draft | active | suspended | completed | entered-in-error | cancelled Binding: RequestStatus (required) |
intent | ?!SΣ | 1..1 | code | proposal | plan | original-order | encoded | reflex-order Binding: RequestIntent (required) |
priority | SΣ | 0..1 | code | Indicates how quickly the should be addressed with respect to other requests Binding: RequestPriority (required) |
code[x] | SΣ | 1..1 | Device requested Binding: FHIRDeviceTypes (example) | |
codeReference | Reference(http://hl7.org/fhir/R4/device.html) | |||
codeCodeableConcept | CodeableConcept | |||
parameter | I | 0..* | BackboneElement | Device details |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 0..1 | CodeableConcept | Device detail Binding: (unbound) (example) | |
value[x] | 0..1 | Value of detail | ||
valueCodeableConcept | CodeableConcept | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueBoolean | boolean | |||
subject | SΣ | 1..1 | Reference(Patient | Group | Location | Device) | Focus of request |
encounter | SΣ | 0..1 | Reference(Encounter) | Encounter motivating request |
occurrence[x] | SΣ | 0..1 | Desired time or schedule for use | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
authoredOn | Σ | 0..1 | dateTime | When recorded |
requester | Σ | 0..1 | Reference(Device | Practitioner | PractitionerRole | Organization) | Who/what is requesting diagnostics |
performerType | Σ | 0..1 | CodeableConcept | Filler role Binding: ParticipantRoles (example) |
performer | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested Filler |
reasonCode | SΣ | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (example) |
reasonReference | SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Linked Reason for request |
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
note | 0..* | Annotation | Notes or comments | |
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
Documentation for this format |
Path | Conformance | ValueSet |
DeviceRequest.language | preferred | CommonLanguages Max Binding: AllLanguages |
DeviceRequest.status | required | RequestStatus |
DeviceRequest.intent | required | RequestIntent |
DeviceRequest.priority | required | RequestPriority |
DeviceRequest.code[x] | example | FHIRDeviceTypes |
DeviceRequest.parameter.code | example | |
DeviceRequest.performerType | example | ParticipantRoles |
DeviceRequest.reasonCode | example | Condition/Problem/DiagnosisCodes |
Id | Path | Details | Requirements |
dom-2 | DeviceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-4 | 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-3 | 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-6 | DeviceRequest | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
ele-1 | DeviceRequest.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceRequest.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceRequest.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceRequest.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceRequest.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceRequest.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceRequest.parameter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |