Release 4B Snapshot #1

This page is part of the FHIR Specification (v4.3.0-snapshot1: Release 4B Snapshot #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 . Page versions: R5 R4B R4

Operation-capabilitystatement-versions.xml

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

Raw XML (canonical form + also see XML Format Specification)

Jump past Narrative

Operation Definition

<?xml version="1.0" encoding="UTF-8"?>

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="CapabilityStatement-versions"/> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> versions</h2> 
      <p> OPERATION: versions</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/CapabilityStatement-versions</pre> 
      <div> 
        <p> Using the 
          <a href="http.html#version-parameter">FHIR Version Mime Type Parameter</a> , a server can support 
          <a href="versioning.html#mt-version">multiple versions on the same end-point</a> . The only way for client to find out what versions a server supports in this fashion
           is the $versions operation. The client invokes the operation with no parameters. and the
           server returns the list of supported versions, along with the default version it will
           use if no fhirVersion parameter is present
        </p> 

      </div> 
      <p> URL: [base]/$versions</p> 
      <p> Parameters</p> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Use</b> 
          </td> 
          <td> 
            <b> Name</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> OUT</td> 
          <td> version</td> 
          <td> 1..*</td> 
          <td> 
            <a href="datatypes.html#code">code</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> A version supported by the server. Use the major.minor version like 3.0</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> default</td> 
          <td> 1..1</td> 
          <td> 
            <a href="datatypes.html#code">code</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The default version for the server. Use the major.minor version like 3.0</p> 

            </div> 
          </td> 
        </tr> 
      </table> 
      <div/>  
    </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> 
  <url value="http://hl7.org/fhir/OperationDefinition/CapabilityStatement-versions"/> 
  <version value="4.3.0-snapshot1"/> 
  <name value="versions"/> 
  <title value="Discover what versions a server supports"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2021-12-20T14:08:35+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="Using the [FHIR Version Mime Type Parameter](http.html#version-parameter), a server can
   support [multiple versions on the same end-point](versioning.html#mt-version). The only
   way for client to find out what versions a server supports in this fashion is the $versions
   operation. The client invokes the operation with no parameters. and the server returns
   the list of supported versions, along with the default version it will use if no fhirVersion
   parameter is present"/> 
  <affectsState value="false"/> 
  <code value="versions"/> 
  <resource value="CapabilityStatement"/> 
  <system value="true"/> 
  <type value="false"/> 
  <instance value="false"/> 
  <parameter> 
    <name value="version"/> 
    <use value="out"/> 
    <min value="1"/> 
    <max value="*"/> 
    <documentation value="A version supported by the server. Use the major.minor version like 3.0"/> 
    <type value="code"/> 
  </parameter> 
  <parameter> 
    <name value="default"/> 
    <use value="out"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="The default version for the server. Use the major.minor version like 3.0"/> 
    <type value="code"/> 
  </parameter> 
</OperationDefinition> 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.