The Design Patterns / Topology demonstrates and describes how various design patterns can influence access, security and use of APIs


This section has been included to emphasise the use of design patterns in to the process of deciding how to use Care Connect APIs within solutions. The information has been taken from


A “pattern” is a formal way of documenting a solution to a design problem in a particular field of expertise for example in the case of an API sharing clinical information between systems. The information in this section has been reproduced and shortened from

  • Patterns are not mutually exclusive: many real solutions will use more than one pattern.
  • Solutions may evolve from simpler to more complex patterns over time.
  • Some patterns will be better for specific sharing needs than others – there is no “one size fits all”.
  • Some patterns will scale better to larger populations.
  • Some patterns require additional capabilities or services to be in place.

List of patterns

Below is a list of patterns. If you require more detail please go to and click on the pattern for more information.

  • Single Shared Application
  • Portal
  • Click Through
  • Store and Notify
  • Broadcast (Point to Point Sharing)
  • Shared Repository
  • Message Broker
  • Registry Repository
  • Publish Subscribe

Patterns and Care Connect APIs

Considering the design pattern / topology influences how any exposed Care Connect APIs can be used and work within a system. APIs help to expose information to all design patterns allowing great user experiences to be created quickly, securely and consistently. This implementation guide concentrates on Case Studies to expose and demonstrate how design pattern can use Care Connect APIs to interoperate with other systems, patterns, and level of digital maturity within and between organisations.

API Considerations

Other API consideration are shown below. Please click on the parts of the API process to continue your API creation journey.

provide_api Local decision Explained Provided Key: API Security Transform Traffic Management Versioning Engage API Docs Report & Monitor Patterns / Topology Access Endpoint
Tags: design