Operation-valueset-expand.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "ValueSet-expand",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand",
  "name": "Value Set Expansion",
  "status": "draft",
  "kind": "operation",
  "date": "2016-12-06T12:22:34+11:00",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "The definition of a value set is used to create a simple collection of codes suitable for use for data entry or validation.   If the operation is not called at the instance level, one of the in parameters identifier, context or valueset must be provided.  An expanded value set will be returned, or an OperationOutcome with an error message.",
  "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 will 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. 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](extension-valueset-unclosed.html) can be used to indicate that the expansion is incomplete",
  "resource": [
    "ValueSet"
  ],
  "system": false,
  "type": true,
  "instance": true,
  "parameter": [
    {
      "name": "identifier",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A logical value set identifier (i.e. ValueSet.url). 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": "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 useable if the terminology server also has access to the profile 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": "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",
      "type": "string"
    },
    {
      "name": "profile",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A reference to an external definition that provides additional control information about how the expansion is performed.  At this time, there is no agreed format or functionality for the target of this URI. The [VSAC Documentation](http://www.nlm.nih.gov/vsac/support/authorguidelines/updatingvaluesets.html) provides one example of the use of this parameter.  Implementers using this element will need to agree on an appropriate mechanism for use within their interoperability community.  Known uses for profile include: * whether to return the value set content logical definition with the expansion * whether to include inactive concepts",
      "type": "uri"
    },
    {
      "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. Overrides the value in the expansion profile if there is one",
      "type": "boolean"
    },
    {
      "name": "includeDefinition",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Controls whether the value set definition is included or excluded in value set expansions. Overrides the value in the expansion profile if there is one",
      "type": "boolean"
    },
    {
      "name": "activeOnly",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Controls whether inactive concepts are included or excluded in value set expansions. Overrides the value in the expansion profile if there is one. 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). Overrides the value in the expansion profile if there is one",
      "type": "boolean"
    },
    {
      "name": "excludeNotForUI",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces. Overrides the value in the expansion profile if there is one",
      "type": "boolean"
    },
    {
      "name": "excludePostCoordinated",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Controls whether or not the value set expansion includes post coordinated codes. Overrides the value in the expansion profile if there is one",
      "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. Overrides the value in the expansion profile if there is one",
      "type": "code"
    },
    {
      "name": "limitedExpansion",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete. Overrides the value in the expansion profile if there is one",
      "type": "boolean"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The result of the expansion",
      "type": "ValueSet"
    }
  ]
}