Argonaut Clinical Notes Implementation Guide (Release 1.0.0 )

This page is part of the Argonaut Clinical Notes Implementation Guide (v1.0.0: Release) based on FHIR R3. This is the current published version. For a full list of available versions, see the Directory of published versions

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 TypeSupported ProfilesSupported SearchesSupported 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:

    ConformanceParameterTypeExample
    SHOULD_id token GET [base]/DocumentReference?_id=[id]
    SHOULDclass token GET [base]/DocumentReference?class=[system]|[code]
    SHOULDcreated token GET [base]/DocumentReference?created=[system]|[code]
    SHOULDpatient reference GET [base]/DocumentReference?patient=[patient]
    SHOULDtype token GET [base]/DocumentReference?type=[system]|[code]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationExample
    SHOULDclass+created+patient GET [base]/DocumentReference?class=[system]|[code]&created=[system]|[code]&patient=[patient]
    SHOULDclass+patient GET [base]/DocumentReference?class=[system]|[code]&patient=[patient]
    SHOULDcreated+patient GET [base]/DocumentReference?created=[system]|[code]&patient=[patient]
    SHOULDcreated+patient+type GET [base]/DocumentReference?created=[system]|[code]&patient=[patient]&type=[system]|[code]
    SHOULDpatient+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:

    ConformanceParameterTypeExample
    SHOULD_id token GET [base]/DiagnosticReport?_id=[id]
    SHOULDcategory token GET [base]/DiagnosticReport?category=[system]|[code]
    SHOULDcode token GET [base]/DiagnosticReport?code=[system]|[code]
    SHOULDpatient reference GET [base]/DiagnosticReport?patient=[patient]
    SHOULDdate date GET [base]/DiagnosticReport?date=[date]

    Search Parameter Combination Summary:

    ConformanceParameter CombinationExample
    SHOULDcategory+date+patient GET [base]/DiagnosticReport?category=[system]|[code]&date=[date]&patient=[patient]
    SHOULDcategory+patient GET [base]/DiagnosticReport?category=[system]|[code]&patient=[patient]
    SHOULDcode+date+patient GET [base]/DiagnosticReport?code=[system]|[code]&date=[date]&patient=[patient]
    SHOULDcode+patient GET [base]/DiagnosticReport?code=[system]|[code]&patient=[patient]
    SHOULDdate+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:

    ConformanceParameterTypeExample
    SHOULD_id token GET [base]/Binary?_id=[id]