Conformance
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
R3
| FHIR Infrastructure Work Group | Maturity Level : N/A | Standards Status : Informative |
|
Raw XML ( canonical form + also see XML Format Specification )
Operation Definition
<?xml version="1.0" encoding="UTF-8"?>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 The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point) The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code<OperationDefinition xmlns="http://hl7.org/fhir"> <id value="CapabilityStatement-subset"/> <text> <status value="extensions"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p> URL: [base]/CapabilityStatement/$subset</p> <p> URL: [base]/CapabilityStatement/[id]/$subset</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> IN</td> <td> server</td> <td> type, system</td> <td> 0..1</td> <td> <a href="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="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="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> <url value="http://hl7.org/fhir/OperationDefinition/CapabilityStatement-subset"/> <version value="5.0.0"/> <name value="Subset"/> <title value="Fetch a subset of the CapabilityStatement resource"/> <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="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 The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point) The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code- 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 >
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.
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R5
hl7.fhir.core#5.0.0
generated
on
Fri,
Nov
1,
2019
09:34+1100.
QA
Page
Sun,
Mar
26,
2023
15:24+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R4B
|
|
Propose
a
change