This page is part of the FHIR Specification v6.0.0-ballot3: Release 6 Ballot (3rd Draft) (see Ballot Notes ). The current version is 5.0.0 . For a full list of available versions, see the Directory of published versions
http://hl7.org/fhir/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.codeProcessing 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-contextThis search parameter is part of the common search parameter 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-quantityThis search parameter is part of the common search parameter 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-typeThis search parameter is part of the common search parameter 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.codeProcessing 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-quantityThis search parameter is part of the common search parameter 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.useContextProcessing 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
http://hl7.org/fhir/SearchParameter/CanonicalResource-context-type-valueThis search parameter is part of the common search parameter 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.useContextProcessing 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
http://hl7.org/fhir/SearchParameter/CanonicalResource-dateThis search parameter is part of the common search parameter CanonicalResource-date 4.9.28 date TU Parameter date:date
ValueSet : The value set publication date
Resource ValueSet Expression
ValueSet.dateProcessing 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-fromThis search parameter is part of the common search parameter 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').resourceProcessing 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 , MolecularSequence , 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 , SubstanceNucleicAcid , SubstancePolymer , SubstanceProtein , SubstanceReferenceInformation , SubstanceSourceMaterial , SupplyDelivery , SupplyRequest , Task , TerminologyCapabilities , TestPlan , TestReport , TestScript , 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-descriptionThis search parameter is part of the common search parameter CanonicalResource-description 4.9.30 description TU Parameter description:string
ValueSet : The description of the value set
Resource ValueSet Expression
ValueSet.descriptionProcessing 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-effectiveThis search parameter is part of the common search parameter 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.effectivePeriodProcessing 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 4.9.32 expansion Parameter expansion:uri
Identifies the value set expansion (business identifier)
Resource ValueSet Expression
ValueSet.expansion.identifierProcessing 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-identifierThis search parameter is part of the common search parameter CanonicalResource-identifier 4.9.33 identifier TU Parameter identifier:token
ValueSet : External identifier for the value set
Resource ValueSet Expression
ValueSet.identifierProcessing 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-jurisdictionThis search parameter is part of the common search parameter CanonicalResource-jurisdiction 4.9.34 jurisdiction TU Parameter jurisdiction:token
ValueSet : Intended jurisdiction for the value set
Resource ValueSet Expression
ValueSet.jurisdictionProcessing 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-nameThis search parameter is part of the common search parameter CanonicalResource-name 4.9.35 name TU Parameter name:string
ValueSet : Computationally friendly name of the value set
Resource ValueSet Expression
ValueSet.nameProcessing 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-predecessorThis search parameter is part of the common search parameter MetadataResource-predecessor 4.9.36 predecessor TU Parameter predecessor:reference
ValueSet : The predecessor of the ValueSet
Resource ValueSet Expression
ValueSet.relatedArtifact.where(type='predecessor').resourceProcessing 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 , MolecularSequence , 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 , SubstanceNucleicAcid , SubstancePolymer , SubstanceProtein , SubstanceReferenceInformation , SubstanceSourceMaterial , SupplyDelivery , SupplyRequest , Task , TerminologyCapabilities , TestPlan , TestReport , TestScript , 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-publisherThis search parameter is part of the common search parameter CanonicalResource-publisher 4.9.37 publisher TU Parameter publisher:string
ValueSet : Name of the publisher of the value set
Resource ValueSet Expression
ValueSet.publisherProcessing 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 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.systemProcessing 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-statusThis search parameter is part of the common search parameter CanonicalResource-status 4.9.39 status TU Parameter status:token
ValueSet : The current status of the value set
Resource ValueSet Expression
ValueSet.statusProcessing 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-titleThis search parameter is part of the common search parameter CanonicalResource-title 4.9.40 title TU Parameter title:string
ValueSet : The human-friendly name of the value set
Resource ValueSet Expression
ValueSet.titleProcessing 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-topicThis search parameter is part of the common search parameter MetadataResource-topic 4.9.41 topic TU Parameter topic:token
ValueSet : Topics associated with the ValueSet
Resource ValueSet Expression
ValueSet.topicProcessing 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-urlThis search parameter is part of the common search parameter CanonicalResource-url 4.9.42 url TU Parameter url:uri
ValueSet : The uri that identifies the value set
Resource ValueSet Expression
ValueSet.urlProcessing 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-versionThis search parameter is part of the common search parameter CanonicalResource-version 4.9.43 version TU Parameter version:token
ValueSet : The business version of the value set
Resource ValueSet Expression
ValueSet.versionProcessing 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
Terminology
|
Propose a change