R6 Ballot (3rd Draft) FHIR CI-Build

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 Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.3.12 8.3.13 Resource Group - Search Parameters

Maturity Level : N/A
Responsible Owner: FHIR Infrastructure icon Work Group   Trial Use Normative Security Category : Business Compartments : Device , Patient , Practitioner

Search parameters for the Group 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/Group-characteristic

Generated Narrative: SearchParameter Group-characteristic

8.3.13 8.3.14 characteristic

Parameter characteristic : token

Kind of characteristic

Resource Group
Expression Group.characteristic.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/Group-characteristic-reference http://hl7.org/fhir/SearchParameter/Group-characteristic-quantity

Generated Narrative: SearchParameter Group-characteristic-reference Group-characteristic-quantity

8.3.14 8.3.15 characteristic-reference characteristic-quantity

Parameter characteristic-reference characteristic-quantity : reference composite

An entity referenced in a A composite of both characteristic and quantity values

Resource Group
Expression (Group.characteristic.value.ofType(Reference)) Group.characteristic
Processing Mode Normal
Target Resources Multiples 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 ,
  • 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

characteristic code
quantity (value.ofType(Quantity)) | (value.ofType(Range))
 
http://hl7.org/fhir/SearchParameter/Group-characteristic-reference

Generated Narrative: SearchParameter Group-characteristic-reference

8.3.16 characteristic-reference

Parameter characteristic-reference : composite

A composite of both characteristic and reference values

Resource 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
Expression Group.characteristic
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 The parameter can may only have multiple values (separated by comma) where at least one must be true value (no comma separators)

Comparators

characteristic code
http://hl7.org/fhir/SearchParameter/Group-reference value.ofType(Reference))
 
http://hl7.org/fhir/SearchParameter/Group-characteristic-value

Generated Narrative: SearchParameter Group-characteristic-value

8.3.15 8.3.17 characteristic-value

Parameter characteristic-value : composite

A composite of both characteristic and value

Resource Group
Expression Group.characteristic
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

characteristic code
value (value.ofType(CodeableConcept)) | (value.ofType(boolean))
 
http://hl7.org/fhir/SearchParameter/Group-code

Generated Narrative: SearchParameter Group-code

8.3.16 8.3.18 code

Parameter code : token

The kind of resources contained

Resource Group
Expression Group.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/Group-exclude

Generated Narrative: SearchParameter Group-exclude

8.3.17 8.3.19 exclude

Parameter exclude : token

Group includes or excludes

Resource Group
Expression Group.characteristic.exclude
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/Group-experimental

Generated Narrative: SearchParameter Group-experimental

8.3.20 experimental

Parameter experimental : token

Whether the Group is experimental

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

Generated Narrative: SearchParameter CanonicalResource-identifier

8.3.18 8.3.21 identifier

Parameter identifier : token

Group : Unique id

Resource Group
Expression Group.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/Group-managing-entity

Generated Narrative: SearchParameter Group-managing-entity

8.3.19 8.3.22 managing-entity

Parameter managing-entity : reference

Entity that is the custodian of the Group's definition

Resource Group
Expression Group.managingEntity
Processing Mode Normal
Target Resources Organization , RelatedPerson , PractitionerRole , Practitioner
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/Group-member

Generated Narrative: SearchParameter Group-member

8.3.20 8.3.23 member

Parameter member : reference

Reference to the group member

Resource Group
Expression Group.member.entity
Processing Mode Normal
Target Resources CareTeam , Device , Organization , RelatedPerson , Group , Practitioner , BiologicallyDerivedProduct , Specimen , Substance , SubstanceDefinition , Location , MedicinalProductDefinition , HealthcareService , PractitionerRole , NutritionProduct , Patient , Medication
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/Group-membership

Generated Narrative: SearchParameter Group-membership

8.3.21 8.3.24 membership

Parameter membership : token

Definitional or enumerated group

Resource Group
Expression Group.membership
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

8.3.22 8.3.25 name

Parameter name : string

Group : A portion of the Group's name

Resource Group
Expression Group.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/Group-quantity

Generated Narrative: SearchParameter Group-quantity

8.3.26 quantity

Parameter quantity : quantity

Quantity Value held by characteristic

Resource Group
Expression (Group.characteristic.value.ofType(Quantity)) | (Group.characteristic.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-status
This search parameter is part of the common search parameter CanonicalResource-status

Generated Narrative: SearchParameter CanonicalResource-status

8.3.23 8.3.27 status

Parameter status : token

Group : The current status of the Group

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

Generated Narrative: SearchParameter Group-type

8.3.24 8.3.28 type

Parameter type : token

The type of resources the group contains

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

8.3.25 8.3.29 url

Parameter url : uri

Group : The uri that identifies the Group

Resource Group
Expression Group.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/Group-value

Generated Narrative: SearchParameter Group-value

8.3.26 8.3.30 value

Parameter value : token

Value held by characteristic

Resource Group
Expression (Group.characteristic.value.ofType(CodeableConcept)) | (Group.characteristic.value.ofType(boolean))
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