Package org.hl7.fhir.r5.model

Class CompartmentDefinition

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
    public class CompartmentDefinition
extends CanonicalResource
    A compartment definition that defines how resources are accessed on a server.
    See Also:
    Serialized Form

    • Field Detail

      • url

        protected UriType url
        An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.

      • version

        protected StringType version
        The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

      • name

        protected StringType name
        A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

      • experimental

        protected BooleanType experimental
        A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

      • date

        protected DateTimeType date
        The date (and optionally time) when the compartment definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.

      • publisher

        protected StringType publisher
        The name of the organization or individual that published the compartment definition.

      • contact

        protected List<ContactDetail> contact
        Contact details to assist a user in finding and communicating with the publisher.

      • description

        protected MarkdownType description
        A free text natural language description of the compartment definition from a consumer's perspective.

      • useContext

        protected List<UsageContext> useContext
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate compartment definition instances.

      • purpose

        protected MarkdownType purpose
        Explanation of why this compartment definition is needed and why it has been designed as it has.

      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: Patient | Encounter | RelatedPerson | Practitioner | Device
        Type: token
        Path: CompartmentDefinition.code

        See Also:
        Constant Field Values

      • CODE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
        Fluent Client search parameter constant for code

        Description: Patient | Encounter | RelatedPerson | Practitioner | Device
        Type: token
        Path: CompartmentDefinition.code

      • SP_RESOURCE

        public static final String SP_RESOURCE
        Search parameter: resource

        Description: Name of resource type
        Type: token
        Path: CompartmentDefinition.resource.code

        See Also:
        Constant Field Values

      • RESOURCE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam RESOURCE
        Fluent Client search parameter constant for resource

        Description: Name of resource type
        Type: token
        Path: CompartmentDefinition.resource.code

      • SP_CONTEXT_QUANTITY

        public static final String SP_CONTEXT_QUANTITY
        Search parameter: context-quantity

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set
        Type: quantity
        Path: (CapabilityStatement.useContext.value as Quantity) | (CapabilityStatement.useContext.value as Range) | (CodeSystem.useContext.value as Quantity) | (CodeSystem.useContext.value as Range) | (CompartmentDefinition.useContext.value as Quantity) | (CompartmentDefinition.useContext.value as Range) | (ConceptMap.useContext.value as Quantity) | (ConceptMap.useContext.value as Range) | (GraphDefinition.useContext.value as Quantity) | (GraphDefinition.useContext.value as Range) | (ImplementationGuide.useContext.value as Quantity) | (ImplementationGuide.useContext.value as Range) | (MessageDefinition.useContext.value as Quantity) | (MessageDefinition.useContext.value as Range) | (NamingSystem.useContext.value as Quantity) | (NamingSystem.useContext.value as Range) | (OperationDefinition.useContext.value as Quantity) | (OperationDefinition.useContext.value as Range) | (SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range) | (StructureDefinition.useContext.value as Quantity) | (StructureDefinition.useContext.value as Range) | (StructureMap.useContext.value as Quantity) | (StructureMap.useContext.value as Range) | (TerminologyCapabilities.useContext.value as Quantity) | (TerminologyCapabilities.useContext.value as Range) | (ValueSet.useContext.value as Quantity) | (ValueSet.useContext.value as Range)

        See Also:
        Constant Field Values

      • CONTEXT_QUANTITY

        public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
        Fluent Client search parameter constant for context-quantity

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set
        Type: quantity
        Path: (CapabilityStatement.useContext.value as Quantity) | (CapabilityStatement.useContext.value as Range) | (CodeSystem.useContext.value as Quantity) | (CodeSystem.useContext.value as Range) | (CompartmentDefinition.useContext.value as Quantity) | (CompartmentDefinition.useContext.value as Range) | (ConceptMap.useContext.value as Quantity) | (ConceptMap.useContext.value as Range) | (GraphDefinition.useContext.value as Quantity) | (GraphDefinition.useContext.value as Range) | (ImplementationGuide.useContext.value as Quantity) | (ImplementationGuide.useContext.value as Range) | (MessageDefinition.useContext.value as Quantity) | (MessageDefinition.useContext.value as Range) | (NamingSystem.useContext.value as Quantity) | (NamingSystem.useContext.value as Range) | (OperationDefinition.useContext.value as Quantity) | (OperationDefinition.useContext.value as Range) | (SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range) | (StructureDefinition.useContext.value as Quantity) | (StructureDefinition.useContext.value as Range) | (StructureMap.useContext.value as Quantity) | (StructureMap.useContext.value as Range) | (TerminologyCapabilities.useContext.value as Quantity) | (TerminologyCapabilities.useContext.value as Range) | (ValueSet.useContext.value as Quantity) | (ValueSet.useContext.value as Range)

      • SP_CONTEXT_TYPE_QUANTITY

        public static final String SP_CONTEXT_TYPE_QUANTITY
        Search parameter: context-type-quantity

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set
        Type: composite
        Path: CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext

        See Also:
        Constant Field Values

      • CONTEXT_TYPE_QUANTITY

        public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
        Fluent Client search parameter constant for context-type-quantity

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set
        Type: composite
        Path: CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext

      • SP_CONTEXT_TYPE_VALUE

        public static final String SP_CONTEXT_TYPE_VALUE
        Search parameter: context-type-value

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement [CodeSystem](codesystem.html): A use context type and value assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition [StructureMap](structuremap.html): A use context type and value assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities [ValueSet](valueset.html): A use context type and value assigned to the value set
        Type: composite
        Path: CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext

        See Also:
        Constant Field Values

      • CONTEXT_TYPE_VALUE

        public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
        Fluent Client search parameter constant for context-type-value

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement [CodeSystem](codesystem.html): A use context type and value assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition [StructureMap](structuremap.html): A use context type and value assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities [ValueSet](valueset.html): A use context type and value assigned to the value set
        Type: composite
        Path: CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext

      • SP_CONTEXT_TYPE

        public static final String SP_CONTEXT_TYPE
        Search parameter: context-type

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement [CodeSystem](codesystem.html): A type of use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition [ConceptMap](conceptmap.html): A type of use context assigned to the concept map [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition [NamingSystem](namingsystem.html): A type of use context assigned to the naming system [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition [StructureMap](structuremap.html): A type of use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities [ValueSet](valueset.html): A type of use context assigned to the value set
        Type: token
        Path: CapabilityStatement.useContext.code | CodeSystem.useContext.code | CompartmentDefinition.useContext.code | ConceptMap.useContext.code | GraphDefinition.useContext.code | ImplementationGuide.useContext.code | MessageDefinition.useContext.code | NamingSystem.useContext.code | OperationDefinition.useContext.code | SearchParameter.useContext.code | StructureDefinition.useContext.code | StructureMap.useContext.code | TerminologyCapabilities.useContext.code | ValueSet.useContext.code

        See Also:
        Constant Field Values

      • CONTEXT_TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
        Fluent Client search parameter constant for context-type

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement [CodeSystem](codesystem.html): A type of use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition [ConceptMap](conceptmap.html): A type of use context assigned to the concept map [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition [NamingSystem](namingsystem.html): A type of use context assigned to the naming system [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition [StructureMap](structuremap.html): A type of use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities [ValueSet](valueset.html): A type of use context assigned to the value set
        Type: token
        Path: CapabilityStatement.useContext.code | CodeSystem.useContext.code | CompartmentDefinition.useContext.code | ConceptMap.useContext.code | GraphDefinition.useContext.code | ImplementationGuide.useContext.code | MessageDefinition.useContext.code | NamingSystem.useContext.code | OperationDefinition.useContext.code | SearchParameter.useContext.code | StructureDefinition.useContext.code | StructureMap.useContext.code | TerminologyCapabilities.useContext.code | ValueSet.useContext.code

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement [CodeSystem](codesystem.html): A use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition [ConceptMap](conceptmap.html): A use context assigned to the concept map [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context assigned to the message definition [NamingSystem](namingsystem.html): A use context assigned to the naming system [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition [SearchParameter](searchparameter.html): A use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition [StructureMap](structuremap.html): A use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities [ValueSet](valueset.html): A use context assigned to the value set
        Type: token
        Path: (CapabilityStatement.useContext.value as CodeableConcept) | (CodeSystem.useContext.value as CodeableConcept) | (CompartmentDefinition.useContext.value as CodeableConcept) | (ConceptMap.useContext.value as CodeableConcept) | (GraphDefinition.useContext.value as CodeableConcept) | (ImplementationGuide.useContext.value as CodeableConcept) | (MessageDefinition.useContext.value as CodeableConcept) | (NamingSystem.useContext.value as CodeableConcept) | (OperationDefinition.useContext.value as CodeableConcept) | (SearchParameter.useContext.value as CodeableConcept) | (StructureDefinition.useContext.value as CodeableConcept) | (StructureMap.useContext.value as CodeableConcept) | (TerminologyCapabilities.useContext.value as CodeableConcept) | (ValueSet.useContext.value as CodeableConcept)

        See Also:
        Constant Field Values

      • CONTEXT

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
        Fluent Client search parameter constant for context

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement [CodeSystem](codesystem.html): A use context assigned to the code system [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition [ConceptMap](conceptmap.html): A use context assigned to the concept map [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide [MessageDefinition](messagedefinition.html): A use context assigned to the message definition [NamingSystem](namingsystem.html): A use context assigned to the naming system [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition [SearchParameter](searchparameter.html): A use context assigned to the search parameter [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition [StructureMap](structuremap.html): A use context assigned to the structure map [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities [ValueSet](valueset.html): A use context assigned to the value set
        Type: token
        Path: (CapabilityStatement.useContext.value as CodeableConcept) | (CodeSystem.useContext.value as CodeableConcept) | (CompartmentDefinition.useContext.value as CodeableConcept) | (ConceptMap.useContext.value as CodeableConcept) | (GraphDefinition.useContext.value as CodeableConcept) | (ImplementationGuide.useContext.value as CodeableConcept) | (MessageDefinition.useContext.value as CodeableConcept) | (NamingSystem.useContext.value as CodeableConcept) | (OperationDefinition.useContext.value as CodeableConcept) | (SearchParameter.useContext.value as CodeableConcept) | (StructureDefinition.useContext.value as CodeableConcept) | (StructureMap.useContext.value as CodeableConcept) | (TerminologyCapabilities.useContext.value as CodeableConcept) | (ValueSet.useContext.value as CodeableConcept)

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The capability statement publication date [CodeSystem](codesystem.html): The code system publication date [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date [ConceptMap](conceptmap.html): The concept map publication date [GraphDefinition](graphdefinition.html): The graph definition publication date [ImplementationGuide](implementationguide.html): The implementation guide publication date [MessageDefinition](messagedefinition.html): The message definition publication date [NamingSystem](namingsystem.html): The naming system publication date [OperationDefinition](operationdefinition.html): The operation definition publication date [SearchParameter](searchparameter.html): The search parameter publication date [StructureDefinition](structuredefinition.html): The structure definition publication date [StructureMap](structuremap.html): The structure map publication date [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date [ValueSet](valueset.html): The value set publication date
        Type: date
        Path: CapabilityStatement.date | CodeSystem.date | CompartmentDefinition.date | ConceptMap.date | GraphDefinition.date | ImplementationGuide.date | MessageDefinition.date | NamingSystem.date | OperationDefinition.date | SearchParameter.date | StructureDefinition.date | StructureMap.date | TerminologyCapabilities.date | ValueSet.date

        See Also:
        Constant Field Values

      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The capability statement publication date [CodeSystem](codesystem.html): The code system publication date [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date [ConceptMap](conceptmap.html): The concept map publication date [GraphDefinition](graphdefinition.html): The graph definition publication date [ImplementationGuide](implementationguide.html): The implementation guide publication date [MessageDefinition](messagedefinition.html): The message definition publication date [NamingSystem](namingsystem.html): The naming system publication date [OperationDefinition](operationdefinition.html): The operation definition publication date [SearchParameter](searchparameter.html): The search parameter publication date [StructureDefinition](structuredefinition.html): The structure definition publication date [StructureMap](structuremap.html): The structure map publication date [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date [ValueSet](valueset.html): The value set publication date
        Type: date
        Path: CapabilityStatement.date | CodeSystem.date | CompartmentDefinition.date | ConceptMap.date | GraphDefinition.date | ImplementationGuide.date | MessageDefinition.date | NamingSystem.date | OperationDefinition.date | SearchParameter.date | StructureDefinition.date | StructureMap.date | TerminologyCapabilities.date | ValueSet.date

      • SP_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: description

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The description of the capability statement [CodeSystem](codesystem.html): The description of the code system [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition [ConceptMap](conceptmap.html): The description of the concept map [GraphDefinition](graphdefinition.html): The description of the graph definition [ImplementationGuide](implementationguide.html): The description of the implementation guide [MessageDefinition](messagedefinition.html): The description of the message definition [NamingSystem](namingsystem.html): The description of the naming system [OperationDefinition](operationdefinition.html): The description of the operation definition [SearchParameter](searchparameter.html): The description of the search parameter [StructureDefinition](structuredefinition.html): The description of the structure definition [StructureMap](structuremap.html): The description of the structure map [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities [ValueSet](valueset.html): The description of the value set
        Type: string
        Path: CapabilityStatement.description | CodeSystem.description | CompartmentDefinition.description | ConceptMap.description | GraphDefinition.description | ImplementationGuide.description | MessageDefinition.description | NamingSystem.description | OperationDefinition.description | SearchParameter.description | StructureDefinition.description | StructureMap.description | TerminologyCapabilities.description | ValueSet.description

        See Also:
        Constant Field Values

      • DESCRIPTION

        public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
        Fluent Client search parameter constant for description

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The description of the capability statement [CodeSystem](codesystem.html): The description of the code system [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition [ConceptMap](conceptmap.html): The description of the concept map [GraphDefinition](graphdefinition.html): The description of the graph definition [ImplementationGuide](implementationguide.html): The description of the implementation guide [MessageDefinition](messagedefinition.html): The description of the message definition [NamingSystem](namingsystem.html): The description of the naming system [OperationDefinition](operationdefinition.html): The description of the operation definition [SearchParameter](searchparameter.html): The description of the search parameter [StructureDefinition](structuredefinition.html): The description of the structure definition [StructureMap](structuremap.html): The description of the structure map [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities [ValueSet](valueset.html): The description of the value set
        Type: string
        Path: CapabilityStatement.description | CodeSystem.description | CompartmentDefinition.description | ConceptMap.description | GraphDefinition.description | ImplementationGuide.description | MessageDefinition.description | NamingSystem.description | OperationDefinition.description | SearchParameter.description | StructureDefinition.description | StructureMap.description | TerminologyCapabilities.description | ValueSet.description

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement [CodeSystem](codesystem.html): Computationally friendly name of the code system [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition [ConceptMap](conceptmap.html): Computationally friendly name of the concept map [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition [NamingSystem](namingsystem.html): Computationally friendly name of the naming system [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition [StructureMap](structuremap.html): Computationally friendly name of the structure map [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities [ValueSet](valueset.html): Computationally friendly name of the value set
        Type: string
        Path: CapabilityStatement.name | CodeSystem.name | CompartmentDefinition.name | ConceptMap.name | GraphDefinition.name | ImplementationGuide.name | MessageDefinition.name | NamingSystem.name | OperationDefinition.name | SearchParameter.name | StructureDefinition.name | StructureMap.name | TerminologyCapabilities.name | ValueSet.name

        See Also:
        Constant Field Values

      • NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
        Fluent Client search parameter constant for name

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement [CodeSystem](codesystem.html): Computationally friendly name of the code system [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition [ConceptMap](conceptmap.html): Computationally friendly name of the concept map [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition [NamingSystem](namingsystem.html): Computationally friendly name of the naming system [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition [StructureMap](structuremap.html): Computationally friendly name of the structure map [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities [ValueSet](valueset.html): Computationally friendly name of the value set
        Type: string
        Path: CapabilityStatement.name | CodeSystem.name | CompartmentDefinition.name | ConceptMap.name | GraphDefinition.name | ImplementationGuide.name | MessageDefinition.name | NamingSystem.name | OperationDefinition.name | SearchParameter.name | StructureDefinition.name | StructureMap.name | TerminologyCapabilities.name | ValueSet.name

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement [CodeSystem](codesystem.html): Name of the publisher of the code system [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition [ConceptMap](conceptmap.html): Name of the publisher of the concept map [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition [NamingSystem](namingsystem.html): Name of the publisher of the naming system [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition [SearchParameter](searchparameter.html): Name of the publisher of the search parameter [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition [StructureMap](structuremap.html): Name of the publisher of the structure map [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities [ValueSet](valueset.html): Name of the publisher of the value set
        Type: string
        Path: CapabilityStatement.publisher | CodeSystem.publisher | CompartmentDefinition.publisher | ConceptMap.publisher | GraphDefinition.publisher | ImplementationGuide.publisher | MessageDefinition.publisher | NamingSystem.publisher | OperationDefinition.publisher | SearchParameter.publisher | StructureDefinition.publisher | StructureMap.publisher | TerminologyCapabilities.publisher | ValueSet.publisher

        See Also:
        Constant Field Values

      • PUBLISHER

        public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
        Fluent Client search parameter constant for publisher

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement [CodeSystem](codesystem.html): Name of the publisher of the code system [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition [ConceptMap](conceptmap.html): Name of the publisher of the concept map [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition [NamingSystem](namingsystem.html): Name of the publisher of the naming system [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition [SearchParameter](searchparameter.html): Name of the publisher of the search parameter [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition [StructureMap](structuremap.html): Name of the publisher of the structure map [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities [ValueSet](valueset.html): Name of the publisher of the value set
        Type: string
        Path: CapabilityStatement.publisher | CodeSystem.publisher | CompartmentDefinition.publisher | ConceptMap.publisher | GraphDefinition.publisher | ImplementationGuide.publisher | MessageDefinition.publisher | NamingSystem.publisher | OperationDefinition.publisher | SearchParameter.publisher | StructureDefinition.publisher | StructureMap.publisher | TerminologyCapabilities.publisher | ValueSet.publisher

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [OperationDefinition](operationdefinition.html): The current status of the operation definition [SearchParameter](searchparameter.html): The current status of the search parameter [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [ValueSet](valueset.html): The current status of the value set
        Type: token
        Path: CapabilityStatement.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | GraphDefinition.status | ImplementationGuide.status | MessageDefinition.status | NamingSystem.status | OperationDefinition.status | SearchParameter.status | StructureDefinition.status | StructureMap.status | TerminologyCapabilities.status | ValueSet.status

        See Also:
        Constant Field Values

      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [OperationDefinition](operationdefinition.html): The current status of the operation definition [SearchParameter](searchparameter.html): The current status of the search parameter [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [ValueSet](valueset.html): The current status of the value set
        Type: token
        Path: CapabilityStatement.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | GraphDefinition.status | ImplementationGuide.status | MessageDefinition.status | NamingSystem.status | OperationDefinition.status | SearchParameter.status | StructureDefinition.status | StructureMap.status | TerminologyCapabilities.status | ValueSet.status

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement [CodeSystem](codesystem.html): The uri that identifies the code system [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition [ConceptMap](conceptmap.html): The uri that identifies the concept map [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide [MessageDefinition](messagedefinition.html): The uri that identifies the message definition [NamingSystem](namingsystem.html): The uri that identifies the naming system [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition [SearchParameter](searchparameter.html): The uri that identifies the search parameter [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition [StructureMap](structuremap.html): The uri that identifies the structure map [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities [ValueSet](valueset.html): The uri that identifies the value set
        Type: uri
        Path: CapabilityStatement.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | GraphDefinition.url | ImplementationGuide.url | MessageDefinition.url | NamingSystem.url | OperationDefinition.url | SearchParameter.url | StructureDefinition.url | StructureMap.url | TerminologyCapabilities.url | ValueSet.url

        See Also:
        Constant Field Values

      • URL

        public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
        Fluent Client search parameter constant for url

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement [CodeSystem](codesystem.html): The uri that identifies the code system [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition [ConceptMap](conceptmap.html): The uri that identifies the concept map [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide [MessageDefinition](messagedefinition.html): The uri that identifies the message definition [NamingSystem](namingsystem.html): The uri that identifies the naming system [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition [SearchParameter](searchparameter.html): The uri that identifies the search parameter [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition [StructureMap](structuremap.html): The uri that identifies the structure map [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities [ValueSet](valueset.html): The uri that identifies the value set
        Type: uri
        Path: CapabilityStatement.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | GraphDefinition.url | ImplementationGuide.url | MessageDefinition.url | NamingSystem.url | OperationDefinition.url | SearchParameter.url | StructureDefinition.url | StructureMap.url | TerminologyCapabilities.url | ValueSet.url

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The business version of the capability statement [CodeSystem](codesystem.html): The business version of the code system [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition [ConceptMap](conceptmap.html): The business version of the concept map [GraphDefinition](graphdefinition.html): The business version of the graph definition [ImplementationGuide](implementationguide.html): The business version of the implementation guide [MessageDefinition](messagedefinition.html): The business version of the message definition [NamingSystem](namingsystem.html): The business version of the naming system [OperationDefinition](operationdefinition.html): The business version of the operation definition [SearchParameter](searchparameter.html): The business version of the search parameter [StructureDefinition](structuredefinition.html): The business version of the structure definition [StructureMap](structuremap.html): The business version of the structure map [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities [ValueSet](valueset.html): The business version of the value set
        Type: token
        Path: CapabilityStatement.version | CodeSystem.version | CompartmentDefinition.version | ConceptMap.version | GraphDefinition.version | ImplementationGuide.version | MessageDefinition.version | NamingSystem.version | OperationDefinition.version | SearchParameter.version | StructureDefinition.version | StructureMap.version | TerminologyCapabilities.version | ValueSet.version

        See Also:
        Constant Field Values

      • VERSION

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
        Fluent Client search parameter constant for version

        Description: Multiple Resources: [CapabilityStatement](capabilitystatement.html): The business version of the capability statement [CodeSystem](codesystem.html): The business version of the code system [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition [ConceptMap](conceptmap.html): The business version of the concept map [GraphDefinition](graphdefinition.html): The business version of the graph definition [ImplementationGuide](implementationguide.html): The business version of the implementation guide [MessageDefinition](messagedefinition.html): The business version of the message definition [NamingSystem](namingsystem.html): The business version of the naming system [OperationDefinition](operationdefinition.html): The business version of the operation definition [SearchParameter](searchparameter.html): The business version of the search parameter [StructureDefinition](structuredefinition.html): The business version of the structure definition [StructureMap](structuremap.html): The business version of the structure map [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities [ValueSet](valueset.html): The business version of the value set
        Type: token
        Path: CapabilityStatement.version | CodeSystem.version | CompartmentDefinition.version | ConceptMap.version | GraphDefinition.version | ImplementationGuide.version | MessageDefinition.version | NamingSystem.version | OperationDefinition.version | SearchParameter.version | StructureDefinition.version | StructureMap.version | TerminologyCapabilities.version | ValueSet.version