FHIR Application Feature Framework Implementation Guide, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/capstmt/ and changes regularly. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Fetch a subset of the CapabilityStatement resource - XML Representation

Raw xml | Download

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="CapabilityStatement-subset"/>
  <meta>
    <lastUpdated value="2021-01-05T10:01:24.148+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition CapabilityStatement-subset</b></p><a name="CapabilityStatement-subset"> </a><a name="hcCapabilityStatement-subset"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Last updated: 2021-01-05 10:01:24+1100</p></div><p>URL: [base]/CapabilityStatement/$subset</p><p>URL: [base]/CapabilityStatement/[id]/$subset</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>server</td><td>type, system</td><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#uri">uri</a></td><td/><td><div><p>The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point)</p>
</div></td></tr><tr><td>IN</td><td>resource</td><td/><td>1..*</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td/><td><div><p>A resource that the client would like to include in the return</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/capabilitystatement.html">CapabilityStatement</a></td><td/><td><div><p>The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code</p>
</div></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/>
  </extension>
  <extension url="http://hl7.org/fhir/build/StructureDefinition/example">
    <extension url="list">
      <valueString value="1"/>
    </extension>
    <extension url="response">
      <valueBoolean value="false"/>
    </extension>
    <extension url="content">
      <valueString value="$subset-request.txt"/>
    </extension>
  </extension>
  <extension url="http://hl7.org/fhir/build/StructureDefinition/example">
    <extension url="list">
      <valueString value="1"/>
    </extension>
    <extension url="response">
      <valueBoolean value="true"/>
    </extension>
    <extension url="content">
      <valueString value="$subset-response.txt"/>
    </extension>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/>
  </extension>
  <url
       value="http://hl7.org/fhir/build/OperationDefinition/CapabilityStatement-subset"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.32.6"/>
  </identifier>
  <version value="1.0.0"/>
  <name value="Subset"/>
  <title value="Fetch a subset of the CapabilityStatement resource"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2021-01-05T10:01:24+11:00"/>
  <publisher value="HL7 International / FHIR Infrastructure"/>
  <contact>
    <name value="HL7 International / FHIR Infrastructure"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fiwg"/>
    </telecom>
  </contact>
  <description
               value="This operation asks the server to return a subset of the CapabilityStatement resource - just the REST parts that relate to a set of nominated resources - the resources that the client is interested in"/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <affectsState value="false"/>
  <code value="subset"/>
  <resource value="CapabilityStatement"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="server"/>
    <use value="in"/>
    <scope value="type"/>
    <scope value="system"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point)"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="resource"/>
    <use value="in"/>
    <min value="1"/>
    <max value="*"/>
    <documentation
                   value="A resource that the client would like to include in the return"/>
    <type value="code"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code"/>
    <type value="CapabilityStatement"/>
  </parameter>
</OperationDefinition>