Skip to content

CapabilityStatement-ACCESSUnalignmentAPICapabilityStatement.md

Latest commit

 

History

History
82 lines (71 loc) · 3.6 KB

CapabilityStatement-ACCESSUnalignmentAPICapabilityStatement.md

File metadata and controls

82 lines (71 loc) · 3.6 KB

ACCESS Unalignment API Capability Statement - CMS ACCESS Model API v0.9.1

CapabilityStatement: ACCESS Unalignment API Capability Statement
Official URL:https://dsacms.github.io/cmmi-access-model/CapabilityStatement/ACCESSUnalignmentAPICapabilityStatement Version:0.9.1
Active as of 2026-01-23 Computable Name:ACCESSUnalignmentAPICapabilityStatement

Describes the expected capabilities of systems implementing the ACCESS Unalignment API for removing patient alignments from ACCESS participants.

Raw OpenAPI-Swagger Definition file | Download

Resource Content

{
  "resourceType" : "CapabilityStatement",
  "id" : "ACCESSUnalignmentAPICapabilityStatement",
  "url" : "https://dsacms.github.io/cmmi-access-model/CapabilityStatement/ACCESSUnalignmentAPICapabilityStatement",
  "version" : "0.9.1",
  "name" : "ACCESSUnalignmentAPICapabilityStatement",
  "title" : "ACCESS Unalignment API Capability Statement",
  "status" : "active",
  "experimental" : false,
  "date" : "2026-01-23",
  "publisher" : "Global Alliant, Inc.",
  "contact" : [{
    "name" : "Global Alliant, Inc.",
    "telecom" : [{
      "system" : "url",
      "value" : "https://globalalliantinc.com"
    },
    {
      "system" : "email",
      "value" : "david.h@globalalliantinc.org"
    }]
  }],
  "description" : "Describes the expected capabilities of systems implementing the ACCESS Unalignment API for removing patient alignments from ACCESS participants.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "United States of America"
    }]
  }],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : ["json", "xml"],
  "implementationGuide" : ["https://dsacms.github.io/cmmi-access-model/ImplementationGuide/cms.fhir.us.access"],
  "rest" : [{
    "mode" : "server",
    "documentation" : "The ACCESS Unalignment API supports the voluntary removal of patient alignments from ACCESS participants and tracks.",
    "security" : {
      "cors" : true,
      "description" : "Implementations SHALL use TLS 1.3 and implement OAuth 2.0 Client Credentials flow for authentication. MBI and other PHI must be protected according to HIPAA requirements."
    },
    "resource" : [{
      "type" : "Patient",
      "documentation" : "Patient resource for ACCESS unalignment operations",
      "operation" : [{
        "name" : "unalign",
        "definition" : "https://dsacms.github.io/cmmi-access-model/OperationDefinition/Unalign|0.9.1",
        "documentation" : "Remove a patient's alignment from an ACCESS participant. Requires mandatory reason parameter from ACCESSUnalignmentReasonVS (geographic-relocated or loss-of-contact). Automatically cancels active subscriptions and sends unalignment notifications upon successful unalignment. Returns unalignment status from ACCESSUnalignmentResultVS: unaligned or unalignment-pending. Implements asynchronous processing with HTTP 202 Accepted response containing Content-Location header for status polling."
      },
      {
        "name" : "submission-status",
        "definition" : "https://dsacms.github.io/cmmi-access-model/OperationDefinition/SubmissionStatus|0.9.1",
        "documentation" : "Poll the status of a previously submitted unalignment request. Returns HTTP 202 while processing or HTTP 200 with result when complete."
      }]
    }]
  }]
}