R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

5.9.14 Resource ImplementationGuide - Search Parameters

FHIR Infrastructure icon Work GroupMaturity Level: N/A  Trial UseSecurity Category: Anonymous Compartments: No defined compartments

Search parameters for the Resource ImplementationGuide - 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/CanonicalResource-context
This search parameter is part of the common search parameter CanonicalResource-context

5.9.15 context

Parameter context:token

ImplementationGuide: A use context assigned to the implementation guide

ResourceImplementationGuide
Expression(ImplementationGuide.useContext.value.ofType(CodeableConcept))
Processing ModeNormal
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

5.9.16 context-quantity

Parameter context-quantity:quantity

ImplementationGuide: A quantity- or range-valued use context assigned to the implementation guide

ResourceImplementationGuide
Expression(ImplementationGuide.useContext.value.ofType(Quantity)) | (ImplementationGuide.useContext.value.ofType(Range))
Processing ModeNormal
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
ComparatorsAllowed: 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

5.9.17 context-type

Parameter context-type:token

ImplementationGuide: A type of use context assigned to the implementation guide

ResourceImplementationGuide
ExpressionImplementationGuide.useContext.code
Processing ModeNormal
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

5.9.18 context-type-quantity

Parameter context-type-quantity:composite

ImplementationGuide: A use context type and quantity- or range-based value assigned to the implementation guide

ResourceImplementationGuide
ExpressionImplementationGuide.useContext
Processing ModeNormal
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)

Components

context-typecode
context-quantityvalue.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

5.9.19 context-type-value

Parameter context-type-value:composite

ImplementationGuide: A use context type and value assigned to the implementation guide

ResourceImplementationGuide
ExpressionImplementationGuide.useContext
Processing ModeNormal
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)

Components

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

5.9.20 date

Parameter date:date

ImplementationGuide: The implementation guide publication date

ResourceImplementationGuide
ExpressionImplementationGuide.date
Processing ModeNormal
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
ComparatorsAllowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/ImplementationGuide-depends-on

5.9.21 depends-on

Parameter depends-on:reference

Identity of the IG that this depends on

ResourceImplementationGuide
ExpressionImplementationGuide.dependsOn.uri
Processing ModeNormal
Target ResourcesImplementationGuide
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

5.9.22 description

Parameter description:string

ImplementationGuide: The description of the implementation guide

ResourceImplementationGuide
ExpressionImplementationGuide.description
Processing ModeNormal
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/ImplementationGuide-experimental

5.9.23 experimental

Parameter experimental:token

For testing purposes, not real usage

ResourceImplementationGuide
ExpressionImplementationGuide.experimental
Processing ModeNormal
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/ImplementationGuide-global

5.9.24 global

Parameter global:reference

Profile that all resources must conform to

ResourceImplementationGuide
ExpressionImplementationGuide.global.profile
Processing ModeNormal
Target ResourcesStructureDefinition
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

5.9.25 identifier

Parameter identifier:token

ImplementationGuide: External identifier for the implementation guide

ResourceImplementationGuide
ExpressionImplementationGuide.identifier
Processing ModeNormal
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

5.9.26 jurisdiction

Parameter jurisdiction:token

ImplementationGuide: Intended jurisdiction for the implementation guide

ResourceImplementationGuide
ExpressionImplementationGuide.jurisdiction
Processing ModeNormal
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

5.9.27 name

Parameter name:string

ImplementationGuide: Computationally friendly name of the implementation guide

ResourceImplementationGuide
ExpressionImplementationGuide.name
Processing ModeNormal
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

5.9.28 publisher

Parameter publisher:string

ImplementationGuide: Name of the publisher of the implementation guide

ResourceImplementationGuide
ExpressionImplementationGuide.publisher
Processing ModeNormal
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/ImplementationGuide-resource

5.9.29 resource

Parameter resource:reference

Location of the resource

ResourceImplementationGuide
ExpressionImplementationGuide.definition.resource.reference
Processing ModeNormal
Target ResourcesAccount, ActivityDefinition, ActorDefinition, AdministrableProductDefinition, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, ArtifactAssessment, AuditEvent, Basic, Binary, BiologicallyDerivedProduct, BiologicallyDerivedProductDispense, BodyStructure, Bundle, CapabilityStatement, CarePlan, CareTeam, ChargeItem, ChargeItemDefinition, Citation, Claim, ClaimResponse, ClinicalImpression, 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, EvidenceReport, 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-status
This search parameter is part of the common search parameter CanonicalResource-status

5.9.30 status

Parameter status:token

ImplementationGuide: The current status of the implementation guide

ResourceImplementationGuide
ExpressionImplementationGuide.status
Processing ModeNormal
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

5.9.31 title

Parameter title:string

ImplementationGuide: The human-friendly name of the implementation guide

ResourceImplementationGuide
ExpressionImplementationGuide.title
Processing ModeNormal
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

5.9.32 url

Parameter url:uri

ImplementationGuide: The uri that identifies the implementation guide

ResourceImplementationGuide
ExpressionImplementationGuide.url
Processing ModeNormal
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

5.9.33 version

Parameter version:token

ImplementationGuide: The business version of the implementation guide

ResourceImplementationGuide
ExpressionImplementationGuide.version
Processing ModeNormal
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