Release 5 R6 Ballot (2nd Draft)

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

5.12.14 Resource Requirements - Search Parameters

FHIR Infrastructure icon Work Group Maturity Level : N/A   Trial Use Security Category : Anonymous Compartments : No defined compartments

Search parameters for the Resource Requirements - 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/Requirements-actor

Generated Narrative: SearchParameter Requirements-actor

5.12.15 actor

Parameter actor : reference

An actor these requirements are for

Resource Requirements
Expression Requirements.actor
Processing Mode Normal
Target Resources ActorDefinition
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/CanonicalResource-context
This search parameter is part of the common search parameter CanonicalResource-context

Generated Narrative: SearchParameter CanonicalResource-context

5.12.16 context

Parameter context : token

Requirements : A use context assigned to the requirements

Resource Requirements
Expression (Requirements.useContext.value.ofType(CodeableConcept))
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/CanonicalResource-context-quantity
This search parameter is part of the common search parameter CanonicalResource-context-quantity

Generated Narrative: SearchParameter CanonicalResource-context-quantity

5.12.17 context-quantity

Parameter context-quantity : quantity

Requirements : A quantity- or range-valued use context assigned to the requirements

Resource Requirements
Expression (Requirements.useContext.value.ofType(Quantity)) | (Requirements.useContext.value.ofType(Range))
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/CanonicalResource-context-type
This search parameter is part of the common search parameter CanonicalResource-context-type

Generated Narrative: SearchParameter CanonicalResource-context-type

5.12.18 context-type

Parameter context-type : token

Requirements : A type of use context assigned to the requirements

Resource Requirements
Expression Requirements.useContext.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/CanonicalResource-context-type-quantity
This search parameter is part of the common search parameter CanonicalResource-context-type-quantity

Generated Narrative: SearchParameter CanonicalResource-context-type-quantity

5.12.19 context-type-quantity

Parameter context-type-quantity : composite

Requirements : A use context type and quantity- or range-based value assigned to the requirements

Resource Requirements
Expression Requirements.useContext
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components Comparators

context-type code
context-quantity value.ofType(Quantity) | value.ofType(Range)
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-context-type-value
This search parameter is part of the common search parameter CanonicalResource-context-type-value

Generated Narrative: SearchParameter CanonicalResource-context-type-value

5.12.20 context-type-value

Parameter context-type-value : composite

Requirements : A use context type and value assigned to the requirements

Resource Requirements
Expression Requirements.useContext
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components Comparators

context-type code
context value.ofType(CodeableConcept)
 
http://hl7.org/fhir/SearchParameter/CanonicalResource-date
This search parameter is part of the common search parameter CanonicalResource-date

Generated Narrative: SearchParameter CanonicalResource-date

5.12.21 date

Parameter date : date

Requirements : The requirements publication date

Resource Requirements
Expression Requirements.date
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/Requirements-derived-from

Generated Narrative: SearchParameter Requirements-derived-from

5.12.22 derived-from

Parameter derived-from : reference

The requirements these are derived from

Resource Requirements
Expression Requirements.derivedFrom
Processing Mode Normal
Target Resources Requirements
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/CanonicalResource-description
This search parameter is part of the common search parameter CanonicalResource-description

Generated Narrative: SearchParameter CanonicalResource-description

5.12.23 description

Parameter description : string

Requirements : The description of the requirements

Resource Requirements
Expression Requirements.description
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/CanonicalResource-identifier
This search parameter is part of the common search parameter CanonicalResource-identifier

Generated Narrative: SearchParameter CanonicalResource-identifier

5.12.24 identifier

Parameter identifier : token

Requirements : External identifier for the requirements

Resource Requirements
Expression Requirements.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/CanonicalResource-jurisdiction
This search parameter is part of the common search parameter CanonicalResource-jurisdiction

Generated Narrative: SearchParameter CanonicalResource-jurisdiction

5.12.25 jurisdiction

Parameter jurisdiction : token

Requirements : Intended jurisdiction for the requirements

Resource Requirements
Expression Requirements.jurisdiction
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/CanonicalResource-name
This search parameter is part of the common search parameter CanonicalResource-name

Generated Narrative: SearchParameter CanonicalResource-name

5.12.26 name

Parameter name : string

Requirements : Computationally friendly name of the requirements

Resource Requirements
Expression Requirements.name
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/CanonicalResource-publisher
This search parameter is part of the common search parameter CanonicalResource-publisher

Generated Narrative: SearchParameter CanonicalResource-publisher

5.12.27 publisher

Parameter publisher : string

Requirements : Name of the publisher of the requirements

Resource Requirements
Expression Requirements.publisher
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/CanonicalResource-status
This search parameter is part of the common search parameter CanonicalResource-status

Generated Narrative: SearchParameter CanonicalResource-status

5.12.28 status

Parameter status : token

Requirements : The current status of the requirements

Resource Requirements
Expression Requirements.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/CanonicalResource-title
This search parameter is part of the common search parameter CanonicalResource-title

Generated Narrative: SearchParameter CanonicalResource-title

5.12.29 title

Parameter title : string

Requirements : The human-friendly name of the requirements

Resource Requirements
Expression Requirements.title
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/CanonicalResource-url
This search parameter is part of the common search parameter CanonicalResource-url

Generated Narrative: SearchParameter CanonicalResource-url

5.12.30 url

Parameter url : uri

Requirements : The uri that identifies the requirements

Resource Requirements
Expression Requirements.url
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/CanonicalResource-version
This search parameter is part of the common search parameter CanonicalResource-version

Generated Narrative: SearchParameter CanonicalResource-version

5.12.31 version

Parameter version : token

Requirements : The business version of the requirements

Resource Requirements
Expression Requirements.version
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