Da Vinci - Documentation Templates and Rules
2.2.0-ballot - STU 2.2 - Ballot United States of America flag

Da Vinci - Documentation Templates and Rules, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-dtr/ and changes regularly. See the Directory of published versions

OperationDefinition: DTR Value Set Expansion

Official URL: http://hl7.org/fhir/us/davinci-dtr/OperationDefinition/DTR-ValueSet-expand Version: 2.2.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: DTRValuesetExpansion

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.

For more details regarding this operation, see the FHIR R4 $expand operation definition.

URL: [base]/ValueSet/$expand

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INurl1..1uri

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

INfilter0..1string

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:

  • using left matching e.g. "acut ast"
  • allowing for wild cards such as %, &, ?
  • searching on definition as well as display(s)
  • allowing for search conditions (and / or / exclusions)

Text 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

INoffset0..1integer

Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages)

OUTreturn1..1ValueSet

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