{
  "description": "This profile defines the expected capabilities of an Argonaut Data Query Client when conforming to the Argonaut Clinical Notes IG. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Argonaut Servers are defined in the Capability Statements for Server. ",
  "_filename": "CapabilityStatement-argonaut-clinical-notes-client.json",
  "package_name": "fhir.argonaut.clinicalnotes",
  "format": [ "xml", "json" ],
  "date": "2019-03-04T00:00:00+11:00",
  "publisher": "The Argonaut Project",
  "patchFormat": [ "application/json-patch+json" ],
  "fhirVersion": "3.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "US",
      "system": "urn:iso:std:iso:3166",
      "display": "United States of America"
    } ]
  } ],
  "name": "clinical_notes_client",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "Argonaut Clinical Notes Client CapabilityStatement",
  "package_version": "1.0.0",
  "status": "active",
  "id": "54da60b6-0459-4b8c-86d9-8df582344384",
  "kind": "requirements",
  "implementationGuide": [ "http://fhir.org/guides/argonaut/clinicalnotes/ImplementationGuide/argonaut.us.clinicalnotes-1.0.0" ],
  "url": "http://fhir.org/guides/argonaut/clinicalnotes/CapabilityStatement/argonaut-clinical-notes-client",
  "version": "1.0.0",
  "contact": [ {
    "telecom": [ {
      "value": "https://github.com/argonautproject/questionnaire/issues",
      "system": "url"
    } ]
  } ],
  "rest": [ {
    "mode": "client",
    "resource": [ {
      "type": "DocumentReference",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "class"
        }, {
          "url": "required",
          "valueString": "created"
        }, {
          "url": "required",
          "valueString": "patient"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "class"
        }, {
          "url": "required",
          "valueString": "patient"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "created"
        }, {
          "url": "required",
          "valueString": "patient"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "created"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "type"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "patient"
        }, {
          "url": "required",
          "valueString": "type"
        } ]
      } ],
      "interaction": [ {
        "code": "create",
        "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": "delete",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      } ],
      "readHistory": false,
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      }, {
        "name": "class",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-class"
      }, {
        "name": "created",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-created"
      }, {
        "name": "subject",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-subject"
      }, {
        "name": "type",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://fhir.org/guides/argonaut/clinicalnotes/SearchParameter/DocumentReference-type"
      } ],
      "updateCreate": false,
      "documentation": "- The search parameters `created`, `class`, and `type`  MAY NOT be available as a *single* search parameter but SHALL be available in the combinations listed below."
    }, {
      "type": "DiagnosticReport",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "category"
        }, {
          "url": "required",
          "valueString": "date"
        }, {
          "url": "required",
          "valueString": "patient"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "category"
        }, {
          "url": "required",
          "valueString": "patient"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "code"
        }, {
          "url": "required",
          "valueString": "date"
        }, {
          "url": "required",
          "valueString": "patient"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "code"
        }, {
          "url": "required",
          "valueString": "patient"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        }, {
          "url": "required",
          "valueString": "date"
        }, {
          "url": "required",
          "valueString": "patient"
        } ]
      } ],
      "interaction": [ {
        "code": "create",
        "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": "delete",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      } ],
      "readHistory": false,
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      }, {
        "name": "category",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-category"
      }, {
        "name": "code",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-code"
      }, {
        "name": "patient",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient"
      }, {
        "name": "date",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-date"
      } ],
      "updateCreate": false,
      "documentation": "- The search parameters `date`, `category`, and  `code`  MAY NOT be available as a *single* search parameter but SHALL be available in the combinations listed below."
    }, {
      "type": "Binary",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ]
      } ],
      "readHistory": false,
      "searchParam": [ {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id"
      } ],
      "updateCreate": false
    } ],
    "security": {
      "description": "For general security consideration refer to the [Security and Privacy Considerations](https://argonautproject.github.io/questionnaire/index.html#security-and-privacy-considerations)."
    },
    "operation": [ {
      "name": "expand",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHOULD"
      } ],
      "definition": {
        "reference": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand"
      }
    } ],
    "documentation": "The Argonaut Clinical Notes Data Query Client **SHALL**:\n\n- Support fetching and querying one or more Argonaut Clinical Notes profile(s), using the supported RESTful interactions and search parameters declared in the Argnaut Clinical Notes Server CapabilityStatement."
  } ]
}