API Tools

The API tools Developer Hub

Welcome to the API tools developer hub. You'll find comprehensive guides and documentation to help you start working with API tools as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Argonaut Clinical Notes

Argonaut Clinical Notes

Implementers developing on FHIR R4 should follow the updated Clinical Notes design in US Core.


This implementation guide provides implementers with FHIR profiles and guidance to create, use, and share Clinical Notes. The requirements were developed by the Argonaut Clinical Notes project team and tested through pilot implementations, and HL7 sponsored Connectathons. This guide is based on FHIR Version 3.0.1 The content and profiles used in this guide were submitted to the HL7 US Realm Steering Committee for consideration in the December 2018 ballot of US Core for FHIR Version R4.

Argonaut Actors

The following actors are part of the Clinical Notes IG:

  • Argonaut Requestor: An application that initiates a data access request to retrieve patient data. This can be thought of as the client in a client-server interaction.
  • Argonaut Responder: A product that responds to the data access request providing patient data. This can be thought of as the server in a client-server interaction.

Argonaut Clinical Notes Profiles

This implementation guide includes two profiles for exchanging clinical notes:

  1. Argonaut Clinical Notes Profile which is based upon the DocumentReference resource.
  2. Argonaut Diagnostic Report Profile for Report and Note exchange which is based upon the DiagnosticReport resource.

See the FHIR Resources to Exchange Clinical Notes section for detailed guidance on when to use each profile. Each profile defines the minimum mandatory elements, extensions and terminology requirements that MUST be present. The profile requirements and guidance are given in a simple narrative summary and a formal logical views of the content with references to appropriate terminologies. Examples and “Quick Start” sections are provided to help implementers with easy API onboarding.

Implementers developing on FHIR R4 should follow the updated Clinical Notes design in US Core.

Argonaut Clinical Notes Conformance Requirements

The Capability Statements Section outlines conformance requirements for the Argonaut Clinical Notes Servers and Client applications, identifying the specific profiles that need to be supported, the specific RESTful operations that need to be supported, and the search parameters that need to be supported. Note: The individual Argonaut Clinical Notes profiles identify the structural constraints, terminology bindings and invariants, however, implementers must refer to the conformance requirements for details on the RESTful operations, specific profiles and the search parameters applicable to each of the Argonaut Clinical Notes actors.

Updated about a month ago

Argonaut Clinical Notes

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.