CMSgov/dpc-app

View on GitHub
dpc-api/src/main/resources/DPCCapabilities.json

Summary

Maintainability
Test Coverage
{
  "resourceType": "CapabilityStatement",
  "description": "This Capability Statement defines the available resource, endpoints and operations supported by the Data @ the Point of Care Application.",
  "id": "dpc-capabilities",
  "version": "0.3.0-SNAPSHOT",
  "status": "draft",
  "date": "2019",
  "publisher": "Centers for Medicare and Medicaid Services",
  "kind": "instance",
  "instantiates": [
    "http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data"
  ],
  "software": {
    "name": "Data @ Point of Care API",
    "version": "0.3.0-SNAPSHOT",
    "releaseDate": "2019"
  },
  "fhirVersion": "3.0.2",
  "acceptUnknown": "extensions",
  "format": [
    "application/json",
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "server",
      "security": {
        "cors": true,
        "extension": [
          {
            "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris",
            "extension": [
              {
                "url": "token",
                "valueUri": "https://dpc.cms.gov/api/v1/Token/auth"
              }
            ]
          }
        ],
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "SMART-on-FHIR",
                "display": "SMART on FHIR"
              }
            ],
            "text": "SMART on FHIR Backend Services"
          }
        ]
      },
      "resource": [
        {
          "type": "Endpoint",
          "profile": {
            "reference": "https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-endpoint"
          },
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version"
        },
        {
          "type": "Group",
          "profile": {
            "reference": "https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-attribution-roster"
          },
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "create"
            },
            {
              "code": "update"
            },
            {
              "code": "delete"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version",
          "searchParam": [
            {
              "name": "characteristic-value",
              "type": "token",
              "documentation": "Search for Attribution rosters which are attributed to the given provider NPI"
            },
            {
              "name": "member",
              "type": "reference",
              "documentation": "Search for Attribution groups in which the given Patient resource is a member."
            }
          ]
        },
        {
          "type": "Organization",
          "profile": {
            "reference": "https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-organization"
          },
          "interaction": [
            {
              "code": "read"
            }
          ],
          "versioning": "no-version"
        },
        {
          "type": "Patient",
          "profile": {
            "reference": "https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-patient"
          },
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "create"
            },
            {
              "code": "update"
            },
            {
              "code": "delete"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version",
          "searchParam": [
            {
              "name": "identifier",
              "type": "token",
              "documentation": "Find patient resources which match the given Identifier. For DPC, this will always return a single resource, as MBIs are unique."
            }
          ]
        },
        {
          "type": "Practitioner",
          "profile": {
            "reference": "https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-practitioner"
          },
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "create"
            },
            {
              "code": "update"
            },
            {
              "code": "delete"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version",
          "searchParam": [
            {
              "name": "identifier",
              "type": "token",
              "documentation": "Find practitioner resources which match the given Identifier. For DPC, this will always return a single resource, as NPIs are unique."
            }
          ]
        },
        {
          "type": "StructureDefinition",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version"
        }
      ],
      "interaction": [
        {
          "code": "batch"
        }
      ],
      "operation": [
        {
          "name": "group-export",
          "definition": {
            "reference": "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export"
          }
        },
        {
        "name": "patient-everything",
        "definition": {
            "reference": "http://hl7.org/fhir/OperationDefinition/Patient-everything" 
          }
        },
        {
          "name": "validate",
          "definition": {
            "reference": "https://dpc.cms.gov/api/v1/OperationDefinition/dpc-operation-practitioner-validate"
          }
        },
        {
          "name": "submit",
          "definition": {
            "reference": "https://dpc.cms.gov/api/v1/OperationDefinition/dpc-operation-practitioner-submit"
          }
        },
        {
          "name": "validate",
          "definition": {
            "reference": "https://dpc.cms.gov/api/v1/OperationDefinition/dpc-operation-patient-validate"
          }
        },
        {
          "name": "submit",
          "definition": {
            "reference": "https://dpc.cms.gov/api/v1/OperationDefinition/dpc-operation-patient-submit"
          }
        },
        {
          "name": "add",
          "definition": {
            "reference": "https://dpc.cms.gov/api/v1/OperationDefinition/dpc-operation-group-add"
          }
        },
        {
          "name": "remove",
          "definition": {
            "reference": "https://dpc.cms.gov/api/v1/OperationDefinition/dpc-operation-group-remove"
          }
        }
      ]
    }
  ]
}