Argonaut Data Query Implementation Guide Version 1.0.0

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

Argonaut Data Query Implementation Guide Client

Formats: XML, JSON, Turtle

Argonaut Data Query Implementation Guide Client

FHIR Version: 1.0.2
Supported formats: xml , json
Published: 2016-10-18
Published by: Argonaut Project

This Conformance instance defines the expected capabilities of a client when conforming to the Argonaut Data Query Implementation Guide.


RESTful Behavior



Description:

The Argonaut client SHOULD:

  1. Support fetching and querying of one or more Argonaut profile(s), using the supported RESTful interactions and search parameters declared in the Argonaut Server Conformance Statement

Security:

Argonaut Data Query clients SHALL implement the security requirements documented in this guide


Supported Operations: SHALL Support docref

Resource  Details:


  1. Resource Type: Patient

    Supported Profiles:  Argonaut Data Query Patient Profile

    Summary of Argonaut Search Criteria for StructureDefinition-us-core-patient

    • A client has connected to a server and fetched a patient using GET [base]/Patient/[id].
    • A client has connected to a server and searched through available Patients using at least 2 (example name and gender) of the following search parameters:
      • name
      • gender
      • birthdate

    To limit overly broad search results, a client search with gender SHOULD include family and given name search parameters.


  2. Resource Type: AllergyIntolerance

    Supported Profiles:  Argonaut Data Query AllergyIntolerance Profile

    Summary of Argonaut Search Criteria for StructureDefinition-us-core-allergintolerance

    • A client has connected to a server and fetched a patient's allergies using GET /AllergyIntolerance?patient=[id].


  3. Resource Type: CarePlan

    Supported Profiles:  Argonaut Data Query CarePlan Profile
    Argonaut Data Query CareTeam Profile

    Summary of Argonaut Search Criteria for StructureDefinition-us-core-careplan

    • c of a patient's Assessment and Plan of Treatment information using GET /CarePlan?patient=[id]&category=assess-plan.
    • A client has connected to a server and fetched all of a patient's Assessment and Plan of Treatment information over a specified time period using GET /CarePlan?patient=[id]&category=assess-plan&date=[date].
    • A client SHOULD be capable of connecting to a server and fetching all of a patient's active Assessment and Plan of Treatment information using GET /CarePlan?patient=[id]&category=assess-plan&status=active.
    • A client SHOULD be capable of connecting to a server and fetching all of a patient's active Assessment and Plan of Treatment information over a specified time period using GET /CarePlan?patient=[id]&category=assess-plan&status=active&date=[date].

    Summary of Argonaut Search Criteria for StructureDefinition-argo-careteam

    • A client has connected to a server and fetched a patients current care team members using GET[base]/CarePlan?patient=[id]&category=careteam&status=active


  4. Resource Type: Condition

    Supported Profiles:  Argonaut Data Query Condition Profile

    Summary of Argonaut Search Criteria for StructureDefinition-us-core-condition

    • A client connected to a server and fetched all problems and health concerns for a patient, including current as well as historical problems and health concerns using GET/Condition?patient=[id]


  5. Resource Type: Device

    Supported Profiles:  Argonaut Data Query Device Profile

    Summary of Argonaut Search Criteria for StructureDefinition-us-core-device

    • A client has connected to a server and fetched all Unique device identifier(s)(UDI)for a patient's implantable device(s)using GET /Device?patient=[id].


  6. Resource Type: DocumentReference

    Supported Profiles:  Argonaut Data Query Document Reference Profile

    Search Criteria for StructureDefinition-argo-documentreference

    The Server SHALL support fetching document references using either the direct query for DocumentReference resources as described here or the $docref operation. The Client SHALL support both methods.

    A client has connected to a server and fetches document references for a patient:

    • GET [base]/DocumentReference/$docref?patient=[id]

    A client SHOULD be capable of connecting to a server and fetching references for a patient searched by type and/or date using:

    • GET [base]/DocumentReference/$docref?patient=[id]{&type=[type]}{&period=[date]}

    Supported Search Combinations: patient + type + period


  7. Resource Type: Goal

    Supported Profiles:  Argonaut Data Query Goal Profile

    Summary of US Core Search Criteria for StructureDefinition-us-core-goal

    • A client has connected to a server and fetched all of a patient's goals using GET [base]/Goal?patient=[id].
    • A client has connected to a server and fetched all of a patient's goals over a specified time period using GET [base]/Goal?patient=[id]&date=[date]{&date=[date]}.


  8. Resource Type: Immunization

    Supported Profiles:  Argonaut Data Query Immunization Profile

    Summary of Argonaut Search Criteria for StructureDefinition-us-core-immunization

    • A client has connected to a server and fetched all immunizations for a patient using GET /Immunization?patient=[id].


  9. Resource Type: DiagnosticReport

    Supported Profiles:  Argonaut Data Query DiagnosticReport Profile

    Summary of Argonaut Search Criteria for StructureDefinition-us-core-diagnosticreport

    • A client has connected to a server and fetched all of a patient's laboratory diagnostic reports by searching by category using GET [base]/DiagnosticReport?patient=[id]&category=LAB.
    • A client has connected to a server and fetched all of a patient's laboratory diagnostic reports searching by category code and date range using GET [base]/DiagnosticReport?patient=[id]&category=LAB&date=[date]{&date=[date]}.
    • A client has connected to a server and fetched all of all of a patient's laboratory diagnostic reports searching by category and code using GET [base]/DiagnosticReport?patient=[id]&category=LAB&code=[LOINC].
    • A client SHOULD be capable of connecting to a server and fetching any of a patient's laboratory diagnostic reports searching by category and one or more codes and date range using GET [base]/DiagnosticReport?patient=[id]&category=LAB&code=[LOINC1{,LOINC2,LOINC3,...}]&date=[date]{&date=[date]}.


  10. Resource Type: Observation

    Supported Profiles:  Argonaut Data Query Result Observation Profile
    Argonaut Data Query Vital Signs Profile
    Argonaut Data Query Smoking Status Observation Profile

    Summary of Argonaut Search Criteria for StructureDefinition-us-core-observationresults

    • A client has connected to a server and fetched all of a patient's laboratory results by searching by category using GET [base]/Observation?patient=[id]&category=laboratory.
    • A client has connected to a server and fetched all of a patient's laboratory results searching by category code and date range using GET [base]/Observation?patient=[id]&category=laboratory&date=[date]{&date=[date]}.
    • A client has connected to a server and fetched all of all of a patient's laboratory results searching by category and code using GET [base]/Observation?patient=[id]&category=laboratory&code=[LOINC].
    • A client SHOULD be capable of connecting to a server and fetching any of a patient's laboratory results searching by category and one or more codes and date range using GET [base]/Observation?patient=[id]&category=laboratory&code=[LOINC1{,LOINC2,LOINC3,...}]&date=[date]{&date=[date]}.

    Summary of Argonaut Search Criteria for StructureDefinition-us-core-smokingstatus

    • A client has connected to a server and fetched a patient's smoking status using GET [base]/Observation?patient=[id]&code=72166-2.

    Summary of Argonaut Search Criteria for StructureDefinition-us-core-vitalsigns

    • A client has connected to a server and fetched all of a patient's vital signs by searching by category using GET [base]/Observation?patient=[id]&category=vital-signs.
    • A client has connected to a server and fetched all of a patient's vital signs searching by category code and date range using GET [base]/Observation?patient=[id]&category=vital-signs&date=[date]{&date=[date]}.
    • A client has connected to a server and fetched any of a patient's vital signs by searching by one or more of the codes listed below using GET [base]/Observation?patient=[id]&code[vital sign LOINC{,LOINC2,LOINC3,...}].
    • A client SHOULD be capable of connecting to a server and fetching any of a patient's vital signs searching by one or more of the codes listed below and date range using GET [base]/Observation?patient=[id]&code=[LOINC{,LOINC2...}]vital-signs&date=[date]{&date=[date]}.


  11. Resource Type: Medication

    Supported Profiles:  Argonaut Data Query Medication Profile

    The MedicationStatement and MedicationOrder resources can represent a medication, using either a code or refer to a [Medication] resource. If the Medication Resource is used in a MedicationStatement or a MedicationOrder, then the READ and SEARCH Criteria SHALL be supported.


  12. Resource Type: MedicationStatement

    Supported Profiles:  Argonaut Data Query MedicationStatement Profile

    Summary of US Core Search Criteria for StructureDefinition-us-core-medicationstatement

    The MedicationStatement and MedicationOrder resources can represent a medication, using either a code or refer to a Medication resource. When referencing a Medication resource, the resource may be contained or an external resource. The server application can choose any one way or more than one method, but IF the an external reference to Medication is used, the server SHALL support the include parameter for searching this element. The client application SHALL support both methods.

    • A client has connected to a server and fetched a patient's medications using:
    1. GET /MedicationStatement?patient=[id]
    2. GET /MedicationStatement?patient=[id]&_include=MedicationStatement:medication


  13. Resource Type: MedicationOrder

    Supported Profiles:  Argonaut Data Query MedicationOrder Profile

    Summary of US Core Search Criteria for StructureDefinition-us-core-medicationorder

    The MedicationStatement and MedicationOrder resources can represent a medication, using either a code or refer to a Medication resource. When referencing a Medication resource, the resource may be contained or an external resource. The server application can choose any one way or more than one method, but IF the an external reference to Medication is used, the server SHALL support the include parameter for searching this element. The client application SHALL support both methods.

    • A client has connected to a server and fetched a patient's medications using:
    1. GET /MedicationOrder?patient=[id]
    2. GET /MedicationOrder?patient=[id]&_include=MedicationOrder:medication


  14. Resource Type: Procedure

    Supported Profiles:  Argonaut Data Query Procedure Profile

    Summary of US Core Search Criteria for StructureDefinition-us-core-procedure

    • A client connected to a server and fetched all procedures for a patient, including current as well as historical Procedures GET/Procedure?patient=[id].
    • A client has connected to a server and fetched all of a patient's procedures over a specified time period using GET /Procedure?patient=[id]&date=[date]{&date=[date]}.