FHIR IG Statistics: OperationDefinition/crmi-valueset-expand

Resources that use this resource

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType": "OperationDefinition",
  "id": "crmi-valueset-expand",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cds"
    }
  ],
  "url": "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-valueset-expand",
  "version": "2.0.0-cibuild",
  "name": "CRMIValueSetExpand",
  "title": "CRMI Extension of Value Set Expansion",
  "status": "active",
  "kind": "operation",
  "date": "2025-07-25T17:10:20+00:00",
  "publisher": "HL7 International / Clinical Decision Support",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description": "The definition of a value set is used to create a simple collection of codes suitable for use for data entry or validation. \n\nIf the operation is not called at the instance level, one of the in parameters url, context or valueSet must be provided.  An expanded value set will be returned, or an OperationOutcome with an error message.\n\nThis CRMI Extension adds support for providing value set versions, as well as the use of a manifest (parameters or library) to provide system and value set versions for references encountered during the expansion.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "affectsState": false,
  "code": "expand",
  "comment": "The value set expansion returned by this query should be treated as a transient result that will change over time (whether it does or not depends on how the value set is specified), so applications should repeat the operation each time the value set is used.  \n\nIf the expansion is too large (at the discretion of the server), the server MAY return an error (OperationOutcome with code too-costly). Clients can work through large flat expansions in a set of pages (partial views of the full expansion) instead of just getting the full expansion in a single exchange by using offset and count parameters, or use the count parameter to request a subset of the expansion for limited purposes. Servers are not obliged to support paging, but if they do, SHALL support both the offset and count parameters. Hierarchical expansions are not subject to paging and servers simply return the entire expansion.  \n\nDifferent servers may return different results from expanding a value set for the following reasons:  \n\n* The underlying code systems are different (e.g. different versions, possibly with different defined behavior) \n* The server optimizes filter includes differently, such as sorting by code frequency \n* Servers introduce arbitrary groups to assist a user to navigate the lists based either on extensions in the definition, or additional knowledge available to the server\n\nWhen a server cannot correctly expand a value set because it does not fully understand the code systems (e.g. it has the wrong version, or incomplete definitions) then it SHALL return an error. If the value set itself is unbounded due to the inclusion of post-coordinated value sets (e.g. SNOMED CT, UCUM), then the extension [http://hl7.org/fhir/StructureDefinition/valueset-unclosed](http://hl7.org/fhir/StructureDefinition/valueset-unclosed) can be used to indicate that the expansion is incomplete",
  "base": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand",
  "resource": [
    "ValueSet"
  ],
  "system": false,
  "type": true,
  "instance": true,
  "parameter": [
    {
      "name": "url",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A canonical reference to a value set. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server",
      "type": "uri"
    },
    {
      "name": "valueSet",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion",
      "type": "ValueSet"
    },
    {
      "name": "valueSetVersion",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The identifier that is used to identify a specific version of the value set to be used when generating the expansion. This is an arbitrary value managed by the value set 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. This parameter cannot be used at the same time as includeDraft. If a version identifier is provided, the expansion is performed regardless of the status of the resource.",
      "type": "string"
    },
    {
      "name": "context",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The context of the value set, so that the server can resolve this to a value set to expand. The recommended format for this URI is [Structure Definition URL]#[name or path into structure definition] e.g. http://hl7.org/fhir/StructureDefinition/observation-hspc-height-hspcheight#Observation.interpretation. Other forms may be used but are not defined. This form is only usable if the terminology server also has access to the conformance registry that the server is using, but can be used to delegate the mapping from an application context to a binding at run-time",
      "type": "uri"
    },
    {
      "name": "contextDirection",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "If a context is provided, a context direction may also be provided. Valid values are: \n\n* 'incoming': the codes a client can use for PUT/POST operations,  and \n* 'outgoing', the codes a client might receive from the server.\n\nThe purpose is to inform the server whether to use the value set associated with the context for reading or writing purposes (note: for most elements, this is the same value set, but there are a few elements where the reading and writing value sets are different)",
      "type": "code"
    },
    {
      "name": "filter",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A text filter that is applied to restrict the codes that are returned (this is useful in a UI context). The interpretation of this is delegated to the server in order to allow to determine the most optimal search approach for the context. The server can document the way this parameter works in [TerminologyCapabilities](capabilities.html)..expansion.textFilter. Typical usage of this parameter includes functionality like:\n\n* using left matching e.g. \"acut ast\"\n* allowing for wild cards such as %, &, ?\n* searching on definition as well as display(s)\n* allowing for search conditions (and / or / exclusions)\n\nText Search engines such as Lucene or Solr, long with their considerable functionality, might also be used. The optional text search might also be code system specific, and servers might have different implementations for different code systems",
      "type": "string"
    },
    {
      "name": "date",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The date for which the expansion should be generated.  if a date is provided, it means that the server should use the value set / code system definitions as they were on the given date, or return an error if this is not possible.  Normally, the date is the current conditions (which is the default value) but under some circumstances, systems need to generate an expansion as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.",
      "type": "dateTime"
    },
    {
      "name": "offset",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages)",
      "type": "integer"
    },
    {
      "name": "count",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Paging support - how many codes should be provided in a partial page view. Paging only applies to flat expansions - servers ignore paging if the expansion is not flat.  If count = 0, the client is asking how large the expansion is. Servers SHOULD honor this request for hierarchical expansions as well, and simply return the overall count",
      "type": "integer"
    },
    {
      "name": "includeDesignations",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Controls whether concept designations are to be included or excluded in value set expansions",
      "type": "boolean"
    },
    {
      "name": "designation",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "A [token](https://www.hl7.org/fhir/search.html#token) that specifies a system+code that is either a use or a language. Designations that match by language or use are included in the expansion. If no designation is specified, it is at the server discretion which designations to return",
      "type": "string"
    },
    {
      "name": "includeDefinition",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Controls whether the value set definition is included or excluded in value set expansions. This includes all elements of the ValueSet, including extensions, with the exception that the `id` and `meta` elements would be specific to the expansion, not to the definition of the value set, and the expansion itself is filled out.",
      "type": "boolean"
    },
    {
      "name": "activeOnly",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Controls whether inactive concepts are included or excluded in value set expansions. Note that if the value set explicitly specifies that inactive codes are included, this parameter can still remove them from a specific expansion, but this parameter cannot include them if the value set excludes them",
      "type": "boolean"
    },
    {
      "name": "excludeNested",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains)",
      "type": "boolean"
    },
    {
      "name": "excludeNotForUI",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Controls whether or not the value set expansion is assembled for a user interface use or not. Value sets intended for User Interface might include ['abstract' codes](https://www.hl7.org/fhir/codesystem.html#status) or have nested contains with items with no code or abstract = true, with the sole purpose of helping a user navigate through the list efficiently, where as a value set not generated for UI use might be flat, and only contain the selectable codes in the value set. The exact implications of 'for UI' depend on the code system, and what properties it exposes for a terminology server to use. In the FHIR Specification itself, the value set expansions are generated with excludeNotForUI = false, and the expansions used when generated schema / code etc, or performing validation, are all excludeNotForUI = true.",
      "type": "boolean"
    },
    {
      "name": "excludePostCoordinated",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Controls whether or not the value set expansion includes post coordinated codes",
      "type": "boolean"
    },
    {
      "name": "displayLanguage",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display",
      "type": "code"
    },
    {
      "name": "exclude-system",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Code system, or a particular version of a code system to be excluded from the value set expansion. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56",
      "type": "canonical"
    },
    {
      "name": "system-version",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "(Deprecated, use default-system-version). Specifies a version to use for a system, if the value set does not specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56",
      "type": "canonical"
    },
    {
      "name": "default-system-version",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Specifies a version to use for a system, if the value set does not specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56",
      "type": "canonical"
    },
    {
      "name": "check-system-version",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Edge Case: Specifies a version to use for a system. If a value set specifies a different version, an error is returned instead of the expansion. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56",
      "type": "canonical"
    },
    {
      "name": "force-system-version",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Edge Case: Specifies a version to use for a system. This parameter overrides any specified version in the value set (and any it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly. It primarily exists to deal with situations where specifications have fallen into decay as time passes. If the value is override, the version used SHALL explicitly be represented in the expansion parameters",
      "type": "canonical"
    },
    {
      "name": "manifest",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Specifies a manifest library that provides expansion rules for the operation. See the description of manifest library for a complete description of how manifest values are used to provide defaults for expansion parameters. Parameters specified directly in an $expand operation override behaviors specified by the manifest parameter. It is an error to supply both a manifest and a manifestParameters.",
      "type": "canonical",
      "targetProfile": [
        "http://hl7.org/fhir/StructureDefinition/Library"
      ]
    },
    {
      "name": "manifestParameters",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Specifies manifest parameters that provide expansion rules for the operation. See the description of manifest parameters for a complete description of how manifest values are used to provide defaults for expansion parameters. Parameters specified directly in an $expand operation override behaviors specified by the manifest parameter. It is an error to supply both a manifest and a manifestParameters.",
      "type": "Parameters"
    },
    {
      "name": "includeDraft",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Indicates that draft versions of the value set should be considered when determining the version of the value set to be used to perform the expand. If one (or more) draft versions exist, the $expand operation should use the latest draft to create the expansion. This parameter cannot be used at the same time as the valueSetVersion parameter. If a draft version does not exist, then the service should use the latest published (status=Active) version.",
      "type": "boolean"
    },
    {
      "name": "lastActiveVersion",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Indicates that if a code explicitly named in the definition is not active in the current (or requested) version of the code system for the expansion, that it should be included in the expansion with the version of the code system in which it was last active.\n\nServers MAY choose to throw an exception if asked to provide last active version and they do not support this capability.\n\nlastActiveVersion is different than setting activeOnly to false, in that the activeOnly flag will return the code in the expansion with the inactive flag set and the version set to the current (or requested) version of the code system.\n\nlastActiveVersion can only be used with activeOnly = false, setting lastActiveVersion when activeOnly is true has no effect (i.e. codes are only included if they are active in the current (or requested) version of the code system.\n\nlastActiveVersion is useful for code system management, especially when setting up code system content for value sets that need to be supported. The activeOnly flag does not give implementers enough information to really validate codes. Conversely, activeOnly is useful for systems that are already managing code system content completely and do not depend on the value sets for code information or validation.",
      "type": "boolean"
    },
    {
      "name": "default-valueset-version",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Specifies a version to use for a value set if the artifact referencing the value set does not already specify a version. The format is the same as a canonical URL: [url]|[version] - e.g. http://example.org/ValueSet/example|1.0.0.",
      "type": "canonical"
    },
    {
      "name": "check-valueset-version",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Edge Case: Specifies a version to use for a value set. If the artifact referencing the resource specifies a different version, an error is returned instead of the package. The format is the same as a canonical URL: [url]|[version] - e.g. http://example.org/ValueSet/example|1.0.0.",
      "type": "canonical"
    },
    {
      "name": "force-valueset-version",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Edge Case: Specifies a version to use for a value set. This parameter overrides any specified version in the artifact (and any artifacts it depends on). The format is the same as a canonical URL: [url]|[version] - e.g. http://example.org/ValueSet/example|1.0.0.",
      "type": "canonical"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The result of the expansion. Servers generating expansions SHOULD ensure that all the parameters that affect the contents of the expansion are recorded in the ValueSet.expansion.parameter list",
      "type": "ValueSet"
    }
  ]
}