Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

4.8.26 Resource CodeSystem - Search Parameters

Vocabulary Work GroupMaturity Level: N/AStandards Status: InformativeSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Search Parameter Registry for the codesystem resource

4.8.27 Search Parameters

Search parameter list for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/CodeSystem-code

4.8.28 code

Parameter code:token

A code defined in the code system

ResourceCodeSystem
ExpressionCodeSystem.concept.code
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/codesystem-extensions-CodeSystem-author

4.8.29 author

Parameter author:string

Optional Extensions Element

ResourceCodeSystem
ExpressionCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-author').value
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/codesystem-extensions-CodeSystem-effective

4.8.30 effective

Parameter effective:date

Optional Extensions Element

ResourceCodeSystem
ExpressionCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-effectiveDate'.value)
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/codesystem-extensions-CodeSystem-end

4.8.31 end

Parameter end:date

Optional Extensions Element

ResourceCodeSystem
ExpressionCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate').value
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/codesystem-extensions-CodeSystem-keyword

4.8.32 keyword

Parameter keyword:string

Optional Extensions Element

ResourceCodeSystem
ExpressionCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-keyWord').value
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/codesystem-extensions-CodeSystem-workflow

4.8.33 workflow

Parameter workflow:token

Optional Extensions Element

ResourceCodeSystem
ExpressionCodeSystem.extension('http://hl7.org/fhir/StructureDefinition/codesystem-workflowStatus').value
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CodeSystem-content-mode

4.8.34 content-mode

Parameter content-mode:token

not-present | example | fragment | complete | supplement

ResourceCodeSystem
ExpressionCodeSystem.content
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-context

4.8.35 context

Parameter context:token

A use context assigned to the code system

Resources
Expression(CodeSystem.useContext.value as CodeableConcept)
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-context-quantity

4.8.36 context-quantity

Parameter context-quantity:quantity

A quantity- or range-valued use context assigned to the code system

Resources
Expression(CodeSystem.useContext.value as Quantity) | (CodeSystem.useContext.value as Range)
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-context-type

4.8.37 context-type

Parameter context-type:token

A type of use context assigned to the code system

Resources
ExpressionCodeSystem.useContext.code
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-context-type-quantity

4.8.38 context-type-quantity

Parameter context-type-quantity:composite

A use context type and quantity- or range-based value assigned to the code system

Resources
ExpressionCodeSystem.useContext
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

context-typecode
context-quantityvalue.ofType(Quantity) | value.ofType(Range)
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-context-type-value

4.8.39 context-type-value

Parameter context-type-value:composite

A use context type and value assigned to the code system

Resources
ExpressionCodeSystem.useContext
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values

Components

context-typecode
contextvalue.ofType(CodeableConcept)
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-date

4.8.40 date

Parameter date:date

The code system publication date

Resources
ExpressionCodeSystem.date
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CodeSystem-derived-from

4.8.41 derived-from

Parameter derived-from:reference

A resource that the CodeSystem is derived from

ResourceCodeSystem
ExpressionCodeSystem.relatedArtifact.where(type='derived-from').resource
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-description

4.8.42 description

Parameter description:string

The description of the code system

Resources
ExpressionCodeSystem.description
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/conformance-effective

4.8.43 effective

Parameter effective:date

Multiple Resources:

  • CodeSystem: The time during which the CodeSystem is intended to be in use
  • ConceptMap: The time during which the ConceptMap is intended to be in use
  • NamingSystem: The time during which the NamingSystem is intended to be in use
  • ValueSet: The time during which the ValueSet is intended to be in use
ResourcesCodeSystemConceptMapNamingSystemValueSet
ExpressionCodeSystem.effectivePeriod | ConceptMap.effectivePeriod | NamingSystem.effectivePeriod | ValueSet.effectivePeriod
MultiplesThe parameter cannot repeat or have multiple values
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/conformance-identifier

4.8.44 identifier

Parameter identifier:token

Multiple Resources:

ResourcesCodeSystemConceptMapMessageDefinitionNamingSystemStructureDefinitionStructureMapTerminologyCapabilitiesValueSet
ExpressionCodeSystem.identifier | ConceptMap.identifier | MessageDefinition.identifier | NamingSystem.identifier | StructureDefinition.identifier | StructureMap.identifier | TerminologyCapabilities.identifier | ValueSet.identifier
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-jurisdiction

4.8.45 jurisdiction

Parameter jurisdiction:token

Intended jurisdiction for the code system

Resources
ExpressionCodeSystem.jurisdiction
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CodeSystem-language

4.8.46 language

Parameter language:token

A language in which a designation is provided

ResourceCodeSystem
ExpressionCodeSystem.concept.designation.language
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-name

4.8.47 name

Parameter name:string

Computationally friendly name of the code system

Resources
ExpressionCodeSystem.name
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CodeSystem-predecessor

4.8.48 predecessor

Parameter predecessor:reference

The predecessor of the CodeSystem

ResourceCodeSystem
ExpressionCodeSystem.relatedArtifact.where(type='predecessor').resource
Target ResourcesAll Resources
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-publisher

4.8.49 publisher

Parameter publisher:string

Name of the publisher of the code system

Resources
ExpressionCodeSystem.publisher
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-status

4.8.50 status

Parameter status:token

The current status of the code system

Resources
ExpressionCodeSystem.status
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CodeSystem-supplements

4.8.51 supplements

Parameter supplements:reference

Find code system supplements for the referenced code system

ResourceCodeSystem
ExpressionCodeSystem.supplements
Target ResourcesCodeSystem
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CodeSystem-system

4.8.52 system

Parameter system:uri

The system for any codes defined by this code system (same as 'url')

ResourceCodeSystem
ExpressionCodeSystem.url
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-title

4.8.53 title

Parameter title:string

The human-friendly name of the code system

Resources
ExpressionCodeSystem.title
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/CodeSystem-topic

4.8.54 topic

Parameter topic:token

Topics associated with the CodeSystem

ResourceCodeSystem
ExpressionCodeSystem.topic
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-url

4.8.55 url

Parameter url:uri

The uri that identifies the code system

Resources
ExpressionCodeSystem.url
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/CodeSystem-version

4.8.56 version

Parameter version:token

The business version of the code system

Resources
ExpressionCodeSystem.version
UsageNormal
MultiplesThe parameter cannot repeat or have multiple values