FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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

Operation-capabilitystatement-conforms

FHIR Infrastructure Work GroupMaturity Level: N/ABallot Status: InformativeCompartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML or JSON format.

Test if a server implements a client's required operations

OPERATION: Test if a server implements a client's required operations

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/CapabilityStatement-conforms

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 both capability statements by reference, and must ensure that all the referenced resources are available to the conformance server

URL: [base]/CapabilityStatement/$conforms

Parameters

UseNameCardinalityTypeBindingDocumentation
INleft0..1uri

The canonical URL for the left-hand system's capability statement

INright0..1uri

The canonical URL for the right-hand system's capability statement

INmode0..1code

What kind of comparison to perform - server to server, or client to server (use the codes 'server/server' or 'client/server')

OUTissues1..1OperationOutcome

Outcome of the CapabilityStatement test

OUTunion0..1CapabilityStatement

The intersection of the functionality described by the CapabilityStatement resources

OUTintersection0..1CapabilityStatement

The union of the functionality described by the CapabilityStatement resources

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

 

 

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.