{
  "description": "This Section describes the expected capabilities of the PDex Provider Access Server actor which is responsible for providing responses to the queries submitted by the PDex Provider Access Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by PDex Provider Access Servers are defined. PDex Provider Access Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.",
  "_filename": "CapabilityStatement-pdex-provider-access-server.json",
  "package_name": "hl7.fhir.us.davinci-pdex",
  "format": [ "json" ],
  "date": "2024-05-02",
  "publisher": "HL7 International / Financial Management",
  "patchFormat": [ "application/json-patch+json" ],
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "US",
      "system": "urn:iso:std:iso:3166",
      "display": "United States of America"
    } ]
  } ],
  "name": "PdexProviderAccessServerCapabilityStatement",
  "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "PDex Provider Access Server CapabilityStatement",
  "package_version": "2.1.0-ballot",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode": "fm"
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode": "trial-use",
    "_valueCode": {
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical": "http://hl7.org/fhir/us/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex"
      } ]
    }
  } ],
  "status": "active",
  "id": "71b2e6ac-ec95-4223-8d09-12b3be6fd467",
  "kind": "requirements",
  "implementationGuide": [ "http://hl7.org/fhir/us/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex|2.0.0" ],
  "url": "http://hl7.org/fhir/us/davinci-pdex/CapabilityStatement/pdex-provider-access-server",
  "version": "2.1.0-ballot",
  "contact": [ {
    "name": "HL7 International / Financial Management",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/fm",
      "system": "url"
    }, {
      "value": "fm@lists.HL7.org",
      "system": "email"
    } ]
  }, {
    "name": "Mark Scrimshire (mark.scrimshire@onyxhealth.io)",
    "telecom": [ {
      "value": "mailto:mark.scrimshire@onyxhealth.io",
      "system": "email"
    } ]
  }, {
    "name": "HL7 International - Financial Management",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/fm",
      "system": "url"
    } ]
  } ],
  "rest": [ {
    "mode": "server",
    "resource": [ {
      "type": "Group",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "operation": [ {
        "name": "davinci-data-export",
        "definition": "http://hl7.org/fhir/us/davinci-atr/OperationDefinition/davinci-data-export",
        "documentation": "Each DaVinci use case as part of its implementation guide can define the exportType parameter and the behavior expected."
      } ],
      "interaction": [ {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "documentation": "Allows discovery of existing groups. SHOULD be limited to groups a requestor is permitted to access."
      }, {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "documentation": "Allows retrieval of a specific Group Resource."
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "documentation": "Allows retrieval of a historical version of a Group Resource."
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "documentation": "Allows review of changes to a Group Resource over time."
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "documentation": "Retrieve the change history fora Group Resource."
      } ],
      "searchParam": [ {
        "name": "identifier",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Group-identifier",
        "documentation": "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
      }, {
        "name": "characteristic",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Group-characteristic",
        "documentation": "A common characteristic of all members of a group."
      }, {
        "name": "Group-characteristic-value-reference",
        "type": "composite",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/us/davinci-atr/SearchParameter/Group-characteristic-value-reference",
        "documentation": "multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true. multipleOr: The parameter may only have one value (no comma separators)."
      } ],
      "supportedProfile": [ "http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-group", "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-group" ]
    } ],
    "security": {
      "description": "1. See the [US Core Security Considerations](http://hl7.org/fhir/us/core/security.html) section for requirements and recommendations. 2. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
    },
    "documentation": "The PDex Provider Access Server **SHALL**: \n1. Support the US Core 3.1.1 or US Core 6.1.0 resources accessed via the Group resource.\n2. Implement the RESTful behavior according to the FHIR specification for bulk asynchronous access.\n3. Support json source formats for all US Core and PDex interactions. \n4. Return the following response classes:\n  - (Status 400): invalid parameter\n  - (Status 401/4xx): unauthorized request\n  - (Status 403): insufficient scope \n  - (Status 404): unknown resource \n  - (Status 410): deleted resource.\n\nThe PDex Provider Access Server **SHOULD**: \n1. Identify the US Core profiles supported as part of the FHIR `meta.profile` attribute for each instance."
  } ]
}