ValueSet - FHIR v6.0.0-ballot3

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

4.9.21 Resource ValueSet - Search Parameters

Terminology Infrastructure icon

Work Group

Maturity Level: N/A

Normative (from v4.0.0)

Security Category: Anonymous

Compartments: No defined compartments

Search parameters for the ValueSet 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/ValueSet-code

Generated Narrative: SearchParameter ValueSet-code

4.9.22 code

Parameter code:token

This special parameter searches for codes in the value set. See additional notes on the ValueSet resource

Resource ValueSet

Expression ValueSet.expansion.contains.code | ValueSet.compose.include.concept.code

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-context

This search parameter is part of the common search parameter CanonicalResource-context

Generated Narrative: SearchParameter CanonicalResource-context

4.9.23 context TU

Parameter context:token

ValueSet: A use context assigned to the value set

Resource ValueSet

Expression (ValueSet.useContext.value.ofType(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/CanonicalResource-context-quantity

This search parameter is part of the common search parameter CanonicalResource-context-quantity

Generated Narrative: SearchParameter CanonicalResource-context-quantity

4.9.24 context-quantity TU

Parameter context-quantity:quantity

ValueSet: A quantity- or range-valued use context assigned to the value set

Resource ValueSet

Expression (ValueSet.useContext.value.ofType(Quantity)) | (ValueSet.useContext.value.ofType(Range))

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

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

4.9.25 context-type TU

Parameter context-type:token

ValueSet: A type of use context assigned to the value set

Resource ValueSet

Expression ValueSet.useContext.code

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-context-type-quantity

This search parameter is part of the common search parameter CanonicalResource-context-type-quantity

Generated Narrative: SearchParameter CanonicalResource-context-type-quantity

4.9.26 context-type-quantity TU

Parameter context-type-quantity:composite

ValueSet: A use context type and quantity- or range-based value assigned to the value set

Resource ValueSet

Expression ValueSet.useContext

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: The parameter may only have one value (no comma separators)

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

4.9.27 context-type-value TU

Parameter context-type-value:composite

ValueSet: A use context type and value assigned to the value set

Resource ValueSet

Expression ValueSet.useContext

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: The parameter may only have one value (no comma separators)

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

4.9.28 date TU

Parameter date:date

ValueSet: The value set publication date

Resource ValueSet

Expression ValueSet.date

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

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/MetadataResource-derived-from

This search parameter is part of the common search parameter MetadataResource-derived-from

Generated Narrative: SearchParameter MetadataResource-derived-from

4.9.29 derived-from TU

Parameter derived-from:reference

ValueSet: A resource that the ValueSet is derived from

Resource ValueSet

Expression ValueSet.relatedArtifact.where(type='derived-from').resource

Processing Mode Normal

Target Resources Account, ActivityDefinition, ActorDefinition, AdministrableProductDefinition, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, ArtifactAssessment, AuditEvent, Basic, Binary, BiologicallyDerivedProduct, BiologicallyDerivedProductDispense, BodyStructure, Bundle, CapabilityStatement, CarePlan, CareTeam, ChargeItem, ChargeItemDefinition, Citation, Claim, ClaimResponse, ClinicalUseDefinition, CodeSystem, Communication, CommunicationRequest, CompartmentDefinition, Composition, ConceptMap, Condition, ConditionDefinition, Consent, Contract, Coverage, CoverageEligibilityRequest, CoverageEligibilityResponse, DetectedIssue, Device, DeviceAssociation, DeviceDefinition, DeviceDispense, DeviceMetric, DeviceRequest, DeviceUsage, DiagnosticReport, DocumentReference, Encounter, EncounterHistory, Endpoint, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, ExplanationOfBenefit, FamilyMemberHistory, Flag, FormularyItem, GenomicStudy, Goal, GraphDefinition, Group, GuidanceResponse, HealthcareService, ImagingSelection, ImagingStudy, Immunization, ImmunizationEvaluation, ImmunizationRecommendation, ImplementationGuide, Ingredient, InsurancePlan, InventoryItem, InventoryReport, Invoice, Library, Linkage, List, Location, ManufacturedItemDefinition, Measure, MeasureReport, Medication, MedicationAdministration, MedicationDispense, MedicationKnowledge, MedicationRequest, MedicationStatement, MedicinalProductDefinition, MessageDefinition, MessageHeader, NamingSystem, NutritionIntake, NutritionOrder, NutritionProduct, Observation, ObservationDefinition, OperationDefinition, OperationOutcome, Organization, OrganizationAffiliation, PackagedProductDefinition, Parameters, Patient, PaymentNotice, PaymentReconciliation, Permission, Person, PlanDefinition, Practitioner, PractitionerRole, Procedure, Provenance, Questionnaire, QuestionnaireResponse, RegulatedAuthorization, RelatedPerson, RequestOrchestration, Requirements, ResearchStudy, ResearchSubject, RiskAssessment, Schedule, SearchParameter, ServiceRequest, Slot, Specimen, SpecimenDefinition, StructureDefinition, StructureMap, Subscription, SubscriptionStatus, SubscriptionTopic, Substance, SubstanceDefinition, SupplyDelivery, SupplyRequest, Task, TerminologyCapabilities, Transport, ValueSet, VerificationResult, VisionPrescription

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-description

This search parameter is part of the common search parameter CanonicalResource-description

Generated Narrative: SearchParameter CanonicalResource-description

4.9.30 description TU

Parameter description:string

ValueSet: The description of the value set

Resource ValueSet

Expression ValueSet.description

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/MetadataResource-effective

This search parameter is part of the common search parameter MetadataResource-effective

Generated Narrative: SearchParameter MetadataResource-effective

4.9.31 effective TU

Parameter effective:date

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

Resource ValueSet

Expression ValueSet.effectivePeriod

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

Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap

http://hl7.org/fhir/SearchParameter/ValueSet-expansion

Generated Narrative: SearchParameter ValueSet-expansion

4.9.32 expansion

Parameter expansion:uri

Identifies the value set expansion (business identifier)

Resource ValueSet

Expression ValueSet.expansion.identifier

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

Generated Narrative: SearchParameter CanonicalResource-identifier

4.9.33 identifier TU

Parameter identifier:token

ValueSet: External identifier for the value set

Resource ValueSet

Expression ValueSet.identifier

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-jurisdiction

This search parameter is part of the common search parameter CanonicalResource-jurisdiction

Generated Narrative: SearchParameter CanonicalResource-jurisdiction

4.9.34 jurisdiction TU

Parameter jurisdiction:token

ValueSet: Jurisdiction of the authority that maintains the the value set

Resource ValueSet

Expression ValueSet.jurisdiction

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-name

This search parameter is part of the common search parameter CanonicalResource-name

Generated Narrative: SearchParameter CanonicalResource-name

4.9.35 name TU

Parameter name:string

ValueSet: Computationally friendly name of the value set

Resource ValueSet

Expression ValueSet.name

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/MetadataResource-predecessor

This search parameter is part of the common search parameter MetadataResource-predecessor

Generated Narrative: SearchParameter MetadataResource-predecessor

4.9.36 predecessor TU

Parameter predecessor:reference

ValueSet: The predecessor of the ValueSet

Resource ValueSet

Expression ValueSet.relatedArtifact.where(type='predecessor').resource

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-publisher

This search parameter is part of the common search parameter CanonicalResource-publisher

Generated Narrative: SearchParameter CanonicalResource-publisher

4.9.37 publisher TU

Parameter publisher:string

ValueSet: Name of the publisher of the value set

Resource ValueSet

Expression ValueSet.publisher

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/ValueSet-reference

Generated Narrative: SearchParameter ValueSet-reference

4.9.38 reference

Parameter reference:uri

A code system included or excluded in the value set or an imported value set

Resource ValueSet

Expression ValueSet.compose.include.system

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-status

This search parameter is part of the common search parameter CanonicalResource-status

Generated Narrative: SearchParameter CanonicalResource-status

4.9.39 status TU

Parameter status:token

ValueSet: The current status of the value set

Resource ValueSet

Expression ValueSet.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/CanonicalResource-title

This search parameter is part of the common search parameter CanonicalResource-title

Generated Narrative: SearchParameter CanonicalResource-title

4.9.40 title TU

Parameter title:string

ValueSet: The human-friendly name of the value set

Resource ValueSet

Expression ValueSet.title

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/MetadataResource-topic

This search parameter is part of the common search parameter MetadataResource-topic

Generated Narrative: SearchParameter MetadataResource-topic

4.9.41 topic TU

Parameter topic:token

ValueSet: Topics associated with the ValueSet

Resource ValueSet

Expression ValueSet.topic

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-url

This search parameter is part of the common search parameter CanonicalResource-url

Generated Narrative: SearchParameter CanonicalResource-url

4.9.42 url TU

Parameter url:uri

ValueSet: The uri that identifies the value set

Resource ValueSet

Expression ValueSet.url

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-version

This search parameter is part of the common search parameter CanonicalResource-version

Generated Narrative: SearchParameter CanonicalResource-version

4.9.43 version TU

Parameter version:token

ValueSet: The business version of the value set

Resource ValueSet

Expression ValueSet.version

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