{
  "description": "This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Consumer  in *Client* mode when requesting clinical data from the Data Source  during clinical data exchange. The capabilities include one or more of the following interactions:\\n\\n1. Requesting Clinical Data using a FHIR RESTful query\\n2. Requesting Attachments\\n3. POSTing a Task resource representing a request for clinical data\\n4. POSTing a Subscription resource\\n5. Polling a Task resource",
  "_filename": "CapabilityStatement-data-consumer-client.json",
  "package_name": "hl7.fhir.us.davinci-cdex",
  "format": [ "json", "xml" ],
  "_patchFormat": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "MAY"
    } ]
  } ],
  "_format": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHALL"
    } ]
  }, {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "MAY"
    } ]
  } ],
  "date": "2022-07-22T17:11:29.853589-08:00",
  "publisher": "HL7 International - Patient Care Work Group",
  "patchFormat": [ "application/json-patch+json" ],
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "US",
      "system": "urn:iso:std:iso:3166"
    } ]
  } ],
  "instantiates": [ "http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-consumer-client", "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client" ],
  "name": "DataConsumerClientCapabilityStatement",
  "_instantiates": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHALL"
    } ]
  }, {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHALL"
    } ]
  } ],
  "copyright": "Used by permission of HL7 International all rights reserved Creative Commons License",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "Data Consumer Client CapabilityStatement",
  "package_version": "1.1.0",
  "status": "active",
  "id": "8eb1529a-c9d7-4a36-8416-4b7b257955dc",
  "kind": "requirements",
  "implementationGuide": [ "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|3.1.1", "http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/hl7.fhir.us.davinci-hrex|1.0.0" ],
  "url": "http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-consumer-client",
  "version": "1.1.0",
  "contact": [ {
    "name": "HL7 International - Patient Care Work Group",
    "telecom": [ {
      "value": "http://www.hl7.org/Special/committees/patientcare",
      "system": "url"
    }, {
      "value": "patientcare@lists.HL7.org",
      "system": "email"
    } ]
  } ],
  "rest": [ {
    "mode": "client",
    "resource": [ {
      "type": "Bundle",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "interaction": [ {
        "code": "create",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "update",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "patch",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "delete",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      } ],
      "documentation": "Required resource type to fetch Clinical Information from data source. **SHALL** support CDex Signature Bundle Profile for signed Bundles.\n",
      "supportedProfile": [ "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-signature-bundle" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      } ]
    }, {
      "type": "Provenance",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "interaction": [ {
        "code": "create",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "update",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "patch",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "delete",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      } ],
      "documentation": "Required resource type to fetch provenance along with clinical information"
    }, {
      "type": "Subscription",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "interaction": [ {
        "code": "create",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "update",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "patch",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "delete",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      } ],
      "documentation": "Required resource type to subscribe to data source for Task-based requests."
    }, {
      "type": "Task",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "interaction": [ {
        "code": "create",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "update",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      }, {
        "code": "patch",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "delete",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      } ],
      "documentation": "Required resource type to request and fetch clinical information from data source using Task-based requests. **SHALL** support *CDex Task Data Request Profile* and/or *CDex Task Attachment Request Profile*.",
      "supportedProfile": [ "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-data-request", "http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-task-attachment-request" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    } ],
    "security": {
      "description": "1. For general security consideration refer to the [Security and Privacy Considerations](http://build.fhir.org/secpriv-module.html). \n1. For security considerations specific to this guide refer to the Da Vinci HRex Implementation Guide section on [Security and Privacy](http://hl7.org/fhir/us/davinci-hrex/security.html)\n"
    },
    "interaction": [ {
      "code": "transaction",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ]
    }, {
      "code": "batch",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ]
    }, {
      "code": "search-system",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ]
    }, {
      "code": "history-system",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ]
    } ],
    "documentation": "The  Da Vinci CDex Data Consumer Client  **SHALL**:\n\n1. Support at least one of the CDex approaches for exchanging clinical information:\n     1. Direct Query\n     1. Task-Based Approach\n     1. Attachments\n2. Follow the guidelines for [Generating and Verifying Signed Resources](signatures.html) *if signatures are required*.\n3. Support JSON source formats for all Da Vinci CDex interactions.\n4. Declare a CapabilityStatement identifying the scenarios, transactions, and profiles supported.\n\nThe  Da Vinci CDex Data Consumer Client **MAY**:\n\n1. Support XML source formats for all Da Vinci CDex interactions.\n   \n   > Implementers that choose to support XML need to be aware that JSON Web Signatures can only be created and validated in the original native JSON. Transforms to and from XML will invalidate signatures."
  } ],
  "_implementationGuide": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHALL"
    } ]
  }, {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHOULD"
    } ]
  } ]
}