CommonWell API Specification Guide


The Services portion of the specification provides a detailed technical description of CommonWell services, how they work within workflow and how they should be used. Information on the core services, specifically the patient identification and linking service, record locator service and data broker service, is included.

Use Cases

The Use Cases portion of the specification explains the specific actions that can be completed with the CommonWell services and how the services are used by our members and end users. This document speaks to what the CommonWell services help solve for individuals, care team members and organizations.


If you are interested in learning more about how to utilize these specification, connect with us here.

The CommonWell Health Alliance Specification (hereinafter the “Specification” or “specification”) is comprised of Services and Use Cases, collectively the “specification”, and defines the approved specifications and detailed technical and interoperability requirements for a compliant implementation of the services offered by the Alliance, that may be consumed by healthcare information system providers for the purpose of exchanging healthcare information over the internet. These documents are shared under the following license.

CommonWell Service Adopters and their customers are made up of many different types of health care providers and services organizations including provider organizations, the foundation upon which the network was built, consumer applications, personal health records (PHRs), and data retrieval vendors with the task of collecting records on behalf of payers. To learn more about how this specification can be used, review the CommonWell Permitted Purposes.

CommonWell Core Services

Extended Services