Release 5 R6 Ballot (3rd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot3: Release 6 Ballot (3rd 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

11.5.13 11.5.12 Resource Medication - Search Parameters

Pharmacy icon Work Group Maturity Level : N/A   Trial Use Security Category : Business Compartments : No defined compartments

Search parameters for the Resource Medication - 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/clinical-code
This search parameter is part of the common search parameter clinical-code

11.5.14 Generated Narrative: SearchParameter clinical-code

11.5.13 code

Parameter code : token

Medication : Returns medications for a specific code

Resource Medication
Expression Medication.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/Medication-expiration-date

11.5.15 Generated Narrative: SearchParameter Medication-expiration-date

11.5.14 expiration-date

Parameter expiration-date : date

Returns medications in a batch with this expiration date

Resource Medication
Expression Medication.batch.expirationDate
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/Medication-form

11.5.16 Generated Narrative: SearchParameter Medication-form

11.5.15 form

Parameter form : token

Returns medications for a specific dose form

Resource Medication
Expression (none) Medication.doseForm
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-identifier
This search parameter is part of the common search parameter clinical-identifier

11.5.17 Generated Narrative: SearchParameter clinical-identifier

11.5.16 identifier

Parameter identifier : token

Medication : Returns medications with this external identifier

Resource Medication
Expression Medication.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/Medication-ingredient

11.5.18 Generated Narrative: SearchParameter Medication-ingredient

11.5.17 ingredient

Parameter ingredient : reference

Returns medications for this ingredient reference

Resource Medication
Expression Medication.ingredient.item.reference
Processing Mode Normal
Target Resources Substance , Medication
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/Medication-ingredient-code

11.5.19 Generated Narrative: SearchParameter Medication-ingredient-code

11.5.18 ingredient-code

Parameter ingredient-code : token

Returns medications for this ingredient code

Resource Medication
Expression Medication.ingredient.item.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/Medication-lot-number

11.5.20 Generated Narrative: SearchParameter Medication-lot-number

11.5.19 lot-number

Parameter lot-number : token

Returns medications in a batch with this lot number

Resource Medication
Expression Medication.batch.lotNumber
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/Medication-marketingauthorizationholder

11.5.21 Generated Narrative: SearchParameter Medication-marketingauthorizationholder

11.5.20 marketingauthorizationholder

Parameter marketingauthorizationholder : reference

Returns medications made or sold for this marketing authorization holder

Resource Medication
Expression Medication.marketingAuthorizationHolder
Processing Mode Normal
Target Resources Organization
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/Medication-serial-number

11.5.22 Generated Narrative: SearchParameter Medication-serial-number

11.5.21 serial-number

Parameter serial-number : token

Returns medications in a batch with this lot number

Resource Medication
Expression Medication.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/Medication-status

11.5.23 Generated Narrative: SearchParameter Medication-status

11.5.22 status

Parameter status : token

Returns medications for this status

Resource Medication
Expression Medication.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