FHIR Orders Exchange (FOE) / Post-Acute Orders (PAO) / (DME-Orders), published by HL7. This is not an authorized publication; it is the continuous build for version 0.2.2). This version is based on the current content of https://github.com/HL7/dme-orders/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: PAO DeviceRequest Profile

PAO DeviceRequest Resource Profile

Purpose

Usage:

• Refer to this Resource Profile: PAO MessageHeader, PAO Provenance and PAO Task
• Examples for this Resource Profile: DeviceRequest/HomeO2 and DeviceRequest/insulinpump

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from DeviceRequest

Name	Flags	Card.	Type	Description & Constraints
DeviceRequest		0..*	DeviceRequest	Medical device request
intent		1..1	code	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order
encounter	S	0..1	Reference(US Core Encounter Profile)	Encounter motivating request
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
DeviceRequest		0..*	DeviceRequest	Medical device request
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	0..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (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 Binding: RequestIntent (required): The kind of diagnostic request. Fixed Value: order
code[x]	Σ	1..1		Device requested Binding: FHIRDeviceTypes (example): Codes for devices that can be requested.
codeReference			Reference(Device)
codeCodeableConcept			CodeableConcept
subject	Σ	1..1	Reference(Patient | Group | Location | Device)	Focus of request
encounter	SΣ	0..1	Reference(US Core Encounter Profile)	Encounter motivating request
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
DeviceRequest.status	required	RequestStatus
DeviceRequest.intent	required	Fixed Value: order
DeviceRequest.code[x]	example	FHIRDeviceTypes

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Name	Flags	Card.	Type	Description & Constraints
DeviceRequest		0..*	DeviceRequest	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): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Request identifier
instantiatesCanonical	Σ	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	?!Σ	0..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (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 Binding: RequestIntent (required): The kind of diagnostic request. Fixed Value: order
priority	Σ	0..1	code	routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code[x]	Σ	1..1		Device requested Binding: FHIRDeviceTypes (example): Codes for devices that can be requested.
codeReference			Reference(Device)
codeCodeableConcept			CodeableConcept
parameter		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): A code that identifies the device detail.
value[x]		0..1		Value of detail
valueCodeableConcept			CodeableConcept
valueQuantity			Quantity
valueRange			Range
valueBoolean			boolean
subject	Σ	1..1	Reference(Patient | Group | Location | Device)	Focus of request
encounter	SΣ	0..1	Reference(US Core Encounter Profile)	Encounter motivating request
occurrence[x]	Σ	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): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
performer	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)	Requested Filler
reasonCode	Σ	0..*	CodeableConcept	Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (example): Diagnosis or problem codes justifying the reason for requesting the device.
reasonReference	Σ	0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Linked Reason for request
insurance		0..*	Reference(Coverage | ClaimResponse)	Associated insurance coverage
supportingInfo		0..*	Reference(Resource)	Additional clinical information
note		0..*	Annotation	Notes or comments
relevantHistory		0..*	Reference(Provenance)	Request provenance
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
DeviceRequest.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
DeviceRequest.status	required	RequestStatus
DeviceRequest.intent	required	Fixed Value: order
DeviceRequest.priority	required	RequestPriority
DeviceRequest.code[x]	example	FHIRDeviceTypes
DeviceRequest.parameter.code	example
DeviceRequest.performerType	example	ParticipantRoles
DeviceRequest.reasonCode	example	Condition/Problem/DiagnosisCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Must-Support: 1 element
Fixed Value: 1 element

Structures

This structure refers to these other structures:

• US Core Encounter Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter)

Differential View

This structure is derived from DeviceRequest

Name	Flags	Card.	Type	Description & Constraints
DeviceRequest		0..*	DeviceRequest	Medical device request
intent		1..1	code	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order
encounter	S	0..1	Reference(US Core Encounter Profile)	Encounter motivating request
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
DeviceRequest		0..*	DeviceRequest	Medical device request
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	0..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (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 Binding: RequestIntent (required): The kind of diagnostic request. Fixed Value: order
code[x]	Σ	1..1		Device requested Binding: FHIRDeviceTypes (example): Codes for devices that can be requested.
codeReference			Reference(Device)
codeCodeableConcept			CodeableConcept
subject	Σ	1..1	Reference(Patient | Group | Location | Device)	Focus of request
encounter	SΣ	0..1	Reference(US Core Encounter Profile)	Encounter motivating request
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
DeviceRequest.status	required	RequestStatus
DeviceRequest.intent	required	Fixed Value: order
DeviceRequest.code[x]	example	FHIRDeviceTypes

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
DeviceRequest		0..*	DeviceRequest	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): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Request identifier
instantiatesCanonical	Σ	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	?!Σ	0..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (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 Binding: RequestIntent (required): The kind of diagnostic request. Fixed Value: order
priority	Σ	0..1	code	routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code[x]	Σ	1..1		Device requested Binding: FHIRDeviceTypes (example): Codes for devices that can be requested.
codeReference			Reference(Device)
codeCodeableConcept			CodeableConcept
parameter		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): A code that identifies the device detail.
value[x]		0..1		Value of detail
valueCodeableConcept			CodeableConcept
valueQuantity			Quantity
valueRange			Range
valueBoolean			boolean
subject	Σ	1..1	Reference(Patient | Group | Location | Device)	Focus of request
encounter	SΣ	0..1	Reference(US Core Encounter Profile)	Encounter motivating request
occurrence[x]	Σ	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): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
performer	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)	Requested Filler
reasonCode	Σ	0..*	CodeableConcept	Coded Reason for request Binding: Condition/Problem/DiagnosisCodes (example): Diagnosis or problem codes justifying the reason for requesting the device.
reasonReference	Σ	0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Linked Reason for request
insurance		0..*	Reference(Coverage | ClaimResponse)	Associated insurance coverage
supportingInfo		0..*	Reference(Resource)	Additional clinical information
note		0..*	Annotation	Notes or comments
relevantHistory		0..*	Reference(Provenance)	Request provenance
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
DeviceRequest.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
DeviceRequest.status	required	RequestStatus
DeviceRequest.intent	required	Fixed Value: order
DeviceRequest.priority	required	RequestPriority
DeviceRequest.code[x]	example	FHIRDeviceTypes
DeviceRequest.parameter.code	example
DeviceRequest.performerType	example	ParticipantRoles
DeviceRequest.reasonCode	example	Condition/Problem/DiagnosisCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Must-Support: 1 element
Fixed Value: 1 element

Structures

This structure refers to these other structures:

• US Core Encounter Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter)

Other representations of profile: CSV, Excel, Schematron

Notes: