R6 Ballot (1st Draft)

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

8.19.13 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 Resource Substance - 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/Substance-category

8.19.14 category

Parameter category:token

The category of the substance

ResourceSubstance
ExpressionSubstance.category
Processing ModeNormal
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

8.19.15 code

Parameter code:token

The code of the substance or ingredient

ResourceSubstance
ExpressionSubstance.code.concept | (Substance.ingredient.substance.ofType(CodeableConcept))
Processing ModeNormal
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

8.19.16 code-reference

Parameter code-reference:reference

A reference to the defining substance

ResourceSubstance
ExpressionSubstance.code.reference
Processing ModeNormal
Target ResourcesSubstanceDefinition
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

8.19.17 expiry

Parameter expiry:date

Expiry date of package or container of substance

ResourceSubstance
ExpressionSubstance.expiry
Processing ModeNormal
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
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Substance-identifier

8.19.18 identifier

Parameter identifier:token

Unique identifier for the substance

ResourceSubstance
ExpressionSubstance.identifier
Processing ModeNormal
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

8.19.19 quantity

Parameter quantity:quantity

Amount of substance in the package

ResourceSubstance
ExpressionSubstance.quantity
Processing ModeNormal
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
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Substance-status

8.19.20 status

Parameter status:token

active | inactive | entered-in-error

ResourceSubstance
ExpressionSubstance.status
Processing ModeNormal
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

8.19.21 substance-reference

Parameter substance-reference:reference

A component of the substance

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