Summary release notes of the versions released in Care Connect API Implementation Guide



  • UHS Proof of Concept - Workflow (Orders) Updated
  • Updated UHS Proof of Concept - Diagnostics
  • Updated Exchange Patterns



  • Improved links to GP Connect sites from Exchange Patterns page.
  • Improved links to GP Connect sites from Exchange Patterns page.



  • Added developer notes on University Hospital Southampton use case.


  • FAQ as a inconsistency was spotted



  • Profile section to engage
  • Change of page titles under explore section and page names. Now reflect purpose rather than design stage.
  • Removed lower level headings from the table of contents on the profiles page



  • Explore section renamed Resources
  • Profile references to Resources
  • Engage section renamed Case Studies



  • Altered search parameters page
  • Corrected section for observations
  • Updated Bristol POC with most recent content
  • Corrected typos



  • Spelling mistakes and general checking throughout the site
  • Links in navigation menu’s
  • Consistency of styles
  • Menu structure to be easier to see and clearer
  • Styles to fix accessibility and viewability issues found in the the guide



  • Initial sections of University Hospital Southampton POC included
  • Added section on how search parameters were selected
  • Added core Care Connect API prerequisites


  • Updates to Bristol Connecting Care POC (user stories)
  • Corrections to the glossary
  • Corrected broken links in the engagement approach
  • Removed national NHS Number guidance
  • Corrected menu linking
  • Provide APIs diagrams throughout
  • Colour scheme of diagrams from feedback
  • Altered Accept http header notes
  • Moved xml and code examples to gitHub gist
  • Converted markdown to html tables for better display of parameters
  • Updated API search combinations (conformance requirements)



  • Community and FHIR Tools sections to Help & Support sections
  • Diagram to support the engagement process
  • Foundation API definitions
  • Profile links to HL7 UK FHIR Reference Server (test version)


  • Communication Channels (Help & Support) revised to reference the Care Connect Inbox and the INTEROpen website.
  • Clinical API definitions
  • Individuals and Entities API definitions
  • Workflow API definitions
  • All Explore section pages to similar layout
  • Communication Channels (Help & Support) revised to reference the Care Connect Inbox and the INTEROpen website
  • Corrected some styling issues
  • Design & Build section template added as a process
  • Test section example added of end to end process
  • Assure section added to provide overview of end to end process
  • Deploy section added to provide overview of end to end process
  • Major changes to underlying folder structure to support use and updating of information
  • Conformance profile updates to current alpha state
  • Glossary
  • Provide APIs with a clickable diagram used throughout later stages
  • Linking to
  • Engagement approach with look and feel and linking



  • Description of providing an API process
  • Standard definition of a API definition
  • Started Test explanation section
  • Engagement Process
  • Bristol Connecting Care Case Study

Defined Patient definition adding :

  • References section - starting to link to user stories
  • HTTP headers
  • Response codes - Also added a non exhaustive API Codes page to describe all of the codes
  • Search parameters - added section to include guidance on how a search can happen in practice localised on the NHS

Multiple updates to glossary

Restructured ‘Engage’ navigation to rationalise content showing the engagement process and case studies. Pages explaining what user stories are and how we use them have been moved off the sidebar to be accessed within the pages as necessary.


Examples resources conforming to the CareConnect Profiles

Mandatory and optional API Parameters defined for the following resources

  • Clinical
  • AllergyIntollerance - Condition - Immunization - Medication - MediationOrder - MedicationStatement - Observation
  • Identification
    • Location
    • Organization
    • Patient
    • Practitioner
  • Workflow
    • Encounter (please comment via or email


  • Added Overview explanation
  • Added Michael’s Stories showing the example user stories
  • Linked Michael’s Stories to APIs currently available and defined above
Tags: development