GAO Ballot Package

This page is part of the FHIR Specification (v1.1.0: STU 3 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

This is a frozen snapshot of the FHIR specification created for the purpose of balloting the GAO implementation Guide. It includes draft changes that may be part of the future DSTU 2.1 release but further change is expected. Readers should focus solely on the GAO implementation content, and FHIR DSTU 2 for other purposes.

Extension: An allowable parameter combination

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination

Status: draft. Extension maintained by: Health Level Seven, Inc. - [WG Name] WG

A container for a single allowable parameter combination.

Context of Use: Use on element: Conformance.rest.resource

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination
An allowable parameter combination: A container for a single allowable parameter combination.
Use on element: Conformance.rest.resource
... required1..*stringA search parameter name in the combination which is required.
... optional0..*stringA search parameter name in the combination which is optional.

doco Documentation for this format

Fulle Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination
An allowable parameter combination: A container for a single allowable parameter combination.
Use on element: Conformance.rest.resource
... extension 1..*ExtensionA required search parameter name
.... extension 0..0
.... url 1..1uri"required"
.... valueString 1..1stringValue of extension
... extension 0..*ExtensionAn optional search parameter name
.... extension 0..0
.... url 1..1uri"optional"
.... valueString 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- An allowable parameter combination -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="required"> 1..* Extension  <!-- 1..* A required search parameter name -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="optional"> 0..* Extension  <!-- 0..* An optional search parameter name -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // An allowable parameter combination
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // A required search parameter name // R! 
        // from Element: extension
        "url" : "required", // R! 
        "valueString" : "<string>" // R! Value of extension
      },
      { // An optional search parameter name //
        // from Element: extension
        "url" : "optional", // R! 
        "valueString" : "<string>" // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination", // R! 
// value[x]: Value of extension. One of these 33:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination
An allowable parameter combination: A container for a single allowable parameter combination.
Use on element: Conformance.rest.resource
... required1..*stringA search parameter name in the combination which is required.
... optional0..*stringA search parameter name in the combination which is optional.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination
An allowable parameter combination: A container for a single allowable parameter combination.
Use on element: Conformance.rest.resource
... extension 1..*ExtensionA required search parameter name
.... extension 0..0
.... url 1..1uri"required"
.... valueString 1..1stringValue of extension
... extension 0..*ExtensionAn optional search parameter name
.... extension 0..0
.... url 1..1uri"optional"
.... valueString 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- An allowable parameter combination -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="required"> 1..* Extension  <!-- 1..* A required search parameter name -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="optional"> 0..* Extension  <!-- 0..* An optional search parameter name -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // An allowable parameter combination
    "extension" : [ //  sliced by url  in the specified orderOpen
      { // A required search parameter name // R! 
        // from Element: extension
        "url" : "required", // R! 
        "valueString" : "<string>" // R! Value of extension
      },
      { // An optional search parameter name //
        // from Element: extension
        "url" : "optional", // R! 
        "valueString" : "<string>" // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination", // R! 
// value[x]: Value of extension. One of these 33:
  }