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 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 
<Conformance xmlns="http://hl7.org/fhir"> <id value="server"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <span style="font-size:larger; font-weight:bold; ">Argonaut Data Query Implementation Guide Server</span> <hr/> <p> <span>FHIR Version: </span> <span>1.0.2</span> <br/> <span>Supported formats: </span> <span>xml</span> <span>, </span> <span>json</span> <br/> <span>Published: </span> <span>2016-12-15</span> <br/> <span>Published by: </span> <span>Argonaut Project</span> </p> <p> <span>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.</span> </p> <br/> <h4> <span style="font-size:larger; font-weight:bold; ">RESTful Behavior</span> </h4> <br/> <hr/> <div> <span>Description: </span> <p> <strong>The Argonaut Data Query Server SHALL:</strong> </p> <ol> <li>Support the Argonaut Data Query Patient resource profile.</li> <li>Support at least one additional resource profile from the list of Argonaut Data Query Profiles</li> <li>Implement REST behavior according to the FHIR specification</li> <li>Support json resource formats for all Argonaut Data Query interactions.</li> <li>Identify the Argonaut Data Query profile(s) supported as part of the <a href="http://build.fhir.org/resource-definitions.html#Meta.profile">FHIR Meta profile attribute</a> for each instance.</li> <li>Declare a Conformance identifying the list of profiles, operations, search parameter supported. </li> </ol> <p> <strong>The Argonaut Data Query Server SHOULD:</strong> </p> <ol> <li>Support xml resource formats for all Argonaut Data Query interactions. </li> </ol> <br/> </div> <div> <span>Security: </span> <p> <strong>Argonaut Data Query Servers SHALL</strong> </p> <ol> <li>implement the <a href="index.html#security">security requirements</a> documented in this guide</li> <li>A server has ensured that every API request includes a valid Authorization token, supplied via: <code>Authorization: Bearer {server-specific-token-here}</code> </li> <li>A server has rejected any unauthorized requests by returning an <code>HTTP 401</code> Unauthorized response code.</li> </ol> <br/> </div> <span>Supported Operations: </span> <span style="font-weight:bold;">MAY</span> <span> Support </span> <a href="http://fhir.org/guides/argonaut/OperationDefinition/docref"> <span>docref</span> </a> <h4> <span style="font-weight:bold; ">Profile Summary:</span> </h4> <p> <br/> <span>All servers </span> <span style="font-weight:bold; ">SHALL</span> <span> make available the </span> <a href="http://build.fhir.org/http.html#read"> <span>read</span> </a> <span> and </span> <a href="http://build.fhir.org/http.html#search-type"> <span>search-type</span> </a> <span> interactions for the Argonaut Profiles the server chooses to support.</span> <br/> <span>All servers </span> <span style="font-weight:bold; ">SHOULD</span> <span> make available the </span> <a href="http://build.fhir.org/http.html#vread"> <span>vread</span> </a> <span> and </span> <a href="http://build.fhir.org/http.html#history-instance"> <span>history-instance</span> </a> <span> interactions for the Argonaut Profiles the server chooses to support.</span> <br/> </p> <br/> <p> <span>Summary of Argonaut Profile search criteria. Specific server search capabilities are described in detail below in each of the resource sections.</span> </p> <br/> <table border="1"> <thead> <tr> <th> <span>Resource Type</span> </th> <th> <span>Supported Profiles</span> </th> <th style="text-align:center; "> <span>Supported Searches</span> </th> <th> <span>Supported Includes</span> </th> </tr> </thead> <tbody> <tr style="height:0.36in; "> <td> <a href="#Patient"> <span>Patient</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>name</span> <span>, </span> <span>family</span> <span>, </span> <span>given</span> <span>, </span> <span>identifier</span> <span>, </span> <span>gender</span> <span>, </span> <span>birthdate</span> <br/> <span>name</span> <span> + </span> <span>gender</span> <span>, </span> <span>name</span> <span> + </span> <span>birthdate</span> <span>, </span> <span>family</span> <span> + </span> <span>gender</span> <span>, </span> <span>given</span> <span> + </span> <span>gender</span> </td> <td> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#AllergyIntolerance"> <span>AllergyIntolerance</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>patient</span> <br/> </td> <td> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#CarePlan"> <span>CarePlan</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>patient</span> <span>, </span> <span>category</span> <span>, </span> <span>status</span> <span>, </span> <span>date</span> <br/> <span>patient</span> <span> + </span> <span>category</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>date</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>status</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>status</span> <span> + </span> <span>date</span> </td> <td> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#Condition"> <span>Condition</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>patient</span> <span>, </span> <span>category</span> <span>, </span> <span>clinicalstatus</span> <br/> <span>patient</span> <span> + </span> <span>clinicalstatus</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> </td> <td> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#Device"> <span>Device</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>patient</span> <br/> </td> <td> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#DocumentReference"> <span>DocumentReference</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>patient</span> <span>, </span> <span>period</span> <span>, </span> <span>type</span> <br/> <span>patient</span> <span> + </span> <span>type</span> <span> + </span> <span>period</span> </td> <td> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#Goal"> <span>Goal</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>patient</span> <span>, </span> <span>date</span> <br/> <span>patient</span> <span> + </span> <span>date</span> </td> <td> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#Immunization"> <span>Immunization</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>patient</span> <br/> </td> <td> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#DiagnosticReport"> <span>DiagnosticReport</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>patient</span> <span>, </span> <span>category</span> <span>, </span> <span>code</span> <span>, </span> <span>date</span> <br/> <span>patient</span> <span> + </span> <span>category</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>date</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>code</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>code</span> <span> + </span> <span>date</span> </td> <td> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#Medication"> <span>Medication</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <br/> </td> <td> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#MedicationStatement"> <span>MedicationStatement</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>patient</span> <br/> </td> <td> <span>MedicationStatement.medicationReference</span> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#MedicationOrder"> <span>MedicationOrder</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>patient</span> <br/> </td> <td> <span>MedicationOrder.medicationReference</span> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#Observation"> <span>Observation</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>patient</span> <span>, </span> <span>category</span> <span>, </span> <span>code</span> <span>, </span> <span>date</span> <br/> <span>patient</span> <span> + </span> <span>category</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>date</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>code</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>code</span> <span> + </span> <span>date</span> </td> <td> </td> </tr> <tr style="height:0.36in; "> <td> <a href="#Procedure"> <span>Procedure</span> </a> </td> <td> <br/> </td> <td style="text-align:center; "> <span>patient</span> <span>, </span> <span>date</span> <br/> <span>patient</span> <span> + </span> <span>date</span> </td> <td> </td> </tr> </tbody> </table> <br/> <h4> <span style="font-weight:bold; ">Resource Details:</span> </h4> <br/> <ol> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="Patient"> <span style="font-weight:bold; ">Patient</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-patient</strong> </p> <ul> <li>A server is capable of returning a patient using GET [base]/Patient/[id].</li> <li>A server returns valid FHIR Patient resources according to the Data Access Framework (DAF) Patient Profile..</li> <li>A server has exposed a FHIR Patient search endpoint supporting at a minimum the following search parameters: <ul> <li>identifier</li> </ul> </li> <li>A server has exposed a FHIR Patient search endpoint supporting at a minimum the following search parameters when at least 2 (example name and gender) are present: <ul> <li>name</li> <li>gender</li> <li>birthdate</li> </ul> </li> </ul> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>name</span> </td> <td style="width:2.11in; "> <span>string</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>family</span> </td> <td style="width:2.11in; "> <span>string</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>given</span> </td> <td style="width:2.11in; "> <span>string</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>identifier</span> </td> <td style="width:2.11in; "> <span>token</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>gender</span> </td> <td style="width:2.11in; "> <span>token</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>birthdate</span> </td> <td style="width:2.11in; "> <span>date</span> </td> <td style="width:2.90in; "> </td> </tr> </tbody> </table> <p/> <p> <span>Supported Search Combinations:</span> <span>name</span> <span> + </span> <span>gender</span> <span>, </span> <span>name</span> <span> + </span> <span>birthdate</span> <span>, </span> <span>family</span> <span> + </span> <span>gender</span> <span>, </span> <span>given</span> <span> + </span> <span>gender</span> </p> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="AllergyIntolerance"> <span style="font-weight:bold; ">AllergyIntolerance</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-allergyintolerance</strong> </p> <ul> <li>A server is capable of returning a patient’s allergies using GET /AllergyIntolerance?patient=[id].</li> </ul> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>patient</span> </td> <td style="width:2.11in; "> <span>reference</span> </td> <td style="width:2.90in; "> </td> </tr> </tbody> </table> <p/> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="CarePlan"> <span style="font-weight:bold; ">CarePlan</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-careplan</strong> </p> <ul> <li>A server is capable of returning all of a patient’s Assessment and Plan of Treatment information using GET /CarePlan?patient=[id]&category=assess-plan.</li> <li> <p>A server <strong>SHOULD</strong> 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].</p> </li> <li>A server <strong>SHOULD</strong> be capable returning all of a patient’s active Assessment and Plan of Treatment information using GET /CarePlan?patient=[id]&category=assess-plan&status=active.</li> <li> <p>A server <strong>SHOULD</strong> 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].</p> </li> </ul> <h4 id="summary-of-argonaut-search-criteria-for-structuredefinition-argo-careteam">Summary of Argonaut Search Criteria for StructureDefinition-argo-careteam</h4> <ul> <li>A server is capable of returning a patients current care team members using GET[base]/CarePlan?patient=[id]&category=careteam&status=active</li> </ul> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>patient</span> </td> <td style="width:2.11in; "> <span>reference</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>category</span> </td> <td style="width:2.11in; "> <span>token</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHOULD</span> </td> <td> <span>status</span> </td> <td style="width:2.11in; "> <span>token</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHOULD</span> </td> <td> <span>date</span> </td> <td style="width:2.11in; "> <span>date</span> </td> <td style="width:2.90in; "> <p>The server SHALL support the <a href="http://hl7.org/fhir/2017Jan/search.html#prefix">date search modifiers</a> ‘ge’,‘le’,‘gt','lt' for this profile</p> </td> </tr> </tbody> </table> <p/> <p> <span>Supported Search Combinations:</span> <span>patient</span> <span> + </span> <span>category</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>date</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>status</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>status</span> <span> + </span> <span>date</span> </p> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="Condition"> <span style="font-weight:bold; ">Condition</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-condition</strong> </p> <ul> <li> <p>A server is capable of returning a patient’s conditions list using GET/Condition?patient=[id].</p> </li> <li>A server <strong>SHOULD</strong> be capable returning all of a patient’s active problems and health concerns using ‘GET /Condition?patient=[id]&clinicalstatus=active,recurrance,remission’</li> <li> <p>A server <strong>SHOULD</strong> 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]’</p> </li> </ul> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>patient</span> </td> <td style="width:2.11in; "> <span>reference</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHOULD</span> </td> <td> <span>category</span> </td> <td style="width:2.11in; "> <span>token</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHOULD</span> </td> <td> <span>clinicalstatus</span> </td> <td style="width:2.11in; "> <span>token</span> </td> <td style="width:2.90in; "> </td> </tr> </tbody> </table> <p/> <p> <span>Supported Search Combinations:</span> <span>patient</span> <span> + </span> <span>clinicalstatus</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> </p> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="Device"> <span style="font-weight:bold; ">Device</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-device</strong> </p> <ul> <li>A server is capable of returning all Unique device identifier(s)(UDI) for a patient’s implanted device(s) using GET /Device?patient=[id].</li> </ul> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>patient</span> </td> <td style="width:2.11in; "> <span>reference</span> </td> <td style="width:2.90in; "> </td> </tr> </tbody> </table> <p/> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="DocumentReference"> <span style="font-weight:bold; ">DocumentReference</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <h4>Search Criteria for StructureDefinition-argo-documentreference</h4> <ul> <li>To fetch document references, the Server <strong>SHALL</strong> support <strong>either</strong>: <ul> <li>a direct query for DocumentReference resources as described here</li> <li>or the <a href="OperationDefinition-docref.html">$docref operation</a>operation</li> </ul> </li> </ul> <p style="padding-left: 60px;">The Client <strong>SHALL</strong> support both methods.</p> <ul> <li>If supporting a direct query, a server <strong>SHALL</strong> be capable of returning at least the most recent CCD document references and <strong>MAY</strong> provide most recent references to other document types for a patient using:GET [base]/DocumentReference/$docref?patient=[id]</li> <li>If supporting a direct query, A server <strong>SHOULD</strong> be capable of returning references to CCD documents and <strong>MAY</strong> provide references to other document types for a patient searched by type and/or date using:GET [base]/DocumentReference/$docref?patient=[id]{&type=[type]}{&period=[date]}</li> </ul> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>patient</span> </td> <td style="width:2.11in; "> <span>reference</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHOULD</span> </td> <td> <span>period</span> </td> <td style="width:2.11in; "> <span>date</span> </td> <td style="width:2.90in; "> <p>The server SHALL support the <a href="http://hl7.org/fhir/2017Jan/search.html#prefix">date search modifiers</a> ‘ge’,‘le’,‘gt','lt' for this profile</p> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHOULD</span> </td> <td> <span>type</span> </td> <td style="width:2.11in; "> <span>token</span> </td> <td style="width:2.90in; "> </td> </tr> </tbody> </table> <p/> <p> <span>Supported Search Combinations:</span> <span>patient</span> <span> + </span> <span>type</span> <span> + </span> <span>period</span> </p> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="Goal"> <span style="font-weight:bold; ">Goal</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-device</strong> </p> <ul> <li>A server is capable of returning all of a patient’s goals using GET [base]/Goal?patient=[id].</li> <li>A server is capable of returning all of all of a patient’s goals over a specified time period using GET [base]/Goal?patient=[id]&date=[date]{&date=[date]}.</li> </ul> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>patient</span> </td> <td style="width:2.11in; "> <span>reference</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>date</span> </td> <td style="width:2.11in; "> <span>date</span> </td> <td style="width:2.90in; "> <p>The server SHALL support the <a href="http://hl7.org/fhir/2017Jan/search.html#prefix">date search modifiers</a> ‘ge’,‘le’,‘gt','lt' for this profile</p> </td> </tr> </tbody> </table> <p/> <p> <span>Supported Search Combinations:</span> <span>patient</span> <span> + </span> <span>date</span> </p> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="Immunization"> <span style="font-weight:bold; ">Immunization</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-immunization</strong> </p> <ul> <li>A client has connected to a server and fetched all immunizations for a patient using GET /Immunization?patient=[id].</li> </ul> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>patient</span> </td> <td style="width:2.11in; "> <span>reference</span> </td> <td style="width:2.90in; "> </td> </tr> </tbody> </table> <p/> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="DiagnosticReport"> <span style="font-weight:bold; ">DiagnosticReport</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-diagnosticreport</strong> </p> <ul> <li>A server is capable of returning all of a patient’s laboratory diagnostic reports queried by category using GET [base]/DiagnosticReport?patient=[id]&category=LAB.</li> <li>A server is capable of returning all of a patient’s laboratory diagnostic reports queried by category code and date range using GET [base]/DiagnosticReport?patient=[id]&category=LAB&date=[date]{&date=[date]}.</li> <li> <p>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].</p> </li> <li> <p>A server <strong>SHOULD</strong> 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]}.</p> </li> </ul> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>patient</span> </td> <td style="width:2.11in; "> <span>reference</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>category</span> </td> <td style="width:2.11in; "> <span>token</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>code</span> </td> <td style="width:2.11in; "> <span>token</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>date</span> </td> <td style="width:2.11in; "> <span>date</span> </td> <td style="width:2.90in; "> <p>The server SHALL support the <a href="http://hl7.org/fhir/2017Jan/search.html#prefix">date search modifiers</a> ‘ge’,‘le’,‘gt','lt' for this profile</p> </td> </tr> </tbody> </table> <p/> <p> <span>Supported Search Combinations:</span> <span>patient</span> <span> + </span> <span>category</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>date</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>code</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>code</span> <span> + </span> <span>date</span> </p> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="Medication"> <span style="font-weight:bold; ">Medication</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <p>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 <strong>SHALL</strong> be supported.</p> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td/> </tr> </tbody> </table> <p/> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="MedicationStatement"> <span style="font-weight:bold; ">MedicationStatement</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-medicationstatement</strong> </p> <p>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 <a href="http://hl7.org/fhir/2017Jan/references.html#contained">contained</a> or an external resource. The server application can choose any one way or more than one method, but <strong>IF</strong> the an external reference to Medication is used, the server <strong>SHALL</strong> support the <a href="http://hl7.org/fhir/2017Jan/references.html#include">include</a> parameter for searching this element. The client application must support both methods.</p> <ul> <li>A server is capable of returning a patient’s medications using one of or both</li> </ul> <ol> <li>GET /MedicationStatement?patient=[id]</li> <li>GET /MedicationStatement?patient=[id]&_include=MedicationStatement:medication</li> </ol> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>patient</span> </td> <td style="width:2.11in; "> <span>reference</span> </td> <td style="width:2.90in; "> </td> </tr> </tbody> </table> <p/> <p> <span>Supported Includes: </span> <span>MedicationStatement.medicationReference</span> </p> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="MedicationOrder"> <span style="font-weight:bold; ">MedicationOrder</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-MedicationOrder</strong> </p> <p>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 <a href="http://hl7.org/fhir/2017Jan/references.html#contained">contained</a> 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 <a href="http://hl7.org/fhir/2017Jan/references.html#include">include</a> parameter for searching this element. The client application must support both methods.</p> <ul> <li>A server is capable of returning a patient’s medications using one of or both</li> </ul> <ol> <li>GET /MedicationOrder?patient=[id]</li> <li>GET /MedicationOrder?patient=[id]&_include=MedicationOrder:medication</li> </ol> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>patient</span> </td> <td style="width:2.11in; "> <span>reference</span> </td> <td style="width:2.90in; "> </td> </tr> </tbody> </table> <p/> <p> <span>Supported Includes: </span> <span>MedicationOrder.medicationReference</span> </p> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="Observation"> <span style="font-weight:bold; ">Observation</span> </a> <p> <span>Supported Profiles: </span> <br/> </p>. <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-observationresults</strong> </p> <ul> <li>A server is capable of returning all of a patient's laboratory results queried by category using GET [base]/Observation?patient=[id]&category=laboratory.</li> <li>A server is capable of returning all of a patient's laboratory results queried by category code and date range usingGET [base]/Observation?patient=[id]&category=laboratory&date=[date]{&date=[date]}.</li> <li>A server is capable of returning all of a patient's laboratory results queried by category and code using GET [base]/Observation?patient=[id]&category=laboratory&code=[LOINC].</li> <li>A server SHOULD be capable of returning all of a patient's laboratory results queried 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]}.</li> </ul> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-smokingstatus</strong> </p> <ul> <li>A server is capable of returning a a patient’s smoking status using GET [base]/Observation?patient=[id]&code=72166-2</li> </ul> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-vitalsigns</strong> </p> <ul> <li>A server is capable of returning all of a patient’s vital signs that it supports using GET [base]/Observation?patient=[id]&category=vital-signs.</li> <li>A server is capable of returning all of a patient’s vital signs queried by date range using GET [base]/Observation?patient=[id]&category=vital-signs&date=[date]{&date=[date]}.</li> <li> <p>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,…}].</p> </li> <li> <p>A server <strong>SHOULD</strong> 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]}.</p> </li> </ul> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>patient</span> </td> <td style="width:2.11in; "> <span>reference</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>category</span> </td> <td style="width:2.11in; "> <span>token</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>code</span> </td> <td style="width:2.11in; "> <span>token</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>date</span> </td> <td style="width:2.11in; "> <span>date</span> </td> <td style="width:2.90in; "> <p>The server SHALL support the <a href="http://hl7.org/fhir/2017Jan/search.html#prefix">date search modifiers</a> ‘ge’,‘le’,‘gt','lt' for this profile</p> </td> </tr> </tbody> </table> <p/> <p> <span>Supported Search Combinations:</span> <span>patient</span> <span> + </span> <span>category</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>date</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>code</span> <span>, </span> <span>patient</span> <span> + </span> <span>category</span> <span> + </span> <span>code</span> <span> + </span> <span>date</span> </p> <p/> <hr/> </li> <li> <span style="font-weight:bold; ">Resource Type: </span> <a name="Procedure"> <span style="font-weight:bold; ">Procedure</span> </a> <p> <span>Supported Profiles: </span> <br/> </p> <p> <strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-procedure</strong> </p> <ul> <li>A server is capable of returning a patient’s procedures using GET/Procedure?patient=[id].</li> <li>A server is capable of returning all of all of a patient’s procedures over a specified time period using GET /Procedure?patient=[id]&date=[date]{&date=[date]}.</li> </ul> <p/> <span>Search Parameters:</span> <table border="1"> <thead> <tr> <th style="width:2.71in; "> <span>Conformance</span> </th> <th> <span>Parameter</span> </th> <th style="width:2.11in; "> <span>Type</span> </th> <th style="width:2.90in; "> <span>Modifiers</span> </th> </tr> </thead> <tbody> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>patient</span> </td> <td style="width:2.11in; "> <span>reference</span> </td> <td style="width:2.90in; "> </td> </tr> <tr> <td style="width:2.71in; "> <span>SHALL</span> </td> <td> <span>date</span> </td> <td style="width:2.11in; "> <span>date</span> </td> <td style="width:2.90in; "> <p>The server SHALL support the <a href="http://hl7.org/fhir/2017Jan/search.html#prefix">date search modifiers</a> ‘ge’,‘le’,‘gt','lt' for this profile</p> </td> </tr> </tbody> </table> <p/> <p> <span>Supported Search Combinations:</span> <span>patient</span> <span> + </span> <span>date</span> </p> <p/> <hr/> </li> </ol> <br/> <br/> <br/> </div> </text> <url value="http://fhir.org/guides/argonaut/Conformance/server"/> <name value="Argonaut Data Query Implementation Guide Server"/> <status value="draft"/> <publisher value="Argonaut Project"/> <contact> <telecom> <system value="other"/> <value value="http://argonautwiki.hl7.org"/> </telecom> </contact> <date value="2016-12-15"/> <description value="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."/> <kind value="requirements"/> <fhirVersion value="1.0.2"/> <acceptUnknown value="extensions"/> <format value="xml"/> <format value="json"/> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="AllergyIntolerance"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-allergyintolerance.html"/> <display value="Argonaut Data Query AllergyIntolerance Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="CarePlan"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-careplan.html"/> <display value="Argonaut Data Query CarePlan Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="CarePlan"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-careteam.html"/> <display value="Argonaut Data Query CareTeam Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="Condition"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-condition.html"/> <display value="Argonaut Data Query Condition Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="DocumentReference"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-documentreference.html"/> <display value="Argonaut Data Query Document Reference Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="Device"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-device.html"/> <display value="Argonaut Data Query Device Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="Goal"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-goal.html"/> <display value="Argonaut Data Query Goal Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="Immunization"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-immunization.html"/> <display value="Argonaut Data Query Immunization Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="DiagnosticReport"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-diagnosticreport.html"/> <display value="Argonaut Data Query DiagnosticReport Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="Observation"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-observationresults.html"/> <display value="Argonaut Data Query Result Observation Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="Medication"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-medication.html"/> <display value="Argonaut Data Query Medication Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="MedicationOrder"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-MedicationOrder.html"/> <display value="Argonaut Data Query MedicationOrder Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="MedicationStatement"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-medicationstatement.html"/> <display value="Argonaut Data Query MedicationStatement Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="Observation"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-vitalsigns.html"/> <display value="Argonaut Data Query Vital Signs Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="Observation"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-smokingstatus.html"/> <display value="Argonaut Data Query Smoking Status Observation Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="Patient"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-patient.html"/> <display value="Argonaut Data Query Patient Profile"/> </profile> <profile> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-profile-link"> <valueCode value="Procedure"/> </extension> <reference value="http://fhir.org/guides/argonaut/StructureDefinition-argo-procedure.html"/> <display value="Argonaut Data Query Procedure Profile"/> </profile> <rest> <mode value="server"/> <documentation value="<p><strong>The Argonaut Data Query Server SHALL:</strong></p> <ol> <li>Support the Argonaut Data Query Patient resource profile.</li> <li>Support at least one additional resource profile from the list of Argonaut Data Query Profiles</li> <li>Implement REST behavior according to the FHIR specification</li> <li>Support json resource formats for all Argonaut Data Query interactions.</li> <li>Identify the Argonaut Data Query profile(s) supported as part of the <a href="http://build.fhir.org/resource-definitions.html#Meta.profile">FHIR Meta profile attribute</a> for each instance.</li> <li>Declare a Conformance identifying the list of profiles, operations, search parameter supported. </li> </ol> <p><strong>The Argonaut Data Query Server SHOULD:</strong> </p> <ol> <li>Support xml resource formats for all Argonaut Data Query interactions. </li> </ol>"/> <security> <description value="<p><strong>Argonaut Data Query Servers SHALL</strong></p> <ol> <li>implement the <a href="index.html#security">security requirements</a> documented in this guide</li> <li>A server has ensured that every API request includes a valid Authorization token, supplied via: <code>Authorization: Bearer {server-specific-token-here}</code></li> <li>A server has rejected any unauthorized requests by returning an <code>HTTP 401</code> Unauthorized response code.</li> </ol>"/> </security> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value="<p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-patient</strong></p> <ul> <li>A server is capable of returning a patient using GET [base]/Patient/[id].</li> <li>A server returns valid FHIR Patient resources according to the Data Access Framework (DAF) Patient Profile..</li> <li>A server has exposed a FHIR Patient search endpoint supporting at a minimum the following search parameters: <ul> <li>identifier</li> </ul></li> <li>A server has exposed a FHIR Patient search endpoint supporting at a minimum the following search parameters when at least 2 (example name and gender) are present: <ul> <li>name</li> <li>gender</li> <li>birthdate</li> </ul></li> </ul> "/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="name"/> </extension> <extension url="required"> <valueString value="gender"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="name"/> </extension> <extension url="required"> <valueString value="birthdate"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="family"/> </extension> <extension url="required"> <valueString value="gender"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="given"/> </extension> <extension url="required"> <valueString value="gender"/> </extension> </extension> <type value="Patient"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Data Query patient resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Data Query patients by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query patient instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query patient instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="name"/> <definition value="http://hl7.org/fhir/SearchParameter/Patient-name"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="family"/> <definition value="http://hl7.org/fhir/SearchParameter/Patient-family"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="given"/> <definition value="http://hl7.org/fhir/SearchParameter/Patient-given"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="identifier"/> <definition value="http://hl7.org/fhir/SearchParameter/Patient-identifier"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="gender"/> <definition value="http://hl7.org/fhir/SearchParameter/Patient-gender"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="birthdate"/> <definition value="http://hl7.org/fhir/SearchParameter/Patient-birthdate"/> <type value="date"/> </searchParam> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value="<p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-allergyintolerance</strong></p> <ul> <li>A server is capable of returning a patient’s allergies using GET /AllergyIntolerance?patient=[id].</li> </ul> "/> </extension> <type value="AllergyIntolerance"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Data Query AllergyIntolerance resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Data Query AllergyIntolerance by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query AllergyIntolerance instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query AllergyIntolerance instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/AllergyIntolerance-Patient"/> <type value="reference"/> </searchParam> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value="<p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-careplan</strong></p> <ul> <li>A server is capable of returning all of a patient’s Assessment and Plan of Treatment information using GET /CarePlan?patient=[id]&amp;category=assess-plan.</li> <li><p>A server <strong>SHOULD</strong> be capable of returning a patient’s Assessment and Plan of Treatment information over a specified time period using GET /CarePlan?patient=[id]&amp;category=assess-plan&amp;date=[date].</p></li> <li>A server <strong>SHOULD</strong> be capable returning all of a patient’s active Assessment and Plan of Treatment information using GET /CarePlan?patient=[id]&amp;category=assess-plan&amp;status=active.</li> <li><p>A server <strong>SHOULD</strong> be capable returning a patient’s active Assessment and Plan of Treatment information over a specified time period using GET /CarePlan?patient=[id]&amp;category=assess-plan&amp;status=active&amp;date=[date].</p></li> </ul> <h4 id="summary-of-argonaut-search-criteria-for-structuredefinition-argo-careteam">Summary of Argonaut Search Criteria for StructureDefinition-argo-careteam</h4> <ul> <li>A server is capable of returning a patients current care team members using GET[base]/CarePlan?patient=[id]&amp;category=careteam&amp;status=active</li> </ul>"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> <extension url="required"> <valueString value="date"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> <extension url="required"> <valueString value="status"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> <extension url="required"> <valueString value="status"/> </extension> <extension url="required"> <valueString value="date"/> </extension> </extension> <type value="CarePlan"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Data Query careplan resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Data Query careplan by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query careplan instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query careplan instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/CarePlan-Patient"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="category"/> <definition value="http://hl7.org/fhir/SearchParameter/CarePlan-Category"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <name value="status"/> <definition value="http://hl7.org/fhir/SearchParameter/CarePlan-Status"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <name value="date"/> <definition value="http://hl7.org/fhir/SearchParameter/CarePlan-Date"/> <type value="date"/> <documentation value="<p>The server SHALL support the <a href="http://hl7.org/fhir/2017Jan/search.html#prefix">date search modifiers</a> ‘ge’,‘le’,‘gt','lt' for this profile</p>"/> </searchParam> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value="<p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-condition</strong></p> <ul> <li><p>A server is capable of returning a patient’s conditions list using GET/Condition?patient=[id].</p></li> <li>A server <strong>SHOULD</strong> be capable returning all of a patient’s active problems and health concerns using ‘GET /Condition?patient=[id]&amp;clinicalstatus=active,recurrance,remission’</li> <li><p>A server <strong>SHOULD</strong> be capable returning all of a patient’s problems or all of patient’s health concerns using ‘GET /Condition?patient=[id]&amp;category=[problem|health-concern]’</p></li> </ul> "/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="clinicalstatus"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> </extension> <type value="Condition"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Data Query condition resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Data Query condition by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query condition instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query condition instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/Condition-Patient"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <name value="category"/> <definition value="http://hl7.org/fhir/SearchParameter/Condition-Category"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <name value="clinicalstatus"/> <definition value="http://hl7.org/fhir/SearchParameter/Condition-ClinicalStatus"/> <type value="token"/> </searchParam> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value="<p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-device</strong></p> <ul> <li>A server is capable of returning all Unique device identifier(s)(UDI) for a patient’s implanted device(s) using GET /Device?patient=[id].</li> </ul> "/> </extension> <type value="Device"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Data Query device resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Data Query device by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query device instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query device instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/Device-Patient"/> <type value="reference"/> </searchParam> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value=" <h4>Search Criteria for StructureDefinition-argo-documentreference</h4> <ul> <li>To fetch document references, the Server <strong>SHALL</strong> support <strong>either</strong>: <ul> <li>a direct query for DocumentReference resources as described here</li> <li>or the <a href="OperationDefinition-docref.html">$docref operation</a>&nbsp;operation</li> </ul> </li> </ul> <p style="padding-left: 60px;">The Client <strong>SHALL</strong> support both methods.</p> <ul> <li>If supporting a direct query, a&nbsp;server <strong>SHALL</strong>&nbsp;be capable of returning at least the most recent CCD document references and <strong>MAY</strong> provide most recent references to other document types for a patient using:GET [base]/DocumentReference/$docref?patient=[id]</li> <li>If supporting a direct query, A server <strong>SHOULD</strong>&nbsp;be capable of returning references to CCD documents and <strong>MAY</strong> provide references to other document types for a patient searched by type and/or date using:GET [base]/DocumentReference/$docref?patient=[id]{&amp;type=[type]}{&amp;period=[date]}</li> </ul>"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="type"/> </extension> <extension url="required"> <valueString value="period"/> </extension> </extension> <type value="DocumentReference"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Document Query DocumentReference resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Document Query DocumentReference by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Document Query DocumentReference instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Document Query DocumentReference instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/DocumentReference-Patient"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <name value="period"/> <definition value="http://hl7.org/fhir/SearchParameter/DocumentReference-Period"/> <type value="date"/> <documentation value="<p>The server SHALL support the <a href="http://hl7.org/fhir/2017Jan/search.html#prefix">date search modifiers</a> ‘ge’,‘le’,‘gt','lt' for this profile</p>"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <name value="type"/> <definition value="http://hl7.org/fhir/SearchParameter/DocumentReference-Type"/> <type value="token"/> </searchParam> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value="<p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-device</strong></p> <ul> <li>A server is capable of returning all of a patient’s goals using GET [base]/Goal?patient=[id].</li> <li>A server is capable of returning all of all of a patient’s goals over a specified time period using GET [base]/Goal?patient=[id]&amp;date=[date]{&amp;date=[date]}.</li> </ul> "/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="date"/> </extension> </extension> <type value="Goal"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Data Query Goal resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Data Query Goal by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query Goal instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query Goal instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/Goal-Patient"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="date"/> <definition value="http://hl7.org/fhir/SearchParameter/Goal-Date"/> <type value="date"/> <documentation value="<p>The server SHALL support the <a href="http://hl7.org/fhir/2017Jan/search.html#prefix">date search modifiers</a> ‘ge’,‘le’,‘gt','lt' for this profile</p>"/> </searchParam> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value="<p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-immunization</strong></p> <ul> <li>A client has connected to a server and fetched all immunizations for a patient using GET /Immunization?patient=[id].</li> </ul> "/> </extension> <type value="Immunization"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Data Query immunization resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Data Query immunization by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query immunization instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query immunization instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/Immunization-Patient"/> <type value="reference"/> </searchParam> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value="<p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-diagnosticreport</strong></p> <ul> <li>A server is capable of returning all of a patient’s laboratory diagnostic reports queried by category using GET [base]/DiagnosticReport?patient=[id]&amp;category=LAB.</li> <li>A server is capable of returning all of a patient’s laboratory diagnostic reports queried by category code and date range using GET [base]/DiagnosticReport?patient=[id]&amp;category=LAB&amp;date=[date]{&amp;date=[date]}.</li> <li><p>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]&amp;category=LAB&amp;code=[LOINC].</p></li> <li><p>A server <strong>SHOULD</strong> 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]&amp;category=LAB&amp;code=[LOINC1{,LOINC2,LOINC3,…}]&amp;date=[date]{&amp;date=[date]}.</p></li> </ul> "/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> <extension url="required"> <valueString value="date"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> <extension url="required"> <valueString value="code"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> <extension url="required"> <valueString value="code"/> </extension> <extension url="required"> <valueString value="date"/> </extension> </extension> <type value="DiagnosticReport"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Data Query diagnosticreport resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Data Query diagnosticreport by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query diagnosticreport instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query diagnosticreport instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/DiagnosticReport-Patient"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="category"/> <definition value="http://hl7.org/fhir/SearchParameter/DiagnosticReport-Category"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="code"/> <definition value="http://hl7.org/fhir/SearchParameter/DiagnosticReport-Code"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="date"/> <definition value="http://hl7.org/fhir/SearchParameter/DiagnosticReport-Date"/> <type value="date"/> <documentation value="<p>The server SHALL support the <a href="http://hl7.org/fhir/2017Jan/search.html#prefix">date search modifiers</a> ‘ge’,‘le’,‘gt','lt' for this profile</p>"/> </searchParam> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value="<p>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 <strong>SHALL</strong> be supported.</p>"/> </extension> <type value="Medication"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="search-type"/> <documentation value="IF the Medication Resource is used in a MedicationStatement or a MedicationOrder. Allows discovery of existing Argonaut Data Query Medication resources using different search criteria."/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="read"/> <documentation value="IF the Medication Resource is used in a MedicationStatement or a MedicationOrder. Allows retrieval of a specific Argonaut Data Query Medication by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query Medication instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query Medication instance"/> </interaction> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value="<p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-medicationstatement</strong></p> <p>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 <a href="http://hl7.org/fhir/2017Jan/references.html#contained">contained</a> or an external resource. The server application can choose any one way or more than one method, but <strong>IF</strong> the an external reference to Medication is used, the server <strong>SHALL</strong> support the <a href="http://hl7.org/fhir/2017Jan/references.html#include">include</a> parameter for searching this element. The client application must support both methods.</p> <ul> <li>A server is capable of returning a patient’s medications using one of or both</li> </ul> <ol> <li>GET /MedicationStatement?patient=[id]</li> <li>GET /MedicationStatement?patient=[id]&amp;_include=MedicationStatement:medication</li> </ol> "/> </extension> <type value="MedicationStatement"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Data Query medicationstatement resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Data Query medicationstatement by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query medicationstatement instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query medicationstatement instance"/> </interaction> <searchInclude value="MedicationStatement.medicationReference"> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="MAY"/> </extension> </searchInclude> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/MedicationStatement-Patient"/> <type value="reference"/> </searchParam> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value="<p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-MedicationOrder</strong></p> <p>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 <a href="http://hl7.org/fhir/2017Jan/references.html#contained">contained</a> 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 <a href="http://hl7.org/fhir/2017Jan/references.html#include">include</a> parameter for searching this element. The client application must support both methods.</p> <ul> <li>A server is capable of returning a patient’s medications using one of or both</li> </ul> <ol> <li>GET /MedicationOrder?patient=[id]</li> <li>GET /MedicationOrder?patient=[id]&amp;_include=MedicationOrder:medication</li> </ol> "/> </extension> <type value="MedicationOrder"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Data Query MedicationOrder resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Data Query MedicationOrder by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query MedicationOrder instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query MedicationOrder instance"/> </interaction> <searchInclude value="MedicationOrder.medicationReference"> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="MAY"/> </extension> </searchInclude> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/MedicationOrder-Patient"/> <type value="reference"/> </searchParam> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value=". <p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-observationresults</strong></p> <ul> <li>A server is capable of returning all of a patient&rsquo;s laboratory results queried by category using GET [base]/Observation?patient=[id]&amp;category=laboratory.</li> <li>A server is capable of returning all of a patient&rsquo;s laboratory results queried by category code and date range usingGET [base]/Observation?patient=[id]&amp;category=laboratory&amp;date=[date]{&amp;date=[date]}.</li> <li>A server is capable of returning all of a patient&rsquo;s laboratory results queried by category and code using GET [base]/Observation?patient=[id]&amp;category=laboratory&amp;code=[LOINC].</li> <li>A server SHOULD be capable of returning all of a patient&rsquo;s laboratory results queried by category and one or more codes and date range using GET [base]/Observation?patient=[id]&amp;category=laboratory&amp;code=[LOINC1{,LOINC2,LOINC3,&hellip;}]&amp;date=[date]{&amp;date=[date]}.</li> </ul> <p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-smokingstatus</strong></p> <ul> <li>A server is capable of returning a a patient’s smoking status using GET [base]/Observation?patient=[id]&amp;code=72166-2</li> </ul> <p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-vitalsigns</strong></p> <ul> <li>A server is capable of returning all of a patient’s vital signs that it supports using GET [base]/Observation?patient=[id]&amp;category=vital-signs.</li> <li>A server is capable of returning all of a patient’s vital signs queried by date range using GET [base]/Observation?patient=[id]&amp;category=vital-signs&amp;date=[date]{&amp;date=[date]}.</li> <li><p>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]&amp;code[vital sign LOINC{,LOINC2,LOINC3,…}].</p></li> <li><p>A server <strong>SHOULD</strong> 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]&amp;code=[LOINC{,LOINC2…}]vital-signs&amp;date=[date]{&amp;date=[date]}.</p></li> </ul> "/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> <extension url="required"> <valueString value="date"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> <extension url="required"> <valueString value="code"/> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="category"/> </extension> <extension url="required"> <valueString value="code"/> </extension> <extension url="required"> <valueString value="date"/> </extension> </extension> <type value="Observation"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Data Query results observation, smokingstatus, and vitals signs observation using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Data Query results observation, smokingstatus, and vitals signs observation by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query results observation, smokingstatus, and vitals signs observation over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query results observation, smokingstatus, and vitals signs observation instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/Observation-Patient"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="category"/> <definition value="http://hl7.org/fhir/SearchParameter/Organization-Category"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="code"/> <definition value="http://hl7.org/fhir/SearchParameter/Organization-Code"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="date"/> <definition value="http://hl7.org/fhir/SearchParameter/Organization-Date"/> <type value="date"/> <documentation value="<p>The server SHALL support the <a href="http://hl7.org/fhir/2017Jan/search.html#prefix">date search modifiers</a> ‘ge’,‘le’,‘gt','lt' for this profile</p>"/> </searchParam> </resource> <resource> <extension url="http://fhir.org/guides/argonaut/StructureDefinition/argo-resource-documentation"> <valueMarkdown value=" <p><strong>Summary of Argonaut Data Query Search Criteria for StructureDefinition-argo-procedure</strong></p> <ul> <li>A server is capable of returning a patient’s procedures using GET/Procedure?patient=[id].</li> <li>A server is capable of returning all of all of a patient’s procedures over a specified time period using GET /Procedure?patient=[id]&amp;date=[date]{&amp;date=[date]}.</li> </ul> "/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="date"/> </extension> </extension> <type value="Procedure"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Data Query procedure resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Data Query procedure by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to Argonaut Data Query procedure instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a Argonaut Data Query procedure instance"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/Procedure-Patient"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="SHALL"/> </extension> <name value="date"/> <definition value="http://hl7.org/fhir/SearchParameter/Procedure-Date"/> <type value="date"/> <documentation value="<p>The server SHALL support the <a href="http://hl7.org/fhir/2017Jan/search.html#prefix">date search modifiers</a> ‘ge’,‘le’,‘gt','lt' for this profile</p>"/> </searchParam> </resource> <operation> <extension url="http://hl7.org/fhir/StructureDefinition/conformance-expectation"> <valueCode value="MAY"/> </extension> <name value="docref"/> <definition> <reference value="http://fhir.org/guides/argonaut/OperationDefinition/docref"/> <display value="Argonaut Get DocumentReferences"/> </definition> </operation> </rest> </Conformance>
Argonaut Data Query fhir.argonaut.r2#1.0.0 © FHIR DSTU2 (IG Publisher v1.9.0-11142) generated on Wed, Feb 15, 2017 08:37+1100. |
