Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions icon

14.15.15 17.12.12 Resource Library - Search Parameters

Maturity Level : N/A
Responsible Owner: Clinical Decision Support icon Work Group   Trial Use Normative Security Category : Anonymous Compartments : No defined compartments

Search parameters for the Resource Library - 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/MetadataResource-composed-of
This search parameter is part of the common search parameter MetadataResource-composed-of

14.15.16 Generated Narrative: SearchParameter MetadataResource-composed-of

17.12.13 composed-of

Parameter composed-of : reference

Library : What resource is being referenced

Resource Library
Expression Library.relatedArtifact.where(type='composed-of').resource
Processing Mode Normal
Target Resources All Resources
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/Library-content-type

14.15.17 Generated Narrative: SearchParameter Library-content-type

17.12.14 content-type

Parameter content-type : token

The type of content in the library (e.g. text/cql)

Resource Library
Expression Library.content.contentType
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
This search parameter is part of the common search parameter CanonicalResource-context

14.15.18 Generated Narrative: SearchParameter CanonicalResource-context

17.12.15 context

Parameter context : token

Library : A use context assigned to the library

Resource Library
Expression (Library.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

14.15.19 Generated Narrative: SearchParameter CanonicalResource-context-quantity

17.12.16 context-quantity

Parameter context-quantity : quantity

Library : A quantity- or range-valued use context assigned to the library

Resource Library
Expression (Library.useContext.value.ofType(Quantity)) | (Library.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

14.15.20 Generated Narrative: SearchParameter CanonicalResource-context-type

17.12.17 context-type

Parameter context-type : token

Library : A type of use context assigned to the library

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

14.15.21 Generated Narrative: SearchParameter CanonicalResource-context-type-quantity

17.12.18 context-type-quantity

Parameter context-type-quantity : composite

Library : A use context type and quantity- or range-based value assigned to the library

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

14.15.22 Generated Narrative: SearchParameter CanonicalResource-context-type-value

17.12.19 context-type-value

Parameter context-type-value : composite

Library : A use context type and value assigned to the library

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

14.15.23 Generated Narrative: SearchParameter CanonicalResource-date

17.12.20 date

Parameter date : date

Library : The library publication date

Resource Library
Expression Library.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/MetadataResource-depends-on
This search parameter is part of the common search parameter MetadataResource-depends-on

14.15.24 Generated Narrative: SearchParameter MetadataResource-depends-on

17.12.21 depends-on

Parameter depends-on : reference

Library : What resource is being referenced

Resource Library
Expression Library.relatedArtifact.where(type='depends-on').resource
Processing Mode Normal
Target Resources All Resources
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/MetadataResource-derived-from
This search parameter is part of the common search parameter MetadataResource-derived-from

14.15.25 Generated Narrative: SearchParameter MetadataResource-derived-from

17.12.22 derived-from

Parameter derived-from : reference

Library : What resource is being referenced

Resource Library
Expression Library.relatedArtifact.where(type='derived-from').resource
Processing Mode Normal
Target Resources All Resources
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

14.15.26 Generated Narrative: SearchParameter CanonicalResource-description

17.12.23 description

Parameter description : string

Library : The description of the library

Resource Library
Expression Library.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/MetadataResource-effective
This search parameter is part of the common search parameter MetadataResource-effective

14.15.27 Generated Narrative: SearchParameter MetadataResource-effective

17.12.24 effective

Parameter effective : date

Library : The time during which the library is intended to be in use

Resource Library
Expression Library.effectivePeriod
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/Library-experimental

Generated Narrative: SearchParameter Library-experimental

17.12.25 experimental

Parameter experimental : token

Whether the Library is experimental

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

14.15.28 Generated Narrative: SearchParameter CanonicalResource-identifier

17.12.26 identifier

Parameter identifier : token

Library : External identifier for the library

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

14.15.29 Generated Narrative: SearchParameter CanonicalResource-jurisdiction

17.12.27 jurisdiction

Parameter jurisdiction : token

Library : Intended jurisdiction for Jurisdiction of the authority that maintains the the library

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

14.15.30 Generated Narrative: SearchParameter CanonicalResource-name

17.12.28 name

Parameter name : string

Library : Computationally friendly name of the library

Resource Library
Expression Library.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/MetadataResource-predecessor
This search parameter is part of the common search parameter MetadataResource-predecessor

14.15.31 Generated Narrative: SearchParameter MetadataResource-predecessor

17.12.29 predecessor

Parameter predecessor : reference

Library : What resource is being referenced

Resource Library
Expression Library.relatedArtifact.where(type='predecessor').resource
Processing Mode Normal
Target Resources All Resources
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

14.15.32 Generated Narrative: SearchParameter CanonicalResource-publisher

17.12.30 publisher

Parameter publisher : string

Library : Name of the publisher of the library

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

14.15.33 Generated Narrative: SearchParameter CanonicalResource-status

17.12.31 status

Parameter status : token

Library : The current status of the library

Resource Library
Expression Library.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/Library-subject-canonical

Generated Narrative: SearchParameter Library-subject-canonical

17.12.32 subject-canonical

Parameter subject-canonical : reference

The subject of the Library when expressed as a canonical

Resource Library
Expression Library.subject as canonical
Processing Mode Normal
Target Resources Group
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/Library-subject-code

Generated Narrative: SearchParameter Library-subject-code

17.12.33 subject-code

Parameter subject-code : token

The subject of the Library when expressed as a code

Resource Library
Expression Library.subject as 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/Library-subject-reference

Generated Narrative: SearchParameter Library-subject-reference

17.12.34 subject-reference

Parameter subject-reference : reference

The subject of the Library when expressed as a reference

Resource Library
Expression Library.subject as Reference
Processing Mode Normal
Target Resources Group
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/MetadataResource-successor
This search parameter is part of the common search parameter MetadataResource-successor

14.15.34 Generated Narrative: SearchParameter MetadataResource-successor

17.12.35 successor

Parameter successor : reference

Library : What resource is being referenced

Resource Library
Expression Library.relatedArtifact.where(type='successor').resource
Processing Mode Normal
Target Resources All Resources
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

14.15.35 Generated Narrative: SearchParameter CanonicalResource-title

17.12.36 title

Parameter title : string

Library : The human-friendly name of the library

Resource Library
Expression Library.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/MetadataResource-topic
This search parameter is part of the common search parameter MetadataResource-topic

14.15.36 Generated Narrative: SearchParameter MetadataResource-topic

17.12.37 topic

Parameter topic : token

Library : Topics associated with the module

Resource Library
Expression Library.topic
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/Library-type

14.15.37 Generated Narrative: SearchParameter Library-type

17.12.38 type

Parameter type : token

The type of the library (e.g. logic-library, model-definition, asset-collection, module-definition)

Resource Library
Expression Library.type
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

14.15.38 Generated Narrative: SearchParameter CanonicalResource-url

17.12.39 url

Parameter url : uri

Library : The uri that identifies the library

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

14.15.39 Generated Narrative: SearchParameter CanonicalResource-version

17.12.40 version

Parameter version : token

Library : The business version of the library

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