Difference between revisions of "Implementation Guides"

From HL7 Argonaut Project Wiki
Jump to: navigation, search
m
m
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
===[http://hl7.org/fhir/smart-app-launch/ SMART App Authorization Guide]===
 
===[http://hl7.org/fhir/smart-app-launch/ SMART App Authorization Guide]===
 +
The SMART App Launch Framework connects third-party applications to Electronic Health Record data, allowing apps to launch from inside or outside the user interface of an EHR system. The framework supports apps for use by clinicians, patients, and others via a PHR or Patient Portal or any FHIR system where a user can give permissions to launch an app. It provides a reliable, secure authorization protocol for a variety of app architectures, including apps that run on an end-user’s device as well as apps that run on a secure server.
  
OAuth 2.0 profile for authorizing apps to access FHIR data.
+
The Launch Framework supports the [http://argonautwiki.hl7.org/images/4/4c/Argonaut_UseCasesV1.pdf '''four uses cases'''] defined for Phase 1 of the Argonaut Project:
 +
 
 +
#Patients apps that launch standalone
 +
#Patient apps that launch from a portal
 +
#Provider apps that launch standalone
 +
#Provider apps that launch from a portal
  
*[[Smart-auth-backgound|Background Resources]]
 
  
 
===[http://www.fhir.org/guides/argonaut/r2/ Argonaut Data Query Implementation Guide Version 1.0.0]===
 
===[http://www.fhir.org/guides/argonaut/r2/ Argonaut Data Query Implementation Guide Version 1.0.0]===
([https://github.com/argonautproject/data-query GIt Repo for Argonaut Data Query Implementation Guide Continuous Integration build])
+
The Argonaut Data Query Implementation Guide is based upon the core FHIR DSTU2 API and it documents the security and authorization and the querying of the ONC Common Clinical Data Set and static documents. This specification describes four use cases and sets search expectations for each. For complete details and background, see [http://argonautwiki.hl7.org/images/e/ec/Argonaut_UseCasesV1-1.pdf '''Use Cases for the Argonaut Project''']
  
The Argonaut Data Query Implementation Guide is based upon the core '''FHIR DSTU2 API''' and it documents:
+
#Patient uses provider-approved web application to access health data
 
+
#Patient uses provider-­approved mobile app to access health data
*Security and Authorization
+
#Clinician uses provider­-approved web application to access health data
*Data element query of the ONC Common Clinical Data Set
+
#Clinician uses provider­-approved mobile app to access health data
*Document query of static documents
+
  
 
NOTE:
 
NOTE:
 +
* The Common MU Data Set referenced in the Use Cases is now the ONC 2015 Common Clinical Data Set .
 
* See [http://hl7.org/fhir/us/core/STU2/ US Core Implementation Guide (Published)] '''FHIR STU3 API''' equivalent of Argonaut Data Query Implementation Guide.
 
* See [http://hl7.org/fhir/us/core/STU2/ US Core Implementation Guide (Published)] '''FHIR STU3 API''' equivalent of Argonaut Data Query Implementation Guide.
 
* See [https://build.fhir.org/ig/HL7/US-Core-R4/ US Core Implementation Guide (CI Build)] '''FHIR R4 API''' equivalent of Argonaut Data Query Implementation Guide.
 
* See [https://build.fhir.org/ig/HL7/US-Core-R4/ US Core Implementation Guide (CI Build)] '''FHIR R4 API''' equivalent of Argonaut Data Query Implementation Guide.
Line 20: Line 25:
  
 
===[http://www.fhir.org/guides/argonaut/pd/ Argonaut Provider Directory Implementation Guide (v 1.0.0)]===
 
===[http://www.fhir.org/guides/argonaut/pd/ Argonaut Provider Directory Implementation Guide (v 1.0.0)]===
([https://github.com/argonautproject/provider-directory Git Repo for  Argonaut Provider Directory Implementation Guide])
+
The Argonaut project Provider Directory guide is based upon the FHIR STU3 API and contains the foundation for a robust provider directory. It describes the use cases and search expectations for finding a practitioner or organization. It outlines the key data elements for any provider directory and basic query guidance. The components developed in this guide are intended to provide a foundation for a central or distributed Provider or Healthcare Directory. Additional work flow components and elements may be required for a particular implementation.
 +
 
 +
The requirements for the Argonaut Provider Directory data model were drawn from [http://ihe.net/uploadedFiles/Documents/ITI/IHE_ITI_Suppl_HPD.pdf '''IHE Healthcare Provider Directory'''] and the ONC Provider Directory Workshop.
 +
 
 +
'''Use Cases'''
 +
#Search for Practitioner by demographics
 +
#Search for Practitioner within a region (city, state)
 +
#Search for Organization and facility by:
 +
#Search for Practitioner by organizational relationships
 +
*[https://github.com/argonautproject/provider-directory Git Repo for  Argonaut Provider Directory Implementation Guide]
  
The Argonaut project Provider Directory guide is based upon the core FHIR STU3 API and contains the foundation for a robust provider directory. It describes the use cases and search expectations for finding a practitioner or organization. It outlines the key data elements for any provider directory and basic query guidance.
 
  
 
===[http://www.fhir.org/guides/argonaut/scheduling/ Argonaut Scheduling Implementation Guide]===
 
===[http://www.fhir.org/guides/argonaut/scheduling/ Argonaut Scheduling Implementation Guide]===
([https://github.com/argonautproject/scheduling Git Repo for  Argonaut Scheduling Implementation Guide])
+
The Argonaut Scheduling Implementation Guide defines a series of interactions which cover the basic appointment creation workflow for patient based scheduling which includes: registration of patients and updating coverage information, discovery of available appointments and booking the canceling appointments. It also covers patient access to their appointments.
 +
* For a detailed description of the use cases and workflow see the [http://www.fhir.org/guides/argonaut/scheduling/patient-scheduling.html '''Patient Scheduling Use Cases'''] page.
 +
*[https://github.com/argonautproject/scheduling Git Repo] for  Argonaut Scheduling Implementation Guide
  
This project supports basic patient and provider access to a provider's calendar and appointment requests, including APIs and guidance for searching and publishing a providers schedule and requesting, cancelling or updating an appointment.
 
  
 
===[http://cds-hooks.org/#overview CDS Hooks Implementation Guide]===
 
===[http://cds-hooks.org/#overview CDS Hooks Implementation Guide]===
([https://github.com/argonautproject/cds-hooks/wiki Argonaut CDS Hooks Wiki])
+
Leveraging the experience of the CDS hooks community to accelerate the maturation of CDS hooks for the industry, we have developed use cases, providing specific guidance and publish an implementation guide for deploying CDS hooks. This specification describes a [http://en.wikipedia.org/wiki/Hooking "hook"]-based pattern for invoking decision support from within a clinician's workflow. The API supports:
 +
*Synchronous, workflow-triggered CDS calls returning information and suggestions
 +
*Launching a user-facing SMART app when CDS requires additional interaction
  
Leveraging the experience of the CDS hooks community to accelerate the maturation of CDS hooks for the industry, we have developed use cases, providing specific guidance and publish an implementation guide for deploying CDS hooks.
 
  
 
===[http://www.fhir.org/guides/argonaut/clinicalnotes/history.shtml Argonaut Questionnaire Implementation Guide]===
 
===[http://www.fhir.org/guides/argonaut/clinicalnotes/history.shtml Argonaut Questionnaire Implementation Guide]===
([https://github.com/argonautproject/questionnaire Git Repo for  Argonaut Questionnaire Implementation Guide])
+
The goal of the Argonaut Questionnaire Project was to develop guidance to support interchange of simple forms based on [http://hl7.org/fhir/STU3/ '''FHIR Version 3.0.1'''] and specifically the [http://hl7.org/fhir/STU3/questionnaire.html '''Questionnaire'''] and [http://hl7.org/fhir/STU3/questionnaireresponse.html '''QuestionnaireResponse'''] resources. This implementation guide provides implementers with FHIR RESTful APIs and guidance to create, use and share between organizations standard assessment forms and the assessment responses
  
The goal of the Argonaut Questionnaire Project is to develop guidance to support interchange of simple forms based on FHIR Version 3.0.1 and specifically the Questionnaire and QuestionnaireResponse resources. This implementation guide provides implementers with FHIR RESTful APIs and guidance to create, use and share between organizations standard assessment forms and the assessment responses
 
  
===[http://www.fhir.org/guides/argonaut/clinicalnotes/history.shtml Argonaut Clinical Notes Implementation Guide]===
+
===[http://www.fhir.org/guides/argonaut/clinicalnotes/1.0.0/ Argonaut Clinical Notes Implementation Guide]===
([https://github.com/argonautproject/clinicalnotes Git Repo for Argonaut Clinical Notes Implementation Guide])
+
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 [https://build.fhir.org/ig/HL7/US-Core-R4/ '''US Core'''] for FHIR Version R4.
  
The goal of the Argonaut Clinical Notes Project is to develop 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 Subscriptions- ''Coming Soon!''===
 
===Argonaut Subscriptions- ''Coming Soon!''===

Latest revision as of 11:27, 11 June 2019

SMART App Authorization Guide

The SMART App Launch Framework connects third-party applications to Electronic Health Record data, allowing apps to launch from inside or outside the user interface of an EHR system. The framework supports apps for use by clinicians, patients, and others via a PHR or Patient Portal or any FHIR system where a user can give permissions to launch an app. It provides a reliable, secure authorization protocol for a variety of app architectures, including apps that run on an end-user’s device as well as apps that run on a secure server.

The Launch Framework supports the four uses cases defined for Phase 1 of the Argonaut Project:

  1. Patients apps that launch standalone
  2. Patient apps that launch from a portal
  3. Provider apps that launch standalone
  4. Provider apps that launch from a portal


Argonaut Data Query Implementation Guide Version 1.0.0

The Argonaut Data Query Implementation Guide is based upon the core FHIR DSTU2 API and it documents the security and authorization and the querying of the ONC Common Clinical Data Set and static documents. This specification describes four use cases and sets search expectations for each. For complete details and background, see Use Cases for the Argonaut Project.

  1. Patient uses provider-approved web application to access health data
  2. Patient uses provider-­approved mobile app to access health data
  3. Clinician uses provider­-approved web application to access health data
  4. Clinician uses provider­-approved mobile app to access health data

NOTE:


Argonaut Provider Directory Implementation Guide (v 1.0.0)

The Argonaut project Provider Directory guide is based upon the FHIR STU3 API and contains the foundation for a robust provider directory. It describes the use cases and search expectations for finding a practitioner or organization. It outlines the key data elements for any provider directory and basic query guidance. The components developed in this guide are intended to provide a foundation for a central or distributed Provider or Healthcare Directory. Additional work flow components and elements may be required for a particular implementation.

The requirements for the Argonaut Provider Directory data model were drawn from IHE Healthcare Provider Directory and the ONC Provider Directory Workshop.

Use Cases

  1. Search for Practitioner by demographics
  2. Search for Practitioner within a region (city, state)
  3. Search for Organization and facility by:
  4. Search for Practitioner by organizational relationships


Argonaut Scheduling Implementation Guide

The Argonaut Scheduling Implementation Guide defines a series of interactions which cover the basic appointment creation workflow for patient based scheduling which includes: registration of patients and updating coverage information, discovery of available appointments and booking the canceling appointments. It also covers patient access to their appointments.


CDS Hooks Implementation Guide

Leveraging the experience of the CDS hooks community to accelerate the maturation of CDS hooks for the industry, we have developed use cases, providing specific guidance and publish an implementation guide for deploying CDS hooks. This specification describes a "hook"-based pattern for invoking decision support from within a clinician's workflow. The API supports:

  • Synchronous, workflow-triggered CDS calls returning information and suggestions
  • Launching a user-facing SMART app when CDS requires additional interaction


Argonaut Questionnaire Implementation Guide

The goal of the Argonaut Questionnaire Project was to develop guidance to support interchange of simple forms based on FHIR Version 3.0.1 and specifically the Questionnaire and QuestionnaireResponse resources. This implementation guide provides implementers with FHIR RESTful APIs and guidance to create, use and share between organizations standard assessment forms and the assessment responses


Argonaut Clinical Notes Implementation Guide

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 Subscriptions- Coming Soon!

See current projects

Argonaut CDS Hooks for PAMA- Coming Soon!

See current projects

Argonaut R4- Coming Soon!

Expected Winter 2019. See current projects

Argonaut Provenance - Coming Soon!

See current projects

Copyright © Health Level Seven International ® ALL RIGHTS RESERVED. The reproduction of this material in any form is strictly forbidden without the written permission of the publisher.