Conformance
This
page
is
part
of
the
Snapshot
#3
for
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
R5
,
released
to
support
Connectathon
32
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
|
|
Maturity Level : N/A |
|
Raw XML ( canonical form + also see XML Format Specification )
Operation
Definition
for
Value
SetJurisdiction
ValueSet
<?xml version="1.0" encoding="UTF-8"?> <OperationDefinition xmlns="http://hl7.org/fhir"> <id value="CapabilityStatement-implements"/> <text> <status value="extensions"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> URL: [base]/CapabilityStatement/$implements</p> <p> URL: [base]/CapabilityStatement/[id]/$implements</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> IN</td> <td> server</td> <td> 0..1</td> <td> <a href="datatypes.html#canonical">canonical</a> </td> <td/> <td> <div> <p> A canonical reference to the server capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)</p> </div> </td> </tr> <tr> <td> IN</td> <td> client</td> <td> 0..1</td> <td> <a href="datatypes.html#canonical">canonical</a> </td> <td/> <td> <div> <p> A canonical reference to the client capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)</p> </div> </td> </tr> <tr> <td> IN</td> <td> resource</td> <td> 0..1</td> <td> <a href="capabilitystatement.html">CapabilityStatement</a> </td> <td/> <td> <div> <p> The client capability statement, provided inline</p> </div> </td> </tr> <tr> <td> OUT</td> <td> return</td> <td> 1..1</td> <td> <a href="operationoutcome.html">OperationOutcome</a> </td> <td/> <td> <div> <p> Outcome of the CapabilityStatement test</p> </div> </td> </tr> </table> <div>This value set defines a base set of codes for country and region, for indicating where a resource is intended to be used<p> The operation does not perform a full conformance check; in particular it does not check that the profiles align. It merely checks that the behaviors the client wishes to use are provided Technically, this operation is implemented as follows:</p> <ul> <li> The server's capability statement must have an entry for each resource in the client's capability statement</li> <li> The server's resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalPatch, conditionalDelete, searchInclude, searchRevInclude</li> <li> The server's capability statement must have a matching interaction for each interaction in the client capability statement (whether or not it is on a resource)</li> <li> The server's capability statement must have a search parameter with matching name and definition for any search parameters in the client capability statement</li> <li> The server must have an operation definition with a matching reference for any operations in the client capability statement</li> </ul> <p> If the capability statements match by these rules, then the return value is a 200 OK with an operation outcome that contains no issues with severity >= error. If the capability statement doesn't match, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error</p> </div>Include all codes defined in Include codes from where class = region Import all the codes that are contained in</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-implements"/> <version value="5.0.0-snapshot3"/> <name value="Implements"/> <title value="Test if a server implements a client's required operations"/> <status value="draft"/> <kind value="operation"/> <experimental value="false"/> <date value="2022-12-14T07:12:54+11:00"/> <publisher value="HL7 (FHIR Project)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/>This value set defines a base set of codes for country and region, for indicating where a resource is intended to be used</telecom> <telecom> <system value="email"/> <value value="fhir@lists.hl7.org"/> </telecom> </contact> <description value="This operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in its capability statement. The client provides its capability statement inline, or by referring the server to the canonical URL of its capability statement"/> <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="implements"/> <comment value="The operation does not perform a full conformance check; in particular it does not check that the profiles align. It merely checks that the behaviors the client wishes to use are provided Technically, this operation is implemented as follows: * The server's capability statement must have an entry for each resource in the client's capability statement * The server's resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalPatch, conditionalDelete, searchInclude, searchRevInclude * The server's capability statement must have a matching interaction for each interaction in the client capability statement (whether or not it is on a resource) * The server's capability statement must have a search parameter with matching name and definition for any search parameters in the client capability statement * The server must have an operation definition with a matching reference for any operations in the client capability statement If the capability statements match by these rules, then the return value is a 200 OK with an operation outcome that contains no issues with severity >= error. If the capability statement doesn't match, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error"/> <resource value="CapabilityStatement"/> <system value="false"/> <type value="true"/> <instance value="true"/> <parameter> <name value="server"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="A canonical reference to the server capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)"/> <type value="canonical"/> </parameter> <parameter> <name value="client"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="A canonical reference to the client capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)"/> <type value="canonical"/> </parameter> <parameter> <name value="resource"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="The client capability statement, provided inline"/> <type value="CapabilityStatement"/> </parameter> <parameter> <name value="return"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="Outcome of the CapabilityStatement test"/> <type value="OperationOutcome"/> </parameter> </ValueSetOperationDefinition >
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
3
(STU;
v3.0.2-11200)
R5
Ballot
hl7.fhir.core#5.0.0-snapshot3
generated
on
Thurs,
Oct
24,
2019
11:53+1100.
QA
Page
Wed,
Dec
14,
2022
07:16+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
DSTU2
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change