This page is part of the Post Acute Orders FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Post Acute Orders DeviceRequest Profile
Use to order DME and assoicated supplies
The official URL for this profile is:
http://hl7.org/fhir/us/dme-orders/StructureDefinition/PAO-devicerequest4
This section will be expanded in the STU 1 version
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DeviceRequest
Summary
Mandatory: 4 elements
Must-Support: 21 elements
Structures
This structure refers to these other structures:
This structure is derived from DeviceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceRequest | 0..* | DeviceRequest | Medical device request | |
identifier | S | 1..* | Identifier | External Request identifier |
basedOn | S | 0..* | Reference(Resource) | What request fulfills |
priorRequest | S | 0..* | Reference(PAO DeviceRequest Profile) | What request replaces |
status | S | 0..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
priority | S | 0..1 | code | routine | urgent | asap | stat |
code[x] | S | 1..1 | Reference(Device), CodeableConcept | Device requested |
parameter | S | 0..* | BackboneElement | Device details |
code | S | 0..1 | CodeableConcept | Device detail |
value[x] | S | 0..1 | CodeableConcept, Quantity, Range, boolean | Value of detail |
subject | S | 1..1 | Reference(US Core Patient Profile) | Focus of request |
encounter | S | 0..1 | Reference(Encounter) | Encounter motivating request |
occurrence[x] | S | 0..1 | dateTime, Period, Timing | Desired time or schedule for use |
authoredOn | S | 1..1 | dateTime | When recorded |
requester | S | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting diagnostics |
reasonCode | S | 0..* | CodeableConcept | Coded Reason for request |
reasonReference | S | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Linked Reason for request |
insurance | S | 0..* | Reference(PAO Coverage) | include reference to PA response when available |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
note | S | 0..* | Annotation | Notes or comments |
relevantHistory | S | 1..* | Reference(PAO Provenance Profile 4b) | Request provenance |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceRequest | I | 0..* | DeviceRequest | Medical device request |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣI | 1..* | Identifier | External Request identifier |
instantiatesCanonical | ΣI | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | ΣI | 0..* | uri | Instantiates external protocol or definition |
basedOn | SΣI | 0..* | Reference(Resource) | What request fulfills |
priorRequest | SΣI | 0..* | Reference(PAO DeviceRequest Profile) | What request replaces |
groupIdentifier | ΣI | 0..1 | Identifier | Identifier of composite request |
status | ?!SΣI | 0..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required) |
intent | ?!SΣI | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required) |
priority | SΣI | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code[x] | SΣI | 1..1 | Device requested Binding: FHIRDeviceTypes (example) | |
codeReference | Reference(Device) | |||
codeCodeableConcept | CodeableConcept | |||
parameter | SI | 0..* | BackboneElement | Device details |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SI | 0..1 | CodeableConcept | Device detail Binding: (unbound) (example) |
value[x] | SI | 0..1 | Value of detail | |
valueCodeableConcept | CodeableConcept | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueBoolean | boolean | |||
subject | SΣI | 1..1 | Reference(US Core Patient Profile) | Focus of request |
encounter | SΣI | 0..1 | Reference(Encounter) | Encounter motivating request |
occurrence[x] | SΣI | 0..1 | Desired time or schedule for use | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
authoredOn | SΣI | 1..1 | dateTime | When recorded |
requester | SΣI | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting diagnostics |
performerType | ΣI | 0..1 | CodeableConcept | Filler role Binding: ParticipantRoles (example) |
performer | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested Filler |
reasonCode | SΣI | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (example) |
reasonReference | SΣI | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Linked Reason for request |
insurance | SI | 0..* | Reference(PAO Coverage) | include reference to PA response when available |
supportingInfo | SI | 0..* | Reference(Resource) | Additional clinical information |
note | SI | 0..* | Annotation | Notes or comments |
relevantHistory | SI | 1..* | Reference(PAO Provenance Profile 4b) | Request provenance |
Documentation for this format |
This structure is derived from DeviceRequest
Summary
Mandatory: 4 elements
Must-Support: 21 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from DeviceRequest
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceRequest | 0..* | DeviceRequest | Medical device request | |
identifier | S | 1..* | Identifier | External Request identifier |
basedOn | S | 0..* | Reference(Resource) | What request fulfills |
priorRequest | S | 0..* | Reference(PAO DeviceRequest Profile) | What request replaces |
status | S | 0..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
priority | S | 0..1 | code | routine | urgent | asap | stat |
code[x] | S | 1..1 | Reference(Device), CodeableConcept | Device requested |
parameter | S | 0..* | BackboneElement | Device details |
code | S | 0..1 | CodeableConcept | Device detail |
value[x] | S | 0..1 | CodeableConcept, Quantity, Range, boolean | Value of detail |
subject | S | 1..1 | Reference(US Core Patient Profile) | Focus of request |
encounter | S | 0..1 | Reference(Encounter) | Encounter motivating request |
occurrence[x] | S | 0..1 | dateTime, Period, Timing | Desired time or schedule for use |
authoredOn | S | 1..1 | dateTime | When recorded |
requester | S | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting diagnostics |
reasonCode | S | 0..* | CodeableConcept | Coded Reason for request |
reasonReference | S | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Linked Reason for request |
insurance | S | 0..* | Reference(PAO Coverage) | include reference to PA response when available |
supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
note | S | 0..* | Annotation | Notes or comments |
relevantHistory | S | 1..* | Reference(PAO Provenance Profile 4b) | Request provenance |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DeviceRequest | I | 0..* | DeviceRequest | Medical device request |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣI | 1..* | Identifier | External Request identifier |
instantiatesCanonical | ΣI | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition |
instantiatesUri | ΣI | 0..* | uri | Instantiates external protocol or definition |
basedOn | SΣI | 0..* | Reference(Resource) | What request fulfills |
priorRequest | SΣI | 0..* | Reference(PAO DeviceRequest Profile) | What request replaces |
groupIdentifier | ΣI | 0..1 | Identifier | Identifier of composite request |
status | ?!SΣI | 0..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required) |
intent | ?!SΣI | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required) |
priority | SΣI | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code[x] | SΣI | 1..1 | Device requested Binding: FHIRDeviceTypes (example) | |
codeReference | Reference(Device) | |||
codeCodeableConcept | CodeableConcept | |||
parameter | SI | 0..* | BackboneElement | Device details |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SI | 0..1 | CodeableConcept | Device detail Binding: (unbound) (example) |
value[x] | SI | 0..1 | Value of detail | |
valueCodeableConcept | CodeableConcept | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueBoolean | boolean | |||
subject | SΣI | 1..1 | Reference(US Core Patient Profile) | Focus of request |
encounter | SΣI | 0..1 | Reference(Encounter) | Encounter motivating request |
occurrence[x] | SΣI | 0..1 | Desired time or schedule for use | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
authoredOn | SΣI | 1..1 | dateTime | When recorded |
requester | SΣI | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting diagnostics |
performerType | ΣI | 0..1 | CodeableConcept | Filler role Binding: ParticipantRoles (example) |
performer | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested Filler |
reasonCode | SΣI | 0..* | CodeableConcept | Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (example) |
reasonReference | SΣI | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Linked Reason for request |
insurance | SI | 0..* | Reference(PAO Coverage) | include reference to PA response when available |
supportingInfo | SI | 0..* | Reference(Resource) | Additional clinical information |
note | SI | 0..* | Annotation | Notes or comments |
relevantHistory | SI | 1..* | Reference(PAO Provenance Profile 4b) | Request provenance |
Documentation for this format |
Other representations of profile: Schematron
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-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-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-5 | DeviceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | DeviceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | DeviceRequest.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
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.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceRequest.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceRequest.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.instantiatesCanonical | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.instantiatesUri | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.priorRequest | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.groupIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.intent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.code[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.parameter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.parameter.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceRequest.parameter.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceRequest.parameter.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DeviceRequest.parameter.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DeviceRequest.parameter.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.parameter.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.occurrence[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.authoredOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.requester | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.performerType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.insurance | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.supportingInfo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DeviceRequest.relevantHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This section will be expanded in the STU 1 version