| Package | fhir.argonaut.clinicalnotes |
| Type | CapabilityStatement |
| Id | argonaut-clinical-notes-server |
| FHIR Version | R3 |
| Source | http://fhir.org/guides/argonaut/clinicalnotes/http://fhir.org/guides/argonaut/clinicalnotes/1.0.0/CapabilityStatement-argonaut-clinical-notes-server.html |
| URL | http://fhir.org/guides/argonaut/clinicalnotes/CapabilityStatement/argonaut-clinical-notes-server |
| Version | 1.0.0 |
| Status | active |
| Date | 2019-03-04T00:00:00+11:00 |
| Name | clinical_notes |
| Title | Argonaut Clinical Notes CapabilityStatement |
| Realm | us |
| Authority | hl7 |
| 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. |
| Kind | requirements |
No resources found
| ImplementationGuide | |
| argonaut.us.clinicalnotes-1.0.0 | Argonaut Clinical Notes |
Note: links and images are rebased to the (stated) source
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.
The Argonaut Clinical Notes Data Query Server SHALL:
Security:
For general security consideration refer to the Security and Privacy Considerations.
Summary of Operations
FHIR$expand operation.Summary of Search Criteria
| Resource Type | Supported Profiles | Supported Searches | Supported Includes |
|---|---|---|---|
| DocumentReference | _id, class, created, patient, type, class+created+patient, class+patient, created+patient, created+patient+type, patient+type | ||
| DiagnosticReport | Argonaut Diagnostic Report Profile for Report and Note exchange | _id, category, code, patient, date, category+date+patient, category+patient, code+date+patient, code+patient, date+patient | |
| Binary | _id |
Supported Profiles:
Argonaut Clinical Notes Profile
created, class, and type MAY NOT be available as a single search parameter but SHALL be available in the combinations listed below.Reference Policy: resolves
Versioning Policy: versioned
Profile Interaction Summary:
create,
read,
delete.Fetch and Search Criteria:
GET [base]/DocumentReference/[id]
Search Parameter Summary:
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | _id | token | GET [base]/DocumentReference?_id=[id] |
| SHALL | class | token | GET [base]/DocumentReference?class=[system]|[code] |
| SHALL | created | date | GET [base]/DocumentReference?created=[created] |
| SHALL | subject | reference | GET [base]/DocumentReference?patient=[patient] |
| SHALL | type | token | GET [base]/DocumentReference?type=[system]|[code] |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Example |
|---|---|---|
| SHALL | class+created+patient | GET [base]/DocumentReference?class=[system]|[code]&created=[created]&patient=[patient] |
| SHALL | class+patient | GET [base]/DocumentReference?class=[system]|[code]&patient=[patient] |
| SHALL | created+patient | GET [base]/DocumentReference?created=[created]&patient=[patient] |
| SHALL | created+patient+type | GET [base]/DocumentReference?created=[created]&patient=[patient]&type=[system]|[code] |
| SHALL | patient+type | GET [base]/DocumentReference?patient=[patient]&type=[system]|[code] |
Supported Profiles:
Argonaut Diagnostic Report Profile for Report and Note exchange
date, category, and code MAY NOT be available as a single search parameter but SHALL be available in the combinations listed below.Reference Policy: resolves
Versioning Policy: versioned
Profile Interaction Summary:
create,
read,
delete.Fetch and Search Criteria:
GET [base]/DiagnosticReport/[id]
Search Parameter Summary:
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | _id | token | GET [base]/DiagnosticReport?_id=[id] |
| SHOULD | category | token | GET [base]/DiagnosticReport?category=[system]|[code] |
| SHALL | code | token | GET [base]/DiagnosticReport?code=[system]|[code] |
| SHALL | patient | reference | GET [base]/DiagnosticReport?patient=[patient] |
| SHOULD | date | date | GET [base]/DiagnosticReport?date=[date] |
Search Parameter Combination Summary:
| Conformance | Parameter Combination | Example |
|---|---|---|
| SHOULD | category+date+patient | GET [base]/DiagnosticReport?category=[system]|[code]&date=[date]&patient=[patient] |
| SHALL | category+patient | GET [base]/DiagnosticReport?category=[system]|[code]&patient=[patient] |
| SHOULD | code+date+patient | GET [base]/DiagnosticReport?code=[system]|[code]&date=[date]&patient=[patient] |
| SHALL | code+patient | GET [base]/DiagnosticReport?code=[system]|[code]&patient=[patient] |
| SHOULD | date+patient | GET [base]/DiagnosticReport?date=[date]&patient=[patient] |
Reference Policy: resolves
Versioning Policy: versioned
Profile Interaction Summary:
read.Fetch and Search Criteria:
GET [base]/Binary/[id]
Search Parameter Summary:
| Conformance | Parameter | Type | Example |
|---|---|---|---|
| SHALL | _id | token | GET [base]/Binary?_id=[id] |
{
"resourceType": "CapabilityStatement",
"id": "argonaut-clinical-notes-server",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "http://fhir.org/guides/argonaut/clinicalnotes/CapabilityStatement/argonaut-clinical-notes-server",
"version": "1.0.0",
"name": "clinical_notes",
"title": "Argonaut Clinical Notes CapabilityStatement",
"status": "active",
"experimental": false,
"date": "2019-03-04T00:00:00+11:00",
"publisher": "The Argonaut Project",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "https://github.com/argonautproject/questionnaire/issues"
}
]
}
],
"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.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US",
"display": "United States of America"
}
]
}
],
"kind": "requirements",
"fhirVersion": "3.0.1",
"format": [
"xml",
"json"
],
"patchFormat": [
"application/json-patch+json"
],
"implementationGuide": [
"http://fhir.org/guides/argonaut/clinicalnotes/ImplementationGuide/argonaut.us.clinicalnotes-1.0.0"
],
"rest": [
{
"mode": "server",
"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.",
"security": {
"description": "For general security consideration refer to the [Security and Privacy Considerations](https://argonautproject.github.io/questionnaire/index.html#security-and-privacy-considerations)."
},
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"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"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "DocumentReference",
"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.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"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"
}
],
"versioning": "versioned",
"readHistory": false,
"updateCreate": false,
"referencePolicy": [
"resolves"
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "class",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-class",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-created",
"type": "date"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-subject",
"type": "reference"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"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"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type": "DiagnosticReport",
"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.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"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"
}
],
"versioning": "versioned",
"readHistory": false,
"updateCreate": false,
"referencePolicy": [
"resolves"
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-category",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"type": "date"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"type": "Binary",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
}
],
"versioning": "versioned",
"readHistory": false,
"updateCreate": false,
"referencePolicy": [
"resolves"
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token"
}
]
}
],
"operation": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "expand",
"definition": {
"reference": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand"
}
}
]
}
]
}