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 in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
FHIR Version:
1.0.2
Supported formats:
xml
,
json
Published:
2016-12-15
Published by:
Argonaut Project
This profile defines the expected capabilities of a Argonaut Data Query server when conforming to the Argonaut Data Query IG The conformance resource includes the complete list of actual 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 Data Query Server SHALL:
The Argonaut Data Query Server SHOULD:
Argonaut Data Query Servers SHALL
Authorization: Bearer {server-specific-token-here}
HTTP 401
Unauthorized response code.
All servers
SHALL
make available the
read
and
search-type
interactions for the Argonaut Profiles the server chooses to support.
All servers
SHOULD
make available the
vread
and
history-instance
interactions for the Argonaut Profiles the server chooses to support.
Summary of Argonaut Profile search criteria. Specific server search capabilities are described in detail below in each of the resource sections.
Resource Type | Supported Profiles | Supported Searches | Supported Includes |
---|---|---|---|
Patient |
|
name
,
family
,
given
,
identifier
,
gender
,
birthdate
name + gender , name + birthdate , family + gender , given + gender |
|
AllergyIntolerance |
|
patient
|
|
CarePlan |
|
patient
,
category
,
status
,
date
patient + category , patient + category + date , patient + category + status , patient + category + status + date |
|
Condition |
|
patient
,
category
,
clinicalstatus
patient + clinicalstatus , patient + category |
|
Device |
|
patient
|
|
DocumentReference |
|
patient
,
period
,
type
patient + type + period |
|
Goal |
|
patient
,
date
patient + date |
|
Immunization |
|
patient
|
|
DiagnosticReport |
|
patient
,
category
,
code
,
date
patient + category , patient + category + date , patient + category + code , patient + category + code + date |
|
Medication |
|
|
|
MedicationStatement |
|
patient
|
MedicationStatement.medicationReference |
MedicationOrder |
|
patient
|
MedicationOrder.medicationReference |
Observation |
|
patient
,
category
,
code
,
date
patient + category , patient + category + date , patient + category + code , patient + category + code + date |
|
Procedure |
|
patient
,
date
patient + date |
Supported Profiles:
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-patient
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | name | string | |
SHALL | family | string | |
SHALL | given | string | |
SHALL | identifier | token | |
SHALL | gender | token | |
SHALL | birthdate | date |
Supported Search Combinations: name + gender , name + birthdate , family + gender , given + gender
Supported Profiles:
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-allergyintolerance
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | patient | reference |
Supported Profiles:
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-careplan
A server SHOULD be capable of returning 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 server SHOULD be capable returning 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].
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | patient | reference | |
SHALL | category | token | |
SHOULD | status | token | |
SHOULD | date | date |
The server SHALL support the date search modifiers ‘ge’,‘le’,‘gt','lt' for this profile |
Supported Search Combinations: patient + category , patient + category + date , patient + category + status , patient + category + status + date
Supported Profiles:
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-condition
A server is capable of returning a patient’s conditions list using GET/Condition?patient=[id].
A server SHOULD be capable returning all of a patient’s problems or all of patient’s health concerns using ‘GET /Condition?patient=[id]&category=[problem|health-concern]’
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | patient | reference | |
SHOULD | category | token | |
SHOULD | clinicalstatus | token |
Supported Search Combinations: patient + clinicalstatus , patient + category
Supported Profiles:
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-device
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | patient | reference |
Supported Profiles:
The Client SHALL support both methods.
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | patient | reference | |
SHOULD | period | date |
The server SHALL support the date search modifiers ‘ge’,‘le’,‘gt','lt' for this profile |
SHOULD | type | token |
Supported Search Combinations: patient + type + period
Supported Profiles:
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-device
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | patient | reference | |
SHALL | date | date |
The server SHALL support the date search modifiers ‘ge’,‘le’,‘gt','lt' for this profile |
Supported Search Combinations: patient + date
Supported Profiles:
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-immunization
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | patient | reference |
Supported Profiles:
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-diagnosticreport
A server is capable of returning all of a patient’s laboratory diagnostic reports queried by category and code using GET [base]/DiagnosticReport?patient=[id]&category=LAB&code=[LOINC].
A server SHOULD be capable of returning all of a patient’s laboratory diagnostic reports queried 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]}.
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | patient | reference | |
SHALL | category | token | |
SHALL | code | token | |
SHALL | date | date |
The server SHALL support the date search modifiers ‘ge’,‘le’,‘gt','lt' for this profile |
Supported Search Combinations: patient + category , patient + category + date , patient + category + code , patient + category + code + date
Supported Profiles:
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.
Search Parameters:Conformance | Parameter | Type | Modifiers |
---|---|---|---|
Supported Profiles:
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-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 must support both methods.
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | patient | reference |
Supported Includes: MedicationStatement.medicationReference
Supported Profiles:
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-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 must support both methods.
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | patient | reference |
Supported Includes: MedicationOrder.medicationReference
Supported Profiles:
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-observationresults
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-smokingstatus
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-vitalsigns
A server is capable of returning any of a patient’s vital signs queried by one or more of the codes listed below using GET [base]/Observation?patient=[id]&code[vital sign LOINC{,LOINC2,LOINC3,…}].
A server SHOULD be capable of returning any of a patient’s vital signs queried 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]}.
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | patient | reference | |
SHALL | category | token | |
SHALL | code | token | |
SHALL | date | date |
The server SHALL support the date search modifiers ‘ge’,‘le’,‘gt','lt' for this profile |
Supported Search Combinations: patient + category , patient + category + date , patient + category + code , patient + category + code + date
Supported Profiles:
Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-procedure
Conformance | Parameter | Type | Modifiers |
---|---|---|---|
SHALL | patient | reference | |
SHALL | date | date |
The server SHALL support the date search modifiers ‘ge’,‘le’,‘gt','lt' for this profile |
Supported Search Combinations: patient + date