Conformance Profile

The Conformance resource is part of the set of resource profiles supported by the API Server used with the athenaPractice 12.3 and athenaFlow 9.12 products. It describes the capabilities of the API server delivered with these products.

Scope and Usage

This resource lists the resources and operations implemented by the API Server delivered with athenaPractice 12.3 and athenaFlow 9.12 and later releases of these products. See the FHIR Conformance resource for more details on how to interpret the content of this resource.

NOTE: The API Server does not support search for conformance resources since it only supplies the conformance resource for its implementation.

Supported Operations

The operations supported by this resource are listed below.

Read Operation

Read operations are executed as specified in the HL7 FHIR read operation definition. To read a Observation, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.

GET [base]/fhir/metadata{?_format=[json|xml]}

Read Operation Parameters

Parameter Description
[base] Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.

Read Operation HTTP Response Codes

Response Code Description
200 OK The requested resource was found and is contained within the body of the HTTP response.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.