This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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
This resource has 3 operations associated with it:
$subset | Fetch a subset of the CapabilityStatement resource |
$implements | Test if a server implements a client's required operations |
$conforms | Test if a server implements a client's required operations |
For more information about operations, including how they are invoked, see Operations.
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
Formal Definition (as a OperationDefinition).
URL: [base]/CapabilityStatement/$subset
URL: [base]/CapabilityStatement/[id]/$subset
In Parameters: | |||||
Name | Cardinality | Type | Binding | Profile | Documentation |
server | 0..1 | uri | The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point) | ||
resource | 1..* | code | A resource that the client would like to include in the return | ||
Out Parameters: | |||||
Name | Cardinality | Type | Binding | Profile | Documentation |
return | 1..1 | CapabilityStatement | The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code Note: as this the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource |
This operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in it's capability statement. The client provides it's capability statement inline, or by referring the server to the canonical URL of it's capability statement
Formal Definition (as a OperationDefinition).
URL: [base]/CapabilityStatement/$implements
URL: [base]/CapabilityStatement/[id]/$implements
In Parameters: | |||||
Name | Cardinality | Type | Binding | Profile | Documentation |
server | 0..1 | uri | The canonical URL for the server capability statement - use this if the subset is not invoked on an instance (or on the /metadata end-point) | ||
client | 0..1 | uri | The canonical URL for the client capability statement - use this if the subset is not invoked on an instance (or on the /metadata end-point) | ||
resource | 0..1 | CapabilityStatement | The client capability statement, provided inline | ||
Out Parameters: | |||||
Name | Cardinality | Type | Binding | Profile | Documentation |
return | 1..1 | OperationOutcome | Outcome of the CapabilityStatement test | ||
issues | 1..1 | OperationOutcome | Outcome of the CapabilityStatement test | ||
union | 0..1 | Bundle | The intersection of the functionality described by the CapabilityStatement resources | ||
intersection | 0..1 | Bundle | The union of the functionality described by the CapabilityStatement resources |
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 servers' resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalDelete, searchInclude, searchRevInclude * The server 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 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 definitions 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
This operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in it's capability statement. The client provides both capability statements by reference, and must ensure that all the referenced resources are available to the conformance server
Formal Definition (as a OperationDefinition).
URL: [base]/CapabilityStatement/$conforms
In Parameters: | |||||
Name | Cardinality | Type | Binding | Profile | Documentation |
left | 0..1 | uri | The canonical URL for the server capability statement - use this if the subset is not invoked on an instance (or on the /metadata end-point) | ||
right | 0..1 | uri | The canonical URL for the client capability statement - use this if the subset is not invoked on an instance (or on the /metadata end-point) | ||
mode | 0..1 | code | What kind of comparison to preform - server cf server, or client to server (use the codes 'server/server' or 'client/server') |
The operation performs a full comparison of the functionality described by the two capability statements, including the profiles and value sets they reference, and also including concept maps and structure maps.
The full execution of this operation is still a matter of research, but it is intended to support comparison of systems to see if they will interoperate
If the capability statements can be successfully compared, then the return value is a 200 OK with an OperationOutcome along with intersection and union capability statements. The operation outcome can contain errors relating to differences between the capability statements. If the capability statements cannot be compared, because dependencies cannot be located, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error