{ "description": "This profile defines the expected capabilities of an Argonaut Data Query server when conforming to the Argonaut Data Query Clinical Notes IG. The CapabilityStatement resource includes the complete list of actual Clinical Notes profiles, RESTful operations, and search parameters supported by Argonaut Data Query Servers. Servers have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.", "_filename": "CapabilityStatement-argonaut-clinical-notes-server.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", "type": null, "experimental": "false", "resourceType": "CapabilityStatement", "title": "Argonaut Clinical Notes CapabilityStatement", "package_version": "1.0.0", "status": "active", "id": "591d9bda-4477-4648-8083-2e4de095b7bf", "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-server", "version": "1.0.0", "contact": [ { "telecom": [ { "value": "https://github.com/argonautproject/questionnaire/issues", "system": "url" } ] } ], "rest": [ { "mode": "server", "resource": [ { "searchParam": [ { "name": "_id", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/Resource-id" }, { "name": "class", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-class" }, { "name": "created", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-created" }, { "name": "subject", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-subject" }, { "name": "type", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-type" } ], "referencePolicy": [ "resolves" ], "readHistory": false, "type": "DocumentReference", "interaction": [ { "code": "create", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] }, { "code": "delete", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "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.", "updateCreate": false, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "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": "SHALL" }, { "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": "SHALL" }, { "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": "SHALL" }, { "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": "SHALL" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "type" } ] } ], "versioning": "versioned" }, { "searchParam": [ { "name": "_id", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "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": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/clinical-code" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "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" } ], "referencePolicy": [ "resolves" ], "readHistory": false, "type": "DiagnosticReport", "interaction": [ { "code": "create", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] }, { "code": "delete", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "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.", "updateCreate": false, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "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": "SHALL" }, { "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": "SHALL" }, { "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" } ] } ], "versioning": "versioned" }, { "type": "Binary", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "versioning": "versioned", "interaction": [ { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "readHistory": false, "searchParam": [ { "name": "_id", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "definition": "http://hl7.org/fhir/SearchParameter/Resource-id" } ], "updateCreate": false, "referencePolicy": [ "resolves" ] } ], "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 Server **SHALL**:\n\n1. Implement the RESTful behavior according to the FHIR specification including returning the appropriate response classes as described in the FHIR specification for [FHIR RESTful API](http://hl7.org/fhir/STU3/http.html).\n1. Support json resource formats for all Argonaut Clinical Notes interactions.\n1. Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.\n1. Support xml resource formats for all Argonaut questionnaire interactions." } ] }