FHIR IG Statistics: OperationDefinition/DTR-ValueSet-expand

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

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

Source

{
  "resourceType": "OperationDefinition",
  "id": "DTR-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/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 2,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/davinci-dtr/OperationDefinition/DTR-ValueSet-expand",
  "version": "2.2.0-ballot",
  "name": "DTRValuesetExpansion",
  "title": "DTR Value Set Expansion",
  "status": "active",
  "kind": "operation",
  "date": "2025-07-14T08:00:00+11:00",
  "publisher": "HL7 International / Clinical Decision Support",
  "contact": [
    {
      "name": "HL7 International / Clinical Decision Support",
      "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. The operation is called at the system level and a url **SHALL** be provided.  Additionally, the valueset **SHALL** use the current date as the expansion date and **SHALL** include only active codes. An expanded value set will be returned, or an OperationOutcome with an error message. \n\nFor more details regarding this operation, see the FHIR R4 [`$expand`](https://hl7.org/fhir/R4/operation-valueset-expand.html) operation definition.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "code": "expand",
  "base": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand",
  "resource": [
    "ValueSet"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "url",
      "use": "in",
      "min": 1,
      "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": "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.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": "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": "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"
    }
  ]
}