R6 Ballot (3rd Draft) (1st Full Ballot)

This page is part of the FHIR Specification v6.0.0-ballot3: v6.0.0-ballot4: Release 6 Ballot (3rd Draft) (1st Full Ballot) (see Ballot Notes ). The current version is 5.0.0 . For a full list of available versions, see the Directory of published versions for published versions icon

Maturity Level : N/A
Responsible Owner: Orders and Observations icon Work Group   Trial Use Normative Security Category : Patient Compartments : Device , Encounter , Group , Patient , Practitioner , RelatedPerson

Search parameters for the DeviceRequest resource. Also check the Extensions registry for search parameters on extensions related to this resource.

The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.


http://hl7.org/fhir/SearchParameter/DeviceRequest-authored-on

Generated Narrative: SearchParameter DeviceRequest-authored-on

Parameter authored-on : date

When the request transitioned to being actionable

Resource DeviceRequest
Expression DeviceRequest.authoredOn
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-based-on

Generated Narrative: SearchParameter DeviceRequest-based-on

Parameter based-on : reference

Plan/proposal/order fulfilled by this request

Resource DeviceRequest
Expression DeviceRequest.basedOn
Processing Mode Normal
Target Resources Account , ActivityDefinition , ActorDefinition , AdministrableProductDefinition , AdverseEvent , AllergyIntolerance , Appointment , AppointmentResponse , ArtifactAssessment , AuditEvent , Basic , Binary , BiologicallyDerivedProduct , BiologicallyDerivedProductDispense , BodyStructure , Bundle , CapabilityStatement , CarePlan , CareTeam , ChargeItem , ChargeItemDefinition , Citation , Claim , ClaimResponse , ClinicalUseDefinition , CodeSystem , Communication , CommunicationRequest , CompartmentDefinition , Composition , ConceptMap , Condition , ConditionDefinition , Consent , Contract , Coverage , CoverageEligibilityRequest , CoverageEligibilityResponse , DetectedIssue , Device , DeviceAssociation , DeviceDefinition , DeviceDispense , DeviceMetric , DeviceRequest , DeviceUsage , DiagnosticReport , DocumentReference , Encounter , EncounterHistory , Endpoint , EnrollmentRequest , EnrollmentResponse , EpisodeOfCare , EventDefinition , Evidence , EvidenceVariable , ExampleScenario , ExplanationOfBenefit , FamilyMemberHistory , Flag , FormularyItem , GenomicStudy , Goal , GraphDefinition , Group , GuidanceResponse , HealthcareService , ImagingSelection , ImagingStudy , Immunization , ImmunizationEvaluation , ImmunizationRecommendation , ImplementationGuide , Ingredient , InsurancePlan , InventoryItem , InventoryReport , Invoice , Library , Linkage , List , Location , ManufacturedItemDefinition , Measure , MeasureReport , Medication , MedicationAdministration , MedicationDispense , MedicationKnowledge , MedicationRequest , MedicationStatement , MedicinalProductDefinition , MessageDefinition , MessageHeader , MolecularSequence , NamingSystem , NutritionIntake , NutritionOrder , NutritionProduct , Observation , ObservationDefinition , OperationDefinition , OperationOutcome , Organization , OrganizationAffiliation , PackagedProductDefinition , Parameters , Patient , PaymentNotice , PaymentReconciliation , Permission , Person , PlanDefinition , Practitioner , PractitionerRole , Procedure , Provenance , Questionnaire , QuestionnaireResponse , RegulatedAuthorization , RelatedPerson , RequestOrchestration , Requirements , ResearchStudy , ResearchSubject , RiskAssessment , Schedule , SearchParameter , ServiceRequest , Slot , Specimen , SpecimenDefinition , StructureDefinition , StructureMap , Subscription , SubscriptionStatus , SubscriptionTopic , Substance , SubstanceDefinition , SubstanceNucleicAcid , SubstancePolymer , SubstanceProtein , SubstanceReferenceInformation , SubstanceSourceMaterial , SupplyDelivery , SupplyRequest , Task , TerminologyCapabilities , TestPlan , TestReport , TestScript , Transport , ValueSet , VerificationResult , VisionPrescription Multiples multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true   http://hl7.org/fhir/SearchParameter/clinical-code This search parameter is part of the common search parameter clinical-code Generated Narrative: SearchParameter clinical-code 12.24.16 code Parameter code : token DeviceRequest : Code for what is being requested/ordered Resource DeviceRequest All Resources
Expression DeviceRequest.code.concept Processing Mode Normal Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-device

Generated Narrative: SearchParameter DeviceRequest-device

Parameter device : reference

Reference to resource that is being requested/ordered

Resource DeviceRequest
Expression DeviceRequest.code.reference DeviceRequest.product.ofType(Reference)
Processing Mode Normal
Target Resources Device , DeviceDefinition
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-encounter
This search parameter is part of the common search parameter clinical-encounter

Generated Narrative: SearchParameter clinical-encounter

Parameter encounter : reference

DeviceRequest : Encounter during which request was created

Resource DeviceRequest
Expression DeviceRequest.encounter
Processing Mode Normal
Target Resources Encounter
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-event-date

Generated Narrative: SearchParameter DeviceRequest-event-date

Parameter event-date : date

When service should occur

Resource DeviceRequest
Expression (DeviceRequest.occurrence.ofType(dateTime)) | (DeviceRequest.occurrence.ofType(Period))
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-group-identifier

Generated Narrative: SearchParameter DeviceRequest-group-identifier

Parameter group-identifier : token

Composite request this is part of

Resource DeviceRequest
Expression DeviceRequest.groupIdentifier
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

Generated Narrative: SearchParameter clinical-identifier

Parameter identifier : token

DeviceRequest : Business identifier for request/order

Resource DeviceRequest
Expression DeviceRequest.identifier
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-instantiates-canonical http://hl7.org/fhir/SearchParameter/DeviceRequest-insurance

Generated Narrative: SearchParameter DeviceRequest-instantiates-canonical DeviceRequest-insurance

Parameter instantiates-canonical insurance : reference

Instantiates FHIR protocol or definition Associated insurance coverage

Resource DeviceRequest
Expression DeviceRequest.instantiatesCanonical DeviceRequest.insurance
Processing Mode Normal
Target Resources ActivityDefinition ClaimResponse , PlanDefinition Coverage
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-instantiates-uri http://hl7.org/fhir/SearchParameter/DeviceRequest-intent

Generated Narrative: SearchParameter DeviceRequest-instantiates-uri DeviceRequest-intent

Parameter instantiates-uri intent : uri token

Instantiates external protocol or definition proposal | plan | original-order |reflex-order

Resource DeviceRequest
Expression DeviceRequest.instantiatesUri DeviceRequest.intent
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-insurance http://hl7.org/fhir/SearchParameter/DeviceRequest-location-code

Generated Narrative: SearchParameter DeviceRequest-insurance DeviceRequest-location-code

Parameter insurance location-code : reference token

Associated insurance coverage The preferred location specified in the DeviceRequest (coded)

Resource DeviceRequest
Expression DeviceRequest.insurance DeviceRequest.location.concept
Processing Mode Normal
Target Resources ClaimResponse , Coverage Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-intent http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

Generated Narrative: SearchParameter DeviceRequest-intent clinical-patient

Parameter intent patient : token reference

proposal | plan | original-order |reflex-order DeviceRequest : Individual the service is ordered for

Resource DeviceRequest
Expression DeviceRequest.intent DeviceRequest.subject.where(resolve() is Patient)
Processing Mode Normal
Target Resources Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-patient http://hl7.org/fhir/SearchParameter/DeviceRequest-performer This search parameter is part of the common search parameter clinical-patient

Generated Narrative: SearchParameter clinical-patient DeviceRequest-performer

Parameter patient performer : reference

DeviceRequest : Individual the service is ordered Desired performer for service

Resource DeviceRequest
Expression DeviceRequest.subject.where(resolve() is Patient) DeviceRequest.performer.reference
Processing Mode Normal
Target Resources HealthcareService , Organization , CareTeam , Device , RelatedPerson , PractitionerRole , Practitioner , Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-performer http://hl7.org/fhir/SearchParameter/DeviceRequest-performer-code

Generated Narrative: SearchParameter DeviceRequest-performer DeviceRequest-performer-code

Parameter performer performer-code : reference token

Desired performer for service

Resource DeviceRequest
Expression DeviceRequest.performer.reference DeviceRequest.performer.concept
Processing Mode Normal
Target Resources HealthcareService , Organization , CareTeam , Device , RelatedPerson , PractitionerRole , Practitioner , Patient Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-performer-code http://hl7.org/fhir/SearchParameter/DeviceRequest-prior-request

Generated Narrative: SearchParameter DeviceRequest-performer-code DeviceRequest-prior-request

Parameter performer-code prior-request : token reference

Desired performer for service Request takes the place of referenced completed or terminated requests

Resource DeviceRequest
Expression DeviceRequest.performer.concept DeviceRequest.replaces
Processing Mode Normal
Target Resources DeviceRequest
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-prior-request http://hl7.org/fhir/SearchParameter/DeviceRequest-product

Generated Narrative: SearchParameter DeviceRequest-prior-request DeviceRequest-product

Parameter prior-request product : reference token

Request takes the place of referenced completed or terminated requests Code for what is being requested/ordered

Resource DeviceRequest
Expression DeviceRequest.replaces DeviceRequest.product.ofType(CodeableConcept)
Processing Mode Normal
Target Resources DeviceRequest Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-requester

Generated Narrative: SearchParameter DeviceRequest-requester

Parameter requester : reference

Who/what is requesting service

Resource DeviceRequest
Expression DeviceRequest.requester
Processing Mode Normal
Target Resources Device , Organization , CareTeam , RelatedPerson , PractitionerRole , Practitioner , Group , Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-status

Generated Narrative: SearchParameter DeviceRequest-status

Parameter status : token

entered-in-error | draft | active |suspended | completed

Resource DeviceRequest
Expression DeviceRequest.status
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/DeviceRequest-subject

Generated Narrative: SearchParameter DeviceRequest-subject

Parameter subject : reference

Individual the service is ordered for

Resource DeviceRequest
Expression DeviceRequest.subject
Processing Mode Normal
Target Resources Device , Group , Location , Patient
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true