Onyx Consent Authorization SAFHIR Implementation and Operations Guide
0.0.2 - ci-build

Onyx Consent Authorization SAFHIR Implementation and Operations Guide - Local Development build (v0.0.2). See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

Patient Consent Capability Statement

This implementation guide allws patients to log in via smart-on-fhir and manage their consent to share data to other patients, related persons, practitioners, and organizations. It also allows payers to record the apps that have been grantred access to APIs.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide

ApiContract

Contract document that defines the terms for access to an API set such as the CARIN Blue Button API or other Implementations that fall within the CMS Patient Access API

Member Exchange Consent Signature

The MemberExchangeConsent profile expresses a member’s desire to have their health data transfered from a prior health plan to their current health plan. If a digital signature is to be provided as an optional element for the Consent record it is supplied as a signature in a Provenance record that refers to the consent resource.

Consent for Member Data Exchange

Consent resource generated by a Health Plan after capturing the consent from a member to retrieve their health information from a prior health plan. The consent resource will capture the following information:

  • The member
  • The payer organization the member authorizes to retrieve their data
  • The payer organization from which the member data is to be retrieved
  • The scope of the data to be retrieved, whether all data or specific sensitive data categories are to be excluded
  • The duration of the sharing either one-time or for a period
  • An optional digital signature.
PrizmCodeSystem

Codesystem to define data segmentation rules. The client will define a codesystem with a unique identifier. The codesystem will include a list of codes from a codesystem that should be used to redact records from the results returned as apart of an API request that needs to be conformant with data segmentation rules.

SafhirAppRegConsent

FHIR Consent resource generated from DataHolder registering a third-party app to access a suite of APIs

SafhirDevice

Device or software application seeking access to data. This would typically be associated with an organization record for a software developer.

SafhirMemberConsent

FHIR Consent resource generated from Data Subject authorizing a third-party app to access their data.

SafhirProxyConsent

FHIR Consent resource generated from an authorized request by an individual to grant or deny access to their data. The request can also be made to the privacy/compliance department of a payer by someone with authority/power of attorney to act on behalf of the data subject.

ShareMyData Member Consent for Data Exchange

Consent resource generated by a Health Plan after capturing the consent from a member to retrieve their health information from a prior health plan. The consent resource will capture the following information:

  • The member
  • The payer organization the member authorizes to retrieve their data
  • The payer organization from which the member data is to be retrieved
  • The scope of the data to be retrieved, whether all data or specific sensitive data categories are to be excluded
  • The duration of the sharing either one-time or for a period
  • An optional digital signature.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

Type of device

Type of software application, web site, service or hardware device

Types of Patient Consent

Identify the types of consent granted by a patient

Scopes for Patient Sharing

Record scopes for patient sharing with a consumer application

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide

Identifier Type

Identifier Type

Patient Consent for Sharing Actions

Code System to describe choices made by consumers when sharing their data

Patient Sharing permissions

Code System to describe the patient sharing permissions for sharing with 3rd party apps

Application, service or hardware type

Code System to describe types of application, service, web site or device

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like

Patient1

Example of a US Core Patient Record

SafhirAppRegByDataHolder

A SAFHIR Consent example of an App being registered by a data holder

SafhirAppRevokeByDataHolder

A SAFHIR Consent example of an App access being revoked by a data holder

SafhirContractCarinBB

Contract terms for CARIN Blue Button IG Access

SafhirMemberConsentExample1

Example of a SAFHIR Member consent to sharing with a third-party app

SafhirContractUSCore

Contract Terms for US Core API Access

SafhirContractPdex

Contract Terms for Da Vinci Payer Data Exchange

SafhirContractFormulary

Contract Terms for Da Vinci Formulary

SafhirContractPlanNet

Contract Terms for Da Vinci Plan-Net.

ExampleDeveloperOrganization2

Example of an Organization Record for the developer/Owner of the MyCareAI App identified in the device record.

ExampleDataHolderEndpoint

The Data Holder’s Endpoint definition for their FHIR API

ExampleAppDeveloperEndpoint

The App Developer’s Endpoint definition for their Web Site

ExampleDeveloperOrganization3

An Organization Resource that defines the characteristics of the App Developer Organization

ExampleDeveloperOrganization

An Organization Resource that defines the characteristics of the Application Developer Organization

ExampleSensitiveInfoCodesBH

A list of codes that fall into a sensitive information category:

http://terminology.hl7.org/CodeSystem/v3-ActCode

BH: behavioral health information sensitivity Policy for handling information related to behavioral and emotional disturbances affecting social adjustment and physical health, which is afforded heightened confidentiality.

Usage Note: If there is a jurisdictional mandate, then use the applicable ActPrivacyLaw code system, and specify the law in addition to this more generic code.

SAMPLE codeset

ExamplePlanNetEndpoint

An Endpoint profile to document when a provider directory was updated

ExampleSensitiveInfoCodesHIV

A list of codes that fall into a sensitive information category:

http://terminology.hl7.org/CodeSystem/v3-ActCode

HIV: HIV/AIDS information sensitivity

Policy for handling HIV or AIDS information, which will be afforded heightened confidentiality. Information handling protocols based on organizational policies related to HIV or AIDS information that is deemed sensitive.

Usage Note: If there is a jurisdictional mandate, then use the applicable ActPrivacyLaw code system, and specify the law in addition to this more generic code.

Based on codesets provided by CareFirst 20201-05-05

ExampleSensitiveInfoCodesMH

A list of codes that fall into a sensitive information category:

http://terminology.hl7.org/CodeSystem/v3-ActCode

MH: mental health information sensitivity

Policy for handling information related to psychological disorders, which is afforded heightened confidentiality. Mental health information may be deemed specifically sensitive and distinct from physical health, substance use disorders, and behavioral disabilities and disorders in some jurisdictions.

Usage Note: If there is a jurisdictional mandate, then use the applicable ActPrivacyLaw code system, and specify the law in addition to this more generic code.

Based on codesets provided by CareFirst 20201-05-05

ExampleDataHolderOrganization

An Organization Resource that defines the characteristics of the Data Holder Organization

ShareMyDataMemberConsent

Example of a member granting data access to another payer service organization

ExampleSensitiveInfoCodesSUD

A list of codes that fall into a sensitive information category:

http://terminology.hl7.org/CodeSystem/v3-ActCode

SUD: substance use disorder information sensitivity

Policy for handling information related to alcohol or drug use disorders and conditions caused by these disorders, which is afforded heightened confidentiality.

Usage Note: If there is a jurisdictional mandate, then use the applicable ActPrivacyLaw code system, and specify the law in addition to this more generic code.

Based on codesets provided by CareFirst 20201-05-05

ExampleDevice

The Device record for a developer’s application