Generated Narrative: OperationDefinition DTR-ValueSet-expand

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

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

 <status value="active"/> <kind value="operation"/> <date value="2025-07-14T08:00:00+11:00"/> <publisher value="HL7 International / Clinical Decision Support"/> <contact> <name value="HL7 International / Clinical Decision Support"/> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/dss"/> </telecom> </contact> <description value="The definition of a value set is used to create a simple collection of codes suitable for use for data entry or validation. §oper-4^dtr-client^exchange:The operation is called at the resource level and a url **SHALL** be provided.§ §oper-5^dtr-server^exchange: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`](https://hl7.org/fhir/R4/operation-valueset-expand.html) operation definition."/> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="US"/> </coding> </jurisdiction> <code value="expand"/> <base value="http://hl7.org/fhir/OperationDefinition/ValueSet-expand"/> <resource value="ValueSet"/> <system value="false"/> <type value="true"/> <instance value="false"/> <parameter> <name value="url"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="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 value="uri"/> </parameter> <parameter> <name value="filter"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="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"/> <type value="string"/> </parameter> <parameter> <name value="return"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="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 value="ValueSet"/> </parameter> </OperationDefinition>