Release 5 R6 Ballot (1st Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions

9.3.14 Resource Procedure - Search Parameters

Patient Care icon Work Group Maturity Level : N/A   Trial Use Security Category : Patient Compartments : Encounter , Patient , Practitioner , RelatedPerson

Search parameters for the Resource Procedure - Search Parameters 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/Procedure-based-on

9.3.15 based-on

Parameter based-on : reference

A request for this procedure

Resource Procedure
Expression Procedure.basedOn
Processing Mode Normal
Target Resources ServiceRequest , CarePlan , MedicationRequest
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Procedure-category

9.3.16 category

Parameter category : token

Classification of the procedure

Resource Procedure
Expression Procedure.category
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.3.17 code

Parameter code : token

Procedure : A code to identify a procedure

Resource Procedure
Expression Procedure.code
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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-date
This search parameter is part of the common search parameter clinical-date

9.3.18 date

Parameter date : date

Procedure : When the procedure occurred or is occurring

Resource Procedure
Expression Procedure.occurrence.ofType(dateTime) | Procedure.occurrence.ofType(Period) | Procedure.occurrence.ofType(Timing)
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/clinical-encounter
This search parameter is part of the common search parameter clinical-encounter

9.3.19 encounter

Parameter encounter : reference

Procedure : The Encounter during which this Procedure was created

Resource Procedure
Expression Procedure.encounter
Processing Mode Normal
Target Resources Encounter
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

9.3.20 identifier

Parameter identifier : token

Procedure : A unique identifier for a procedure

Resource Procedure
Expression Procedure.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Procedure-instantiates-canonical

9.3.21 instantiates-canonical

Parameter instantiates-canonical : reference

Instantiates FHIR protocol or definition

Resource Procedure
Expression Procedure.instantiatesCanonical
Processing Mode Normal
Target Resources Measure , OperationDefinition , ActivityDefinition , PlanDefinition , Questionnaire
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Procedure-instantiates-uri

9.3.22 instantiates-uri

Parameter instantiates-uri : uri

Instantiates external protocol or definition

Resource Procedure
Expression Procedure.instantiatesUri
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Procedure-location

9.3.23 location

Parameter location : reference

Where the procedure happened

Resource Procedure
Expression Procedure.location
Processing Mode Normal
Target Resources Location
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Procedure-part-of

9.3.24 part-of

Parameter part-of : reference

Part of referenced event

Resource Procedure
Expression Procedure.partOf
Processing Mode Normal
Target Resources Procedure , Observation , MedicationAdministration
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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
This search parameter is part of the common search parameter clinical-patient

9.3.25 patient

Parameter patient : reference

Procedure : Search by subject - a patient

Resource Procedure
Expression Procedure.subject.where(resolve() is Patient)
Processing Mode Normal
Target Resources Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Procedure-performer

9.3.26 performer

Parameter performer : reference

Who performed the procedure

Resource Procedure
Expression Procedure.performer.actor
Processing Mode Normal
Target Resources HealthcareService , Organization , Device , CareTeam , RelatedPerson , PractitionerRole , Practitioner , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Procedure-reason-code

9.3.27 reason-code

Parameter reason-code : token

Reference to a concept (by class)

Resource Procedure
Expression Procedure.reason.concept
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Procedure-reason-reference

9.3.28 reason-reference

Parameter reason-reference : reference

Reference to a resource (by instance)

Resource Procedure
Expression Procedure.reason.reference
Processing Mode Normal
Target Resources Procedure , DocumentReference , Observation , DiagnosticReport , Condition
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Procedure-report

9.3.29 report

Parameter report : reference

Any report resulting from the procedure

Resource Procedure
Expression Procedure.report
Processing Mode Normal
Target Resources Composition , DocumentReference , DiagnosticReport
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Procedure-status

9.3.30 status

Parameter status : token

preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown

Resource Procedure
Expression Procedure.status
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/Procedure-subject

9.3.31 subject

Parameter subject : reference

Search by subject

Resource Procedure
Expression Procedure.subject
Processing Mode Normal
Target Resources Device , Organization , Group , Practitioner , Location , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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