Release 5 R6 Ballot (2nd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot2: Release 6 Ballot (2nd Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions

5.7.14 5.7.13 Resource CompartmentDefinition - Search Parameters

FHIR Infrastructure icon Work Group Maturity Level : N/A   Trial Use Security Category : Anonymous Compartments : No defined compartments

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

5.7.15 Generated Narrative: SearchParameter CompartmentDefinition-code

5.7.14 code

Parameter code : token

Patient | Encounter | RelatedPerson | Practitioner | Device

Resource CompartmentDefinition
Expression CompartmentDefinition.code
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

5.7.16 Generated Narrative: SearchParameter CanonicalResource-context

5.7.15 context

Parameter context : token

CompartmentDefinition : A use context assigned to the compartment definition

Resource CompartmentDefinition
Expression (CompartmentDefinition.useContext.value.ofType(CodeableConcept))
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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.7.17 Generated Narrative: SearchParameter CanonicalResource-context-quantity

5.7.16 context-quantity

Parameter context-quantity : quantity

CompartmentDefinition : A quantity- or range-valued use context assigned to the compartment definition

Resource CompartmentDefinition
Expression (CompartmentDefinition.useContext.value.ofType(Quantity)) | (CompartmentDefinition.useContext.value.ofType(Range))
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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

5.7.18 Generated Narrative: SearchParameter CanonicalResource-context-type

5.7.17 context-type

Parameter context-type : token

CompartmentDefinition : A type of use context assigned to the compartment definition

Resource CompartmentDefinition
Expression CompartmentDefinition.useContext.code
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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.7.19 Generated Narrative: SearchParameter CanonicalResource-context-type-quantity

5.7.18 context-type-quantity

Parameter context-type-quantity : composite

CompartmentDefinition : A use context type and quantity- or range-based value assigned to the compartment definition

Resource CompartmentDefinition
Expression CompartmentDefinition.useContext
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components 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

5.7.20 Generated Narrative: SearchParameter CanonicalResource-context-type-value

5.7.19 context-type-value

Parameter context-type-value : composite

CompartmentDefinition : A use context type and value assigned to the compartment definition

Resource CompartmentDefinition
Expression CompartmentDefinition.useContext
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or have in order to specify multiple values that must all be true
  • multipleOr: The parameter may only have one value (no comma separators)

Components 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

5.7.21 Generated Narrative: SearchParameter CanonicalResource-date

5.7.20 date

Parameter date : date

CompartmentDefinition : The compartment definition publication date

Resource CompartmentDefinition
Expression CompartmentDefinition.date
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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-description
This search parameter is part of the common search parameter CanonicalResource-description

5.7.22 Generated Narrative: SearchParameter CanonicalResource-description

5.7.21 description

Parameter description : string

CompartmentDefinition : The description of the compartment definition

Resource CompartmentDefinition
Expression CompartmentDefinition.description
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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.7.23 Generated Narrative: SearchParameter CanonicalResource-name

5.7.22 name

Parameter name : string

CompartmentDefinition : Computationally friendly name of the compartment definition

Resource CompartmentDefinition
Expression CompartmentDefinition.name
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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.7.24 Generated Narrative: SearchParameter CanonicalResource-publisher

5.7.23 publisher

Parameter publisher : string

CompartmentDefinition : Name of the publisher of the compartment definition

Resource CompartmentDefinition
Expression CompartmentDefinition.publisher
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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/CompartmentDefinition-resource

5.7.25 Generated Narrative: SearchParameter CompartmentDefinition-resource

5.7.24 resource

Parameter resource : token

Name of resource type

Resource CompartmentDefinition
Expression CompartmentDefinition.resource.code
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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.7.26 Generated Narrative: SearchParameter CanonicalResource-status

5.7.25 status

Parameter status : token

CompartmentDefinition : The current status of the compartment definition

Resource CompartmentDefinition
Expression CompartmentDefinition.status
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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.7.27 Generated Narrative: SearchParameter CanonicalResource-url

5.7.26 url

Parameter url : uri

CompartmentDefinition : The uri that identifies the compartment definition

Resource CompartmentDefinition
Expression CompartmentDefinition.url
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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.7.28 Generated Narrative: SearchParameter CanonicalResource-version

5.7.27 version

Parameter version : token

CompartmentDefinition : The business version of the compartment definition

Resource CompartmentDefinition
Expression CompartmentDefinition.version
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or 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