XIG: CapabilityStatement/argonaut-clinical-notes-client

FHIR IG Statistics: CapabilityStatement/argonaut-clinical-notes-client

Package	fhir.argonaut.clinicalnotes
Type	CapabilityStatement
Id	argonaut-clinical-notes-client
FHIR Version	R3
Source	http://fhir.org/guides/argonaut/clinicalnotes/http://fhir.org/guides/argonaut/clinicalnotes/1.0.0/CapabilityStatement-argonaut-clinical-notes-client.html
URL	http://fhir.org/guides/argonaut/clinicalnotes/CapabilityStatement/argonaut-clinical-notes-client
Version	1.0.0
Status	active
Date	2019-03-04T00:00:00+11:00
Name	clinical_notes_client
Title	Argonaut Clinical Notes Client CapabilityStatement
Realm	us
Authority	hl7
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.
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
argonaut.us.clinicalnotes-1.0.0	Argonaut Clinical Notes

Narrative

Note: links and images are rebased to the (stated) source

Argonaut Clinical Notes Client CapabilityStatement

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.

FHIR Version: 3.0.1
Supported formats: xml, json
Published: 2019-03-04
Published by: The Argonaut Project

FHIR RESTful Capabilities

The Argonaut Clinical Notes Data Query Client SHALL:

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.

Security:

For general security consideration refer to the Security and Privacy Considerations.

RESTful Capabilities by Resource/Profile:

Summary of Operations

SHOULD support the $expand operation.

Summary of Search Criteria

Resource Type	Supported Profiles	Supported Searches
DocumentReference	Argonaut Clinical Notes Profile	_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

Resource Type

Supported Profiles

Supported Searches

Supported Includes

DocumentReference

Argonaut Clinical Notes Profile

_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

DocumentReference

Supported Profiles:

Argonaut Clinical Notes Profile

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.

Profile Interaction Summary:

SHOULD support create, read, delete.

Fetch and Search Criteria:

A Client SHOULD be capable of fetching a DocumentReference resource using:
GET [base]/DocumentReference/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD _id token GET [base]/DocumentReference?_id=[id]

SHOULD class token GET [base]/DocumentReference?class=[system]|[code]

SHOULD created token GET [base]/DocumentReference?created=[system]|[code]

SHOULD patient reference GET [base]/DocumentReference?patient=[patient]

SHOULD type token GET [base]/DocumentReference?type=[system]|[code]

Conformance	Parameter	Type	Example
SHOULD	_id	token	`GET [base]/DocumentReference?_id=[id]`
SHOULD	class	token	`GET [base]/DocumentReference?class=[system]\|[code]`
SHOULD	created	token	`GET [base]/DocumentReference?created=[system]\|[code]`
SHOULD	patient	reference	`GET [base]/DocumentReference?patient=[patient]`
SHOULD	type	token	`GET [base]/DocumentReference?type=[system]\|[code]`

Search Parameter Combination Summary:

Conformance Parameter Combination Example

SHOULD class+created+patient GET [base]/DocumentReference?class=[system]|[code]&created=[system]|[code]&patient=[patient]

SHOULD class+patient GET [base]/DocumentReference?class=[system]|[code]&patient=[patient]

SHOULD created+patient GET [base]/DocumentReference?created=[system]|[code]&patient=[patient]

SHOULD created+patient+type GET [base]/DocumentReference?created=[system]|[code]&patient=[patient]&type=[system]|[code]

SHOULD patient+type GET [base]/DocumentReference?patient=[patient]&type=[system]|[code]

Conformance	Parameter Combination	Example
SHOULD	class+created+patient	`GET [base]/DocumentReference?class=[system]\|[code]&created=[system]\|[code]&patient=[patient]`
SHOULD	class+patient	`GET [base]/DocumentReference?class=[system]\|[code]&patient=[patient]`
SHOULD	created+patient	`GET [base]/DocumentReference?created=[system]\|[code]&patient=[patient]`
SHOULD	created+patient+type	`GET [base]/DocumentReference?created=[system]\|[code]&patient=[patient]&type=[system]\|[code]`
SHOULD	patient+type	`GET [base]/DocumentReference?patient=[patient]&type=[system]\|[code]`

DiagnosticReport

Supported Profiles:

Argonaut Diagnostic Report Profile for Report and Note exchange

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.

Profile Interaction Summary:

SHOULD support create, read, delete.

Fetch and Search Criteria:

A Client SHOULD be capable of fetching a DiagnosticReport resource using:
GET [base]/DiagnosticReport/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD _id token GET [base]/DiagnosticReport?_id=[id]

SHOULD category token GET [base]/DiagnosticReport?category=[system]|[code]

SHOULD code token GET [base]/DiagnosticReport?code=[system]|[code]

SHOULD patient reference GET [base]/DiagnosticReport?patient=[patient]

SHOULD date date GET [base]/DiagnosticReport?date=[date]

Conformance	Parameter	Type	Example
SHOULD	_id	token	`GET [base]/DiagnosticReport?_id=[id]`
SHOULD	category	token	`GET [base]/DiagnosticReport?category=[system]\|[code]`
SHOULD	code	token	`GET [base]/DiagnosticReport?code=[system]\|[code]`
SHOULD	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]

SHOULD category+patient GET [base]/DiagnosticReport?category=[system]|[code]&patient=[patient]

SHOULD code+date+patient GET [base]/DiagnosticReport?code=[system]|[code]&date=[date]&patient=[patient]

SHOULD code+patient GET [base]/DiagnosticReport?code=[system]|[code]&patient=[patient]

SHOULD date+patient GET [base]/DiagnosticReport?date=[date]&patient=[patient]

Conformance	Parameter Combination	Example
SHOULD	category+date+patient	`GET [base]/DiagnosticReport?category=[system]\|[code]&date=[date]&patient=[patient]`
SHOULD	category+patient	`GET [base]/DiagnosticReport?category=[system]\|[code]&patient=[patient]`
SHOULD	code+date+patient	`GET [base]/DiagnosticReport?code=[system]\|[code]&date=[date]&patient=[patient]`
SHOULD	code+patient	`GET [base]/DiagnosticReport?code=[system]\|[code]&patient=[patient]`
SHOULD	date+patient	`GET [base]/DiagnosticReport?date=[date]&patient=[patient]`

Binary

Profile Interaction Summary:

SHOULD support read.

Fetch and Search Criteria:

A Client SHOULD be capable of fetching a Binary resource using:
GET [base]/Binary/[id]

Search Parameter Summary:

Conformance Parameter Type Example

SHOULD _id token GET [base]/Binary?_id=[id]

Conformance	Parameter	Type	Example
SHOULD	_id	token	`GET [base]/Binary?_id=[id]`

Source

{
  "resourceType": "CapabilityStatement",
  "id": "argonaut-clinical-notes-client",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.org/guides/argonaut/clinicalnotes/CapabilityStatement/argonaut-clinical-notes-client",
  "version": "1.0.0",
  "name": "clinical_notes_client",
  "title": "Argonaut Clinical Notes Client 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 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. ",
  "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": "client",
      "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.",
      "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": "SHOULD"
            },
            {
              "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"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "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"
            }
          ],
          "readHistory": false,
          "updateCreate": false,
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "class",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-class",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "created",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-created",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "subject",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-subject",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "type",
              "definition": "http://fhir.org/guides/argonaut/clinicalnotes/SearchParameter/DocumentReference-type",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            },
            {
              "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"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "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"
            }
          ],
          "readHistory": false,
          "updateCreate": false,
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "code": "read"
            }
          ],
          "readHistory": false,
          "updateCreate": false,
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "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"
          }
        }
      ]
    }
  ]
}