Class ValueSet

  • 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 ValueSet
    extends MetadataResource
    A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
      • immutable

        protected BooleanType immutable
        If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
      • purpose

        protected MarkdownType purpose
        Explanation of why this value set is needed and why it has been designed as it has.
      • copyright

        protected MarkdownType copyright
        A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
      • compose

        protected ValueSet.ValueSetComposeComponent compose
        A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).
      • expansion

        protected ValueSet.ValueSetExpansionComponent expansion
        A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: The value set publication date
        Type: date
        Path: 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: The value set publication date
        Type: date
        Path: ValueSet.date

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: External identifier for the value set
        Type: token
        Path: ValueSet.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

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

        Description: External identifier for the value set
        Type: token
        Path: ValueSet.identifier

      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

        Description: This special parameter searches for codes in the value set. See additional notes on the ValueSet resource
        Type: token
        Path: ValueSet.expansion.contains.code, ValueSet.compose.include.concept.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: This special parameter searches for codes in the value set. See additional notes on the ValueSet resource
        Type: token
        Path: ValueSet.expansion.contains.code, ValueSet.compose.include.concept.code

      • 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: A use context type and value assigned to the value set
        Type: composite
        Path:

      • SP_JURISDICTION

        public static final String SP_JURISDICTION
        Search parameter: jurisdiction

        Description: Intended jurisdiction for the value set
        Type: token
        Path: ValueSet.jurisdiction

        See Also:
        Constant Field Values
      • JURISDICTION

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

        Description: Intended jurisdiction for the value set
        Type: token
        Path: ValueSet.jurisdiction

      • SP_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: description

        Description: The description of the value set
        Type: string
        Path: 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: The description of the value set
        Type: string
        Path: ValueSet.description

      • SP_CONTEXT_TYPE

        public static final String SP_CONTEXT_TYPE
        Search parameter: context-type

        Description: A type of use context assigned to the value set
        Type: token
        Path: 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: A type of use context assigned to the value set
        Type: token
        Path: ValueSet.useContext.code

      • SP_TITLE

        public static final String SP_TITLE
        Search parameter: title

        Description: The human-friendly name of the value set
        Type: string
        Path: ValueSet.title

        See Also:
        Constant Field Values
      • TITLE

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

        Description: The human-friendly name of the value set
        Type: string
        Path: ValueSet.title

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

        Description: The business version of the value set
        Type: token
        Path: 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: The business version of the value set
        Type: token
        Path: ValueSet.version

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: The uri that identifies the value set
        Type: uri
        Path: 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: The uri that identifies the value set
        Type: uri
        Path: ValueSet.url

      • SP_EXPANSION

        public static final String SP_EXPANSION
        Search parameter: expansion

        Description: Identifies the value set expansion (business identifier)
        Type: uri
        Path: ValueSet.expansion.identifier

        See Also:
        Constant Field Values
      • EXPANSION

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

        Description: Identifies the value set expansion (business identifier)
        Type: uri
        Path: ValueSet.expansion.identifier

      • SP_REFERENCE

        public static final String SP_REFERENCE
        Search parameter: reference

        Description: A code system included or excluded in the value set or an imported value set
        Type: uri
        Path: ValueSet.compose.include.system

        See Also:
        Constant Field Values
      • REFERENCE

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

        Description: A code system included or excluded in the value set or an imported value set
        Type: uri
        Path: ValueSet.compose.include.system

      • SP_CONTEXT_QUANTITY

        public static final String SP_CONTEXT_QUANTITY
        Search parameter: context-quantity

        Description: A quantity- or range-valued use context assigned to the value set
        Type: quantity
        Path: ValueSet.useContext.valueQuantity, ValueSet.useContext.valueRange

        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: A quantity- or range-valued use context assigned to the value set
        Type: quantity
        Path: ValueSet.useContext.valueQuantity, ValueSet.useContext.valueRange

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: Computationally friendly name of the value set
        Type: string
        Path: 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: Computationally friendly name of the value set
        Type: string
        Path: ValueSet.name

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: A use context assigned to the value set
        Type: token
        Path: ValueSet.useContext.valueCodeableConcept

        See Also:
        Constant Field Values
      • CONTEXT

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

        Description: A use context assigned to the value set
        Type: token
        Path: ValueSet.useContext.valueCodeableConcept

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

        Description: Name of the publisher of the value set
        Type: string
        Path: 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: Name of the publisher of the value set
        Type: string
        Path: ValueSet.publisher

      • SP_CONTEXT_TYPE_QUANTITY

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

        Description: A use context type and quantity- or range-based value assigned to the value set
        Type: composite
        Path:

        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: A use context type and quantity- or range-based value assigned to the value set
        Type: composite
        Path:

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: The current status of the value set
        Type: token
        Path: 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: The current status of the value set
        Type: token
        Path: ValueSet.status