Operation
Definition
{
"resourceType" : "OperationDefinition",
"id" : "CapabilityStatement-versions",
"text" : {
"status" : "extensions",
"div" : "<div>!-- Snipped for Brevity --></div>"
"div" : "<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>\n</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>\n</div></td></tr></table></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/OperationDefinition/CapabilityStatement-versions",
"version" : "4.3.0",
"version" : "5.0.0-draft-final",
"name" : "Versions",
"title" : "Discover what versions a server supports",
"status" : "draft",
"kind" : "operation",
"experimental" : false,
"date" : "2022-05-28T12:47:40+10:00",
"date" : "2023-03-01T23:03:57+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "fhir@lists.hl7.org"
}]
}],
"description" : "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" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}]
}],
"affectsState" : false,
"code" : "versions",
"resource" : ["CapabilityStatement"],
"system" : true,
"type" : false,
"instance" : false,
"parameter" : [{
"name" : "version",
"use" : "out",
"min" : 1,
"max" : "*",
"documentation" : "A version supported by the server. Use the major.minor version like 3.0",
"type" : "code"
},
{
"name" : "default",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "The default version for the server. Use the major.minor version like 3.0",
"type" : "code"
"type" : "code",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|5.0.0-draft-final"
}
}]
}
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.