markodukic / ccexample

CareConnectAPI

INTEROpen Powered by

CareConnect API

Implementation Guide for creating CareConnect APIs
Visit the APIs »

Table of contents

• Quick start
• Status
• What's included
• Bugs and feature requests
• Contributing
• Community
• Versioning
• Creators
• Copyright and license

Quick start

Several quick start options are available:

• View the latest release
• Clone the repo: git clone https://github.com/nhsconnect/CareConnectAPI
• Install Ruby
• Install OS X/Linux Jekyll
• Install Windows Jekyll
• Run Jekyll locally: bundle exec jekyll serve
• Browse website Browser: http://localhost:4000

Read the Getting started page for information on the CareConnect API contents, templates and examples, and more.

Status

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

Audit
Examples
StructureDefinitions
ValueSets

We provide a complete set of instructions for you to get your CareConnect API working and compiled locally.

Running documentation locally

Learn more about using Jekyll by reading its documentation.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation for previous releases

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by XYZ.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.

Community

Get updates on CareConnect APIs development and chat with the project maintainers and community members.

• Follow @careconnectapi on Twitter.
• Read and subscribe to The INTEROpen CareConnect API.
• Join the official Ryver room.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, CareConnect API is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.

See the Releases section of our GitHub project for changelogs for each release version of Bootstrap. Release announcement posts on the official CareConnect API blog contain summaries of the most noteworthy changes made in each release.

Copyright and license

Code and documentation copyright 2011-2017 the CareConnect API Authors and NHS Digital Code released under the MIT License. Docs released under Creative Commons.