PACIO Advance Directive Interoperability Implementation Guide
0.1.0 - STU1

PACIO Advance Directive Interoperability Implementation Guide, published by HL7 Patient Empowerment Working Group. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of and changes regularly. See the Directory of published versions

Security Privacy Consent

General Considerations

Advance Directive Interoperability (ADI) involves communication of advance directive information across multiple parties including who the information is about, their healthcare agents and identified advisors, and care providers. The author, who is also the person the information is about, needs access to create, modify, remove, and share this information either directly or through an authorized third party. Users of this information are the appointed healthcare agents or advisors, care providers in emergency, intensive, or critical care environments, or others providing longer term care in a skilled nursing or other similar facility.

Advance directive information contains patient specific information, which means that it needs to be protected with proper security and privacy protections to avoid malicious or unintentional exposure of such information. All Advance Directive Interoperability exchanges must be appropriately secured in transit and access limited only to authorized individuals.

The ADI IG focuses on providing a structure to share data and information. Policy, legal, and regulatory differences across states and local areas may impact the workflow and requirements associated with Advance Directives Information. Implementors should review the current context for where this IG is expected to be used to ensure those requirements are met.

Security Considerations and Guidance

All implementers of the Advance Directive Interoperability Implementation Guide (IG) SHOULD follow the FHIR Security guidance, Security and Privacy Module, and the FHIR Implementer’s Safety Checklist guidance as defined in the FHIR standard where applicable and not otherwise superseded by this Section of the ADI IG.

  1. The FHIR Security specification provides guidance related to communication security, authentication, authorization/access control, audit, digital signatures, attachments, labels, narrative, and input validation. The FHIR security specification is available here.
  2. The FHIR Security and Privacy Module describes access control and authorization considerations to protect a FHIR server, how to document permissions granted, and hot to keep records of performed events. The FHIR Security and privacy module can be found here.
  3. The FHIR Implementer’s Safety Checklist helps implementers be sure that they have considered all the parts of FHIR that impact their system design regarding safety. The FHIR safety check list is available here.

Security Requirements

For the purposes of Advance Directive Interoperability, additional security conformance requirements are as follows:

Exchange Security
  1. The exchange of AD information SHOULD use the current version and SHALL use either current or the immediately prior release of Transport Level Security (TLS) as specified by the current release of NIST guidelines (SP 800-52).
  2. Implementers of this Implementation Guide SHALL support SMART on FHIR App Launch Framework and MAY support SMART on FHIR Backend Services.
  3. Implementers of this Implementation Guide SHOULD support SMART on FHIR Authorization best practices Transport Security section found here.
  4. Implementers of this Implementation Guide SHOULD support mutually authenticated TLS.
  5. Server implementations that expect to support browser-based javascript applications SHOULD enable Cross-Origin Resource Sharing (CORS) for REST operations. Many client web-based apps use javascript for API calls which requires CORS. However, CORS could present security concerns if not implemented correctly or not updated as new security issues are found and addressed. Implementers of CORS SHOULD consider advice about CORS from sources such as Enable-CORS and Moesif blog on Guide to CORS Pitfalls
Authentication and Authorization Requirements
  1. Implementations SHOULD consider the SMART on FHIR Best Practices in Authorization found here
  2. Server implementations SHALL support individual user authentication and MAY support system level authentication if access controls of the system are trusted for the scope of use.
  3. Implementation MAY support Health Relationship Trust Profile for User-Managed Access (HEART).
  4. Implementation SHALL utilize OAuth 2.0 compliant authorization protocols.
  5. This guide requires SMART on FHIR App Launch Framework which provides guidance on scopes
  6. This guide defines the following server requirements for SMART on FHIR Core Capabilities
    1. Launch Modes
      1. SHOULD support launch-ehr: support for SMART’s EHR Launch mode
      2. SHALL support launch-standalone: support for SMART’s Standalone Launch mode
    2. Client Types
      1. SHALL support client-public: support for SMART’s public client profile (no client authentication)
      2. SHALL support client-confidential-symmetric: support for SMART’s confidential client profile (symmetric client secret authentication)
    3. Single Sign-on
      1. SHALL support sso-openid-connect: support for SMART’s OpenID Connect profile
    4. Launch Context
      1. SHOULD support context-banner: support for “need patient banner” launch context (conveyed via need_patient_banner token parameter)
      2. MAY support context-style: support for “SMART style URL” launch context (conveyed via smart_style_url token parameter)
    5. Launch Context for EHR Launch, if launch-ehr is supported
      1. SHALL support context-ehr-patient: support for patient-level launch context (requested by launch/patient scope, conveyed via patient token parameter)
      2. SHALL support context-ehr-encounter: support for encounter-level launch context (requested by launch/encounter scope, conveyed via encounter token parameter)
    6. Launch Context for Standalone Launch
      1. SHALL support context-standalone-patient: support for patient-level launch context (requested by launch/patient scope, conveyed via patient token parameter)
      2. MAY support context-standalone-encounter: support for encounter-level launch context (requested by launch/encounter scope, conveyed via encounter token
    7. Permissions
      1. SHOULD support permission-offline: support for refresh tokens (requested by offline_access scope)
      2. SHALL support, at a minimum, the following granted authorization scopes:
        1. openid
        2. fhirUser
        3. launch/patient
        4. patient/*.read
        5. patient/Bundle.*
        6. patient/DocumentReference.*
        7. user/
        8. user/Bundle.*
        9. user/DocumentReference.* <!– TODO

          Individual-Authorized Exchange

  7. –>

    Privacy Requirement

    For the purposes of Advance Directive Interoperability, privacy conformance requirements are as follows:

    • Implementers SHOULD support data sharing policies with use of the Consent resource.

Digital Signatures

In order to validate the authenticity and integrity of advance directive information, document bundles SHALL support digital signing of ADI document bundles . See

Audit Logging and Provenance

  1. Server implementations SHOULD record all IG related data access using the AuditEvent resource.
  2. Server implementations SHOULD support the ability to directly record and/or enable clients to assert (store) provenance associated with advance directive information using the Provenance resource.