Stream: CARIN IG for Blue Button®
Topic: API Documentation
Richard (Apr 09 2021 at 20:02):
Question, as part of the final rule, under section § 422.119 Access to and exchange of health data and plan information, there is a requirements for the payer website to include documentation for accessing APIs.
The rule specifies that the API documentation, including the following three items:
1)API syntax, function names,
required and optional parameters
supported and their data types, return
variables and their types/structures,
exceptions and exception handling
methods and their returns;
(2) The software components and
configurations an application must use
in order to successfully interact with the
API and process its response(s); and
(3) All applicable technical
requirements and attributes necessary
for an application to be registered with
any authorization server(s) deployed in
conjunction with the API.
Are there existing instructions for applications developers and/or technical requirements (other than referencing the IGs and FHIR standards themselves) that can be leveraged to satisfy this specific requirement? Any best practices or examples that can be leveraged here? Thanks much
Last updated: Apr 12 2022 at 19:14 UTC
