FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.20.12 Resource Substance - Search Parameters

Biomedical Research and Regulation icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Business Compartments: No defined compartments

Search parameters for the Substance 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/Substance-category

Generated Narrative: SearchParameter Substance-category

8.20.13 category

Parameter category:token

The category of the substance

ResourceSubstance
Expression Substance.category
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/Substance-code

Generated Narrative: SearchParameter Substance-code

8.20.14 code

Parameter code:token

The code of the substance or ingredient

ResourceSubstance
Expression Substance.code.concept | (Substance.ingredient.substance.ofType(CodeableConcept))
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/Substance-code-reference

Generated Narrative: SearchParameter Substance-code-reference

8.20.15 code-reference

Parameter code-reference:reference

A reference to the defining substance

ResourceSubstance
Expression Substance.code.reference
Processing Mode Normal
Target Resources SubstanceDefinition
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/Substance-expiry

Generated Narrative: SearchParameter Substance-expiry

8.20.16 expiry

Parameter expiry:date

Expiry date of package or container of substance

ResourceSubstance
Expression Substance.expiry
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/Substance-identifier

Generated Narrative: SearchParameter Substance-identifier

8.20.17 identifier

Parameter identifier:token

Unique identifier for the substance

ResourceSubstance
Expression Substance.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/Substance-quantity

Generated Narrative: SearchParameter Substance-quantity

8.20.18 quantity

Parameter quantity:quantity

Amount of substance in the package

ResourceSubstance
Expression Substance.quantity
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/Substance-status

Generated Narrative: SearchParameter Substance-status

8.20.19 status

Parameter status:token

active | inactive | entered-in-error

ResourceSubstance
Expression Substance.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/Substance-substance-reference

Generated Narrative: SearchParameter Substance-substance-reference

8.20.20 substance-reference

Parameter substance-reference:reference

A component of the substance

ResourceSubstance
Expression (Substance.ingredient.substance.ofType(Reference))
Processing Mode Normal
Target Resources Substance
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