Release 4 5

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0: R5 - Mixed Normative and STU ) ). This is the current published version in it's permanent home (it will always be available at this URL). 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

Example OperationDefinition/CapabilityStatement-versions (XML)

FHIR Infrastructure Work Group Maturity Level : N/A Standards Status : Informative Compartments : 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"?>


  
  
    
    
      
      
      
      
      
        Using the 
          , a server can support 
          . 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
        

      
      
      
      
        
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
        
        
          
          
          
          
            
          
          
          
            
              

            
          
        
        
          
          
          
          
            
          
          
          
            
              

            
          
        
      
      
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
  
    
      
      
    
    
      
      
    
  
  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
  
  
  
  
  
  
    
    
    
    
    
    
  
  
    
    
    
    
    
    
  

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="CapabilityStatement-versions"/> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> URL: [base]/$versions</p> 
      <p> Parameters</p> 
      <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> OUT</td> 
          <td> version</td> 
          <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/>  
          <td> 1..1</td> 
          <td> 
            <a href="datatypes.html#code">code</a> 
          </td> 
          <td> 
            <a href="valueset-FHIR-version.html">FHIRVersion</a>  (Required)
          </td> 
          <td> 
            <div> 
              <p> The default version for the server. Use the major.minor version like 3.0</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> 
  <url value="http://hl7.org/fhir/OperationDefinition/CapabilityStatement-versions"/> 
  <version value="5.0.0"/> 
  <name value="Versions"/> 
  <title value="Discover what versions a server supports"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <experimental value="false"/> 
  <date value="2023-03-26T15:21:02+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"/> 
  <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="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"/>     <binding>       <strength value="required"/>       <valueSet value="http://hl7.org/fhir/ValueSet/FHIR-version|5.0.0"/>     </binding>   </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.