US Core Implementation Guide (Release 1)
This page is part of the US Core (v1.0.0: STU1) based on FHIR R3. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions 
{
"resourceType" : "CapabilityStatement",
"id" : "server",
"text" : {
"status" : "additional",
"div" : "<div xmlns="http://www.w3.org/1999/xhtml">
<ul><li>FHIR Version: 3.0.0</li><li>Supported formats: xml, json</li><li>Published: 2017-03-08</li><li>Published by: Health Level Seven International US Realm Steering Committee</li></ul><p>The Section describes the expected capabilities of the US Core Server actor which is responsible for providing responses to the queries submitted by the US Core Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined. Systems implementing this capability statement should meet the ONC 2015 Common Clinical Data Set (CCDS) access requirement for Patient Selection 170.315(g)(7) and Application Access - Data Category Request 170.315(g)(8). US Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.</p><h4 id="behavior">Behavior</h4><p>Description: The US Core Server <strong>SHALL</strong>:</p><ul><li>Support the US Core Patient resource profile.</li><li>Support at least one additional resource profile from the list of US Core Profiles.</li><li>Implement the RESTful behavior according to the FHIR specification.</li><li>Return the following response classes:
<ul><li>(Status 200): successful operation</li><li>(Status 400): invalid parameter</li><li>(Status 401/4xx): unauthorized request</li><li>(Status 403): insufficient scope</li><li>(Status 404): unknown resource</li><li>(Status 410): deleted resource.</li></ul></li><li>Support <em>json</em> resource formats for all US Core interactions.</li><li>Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.</li></ul><p>The US Core Server <strong>SHOULD</strong>:</p><ul><li>Support <em>xml</em> resource formats for all US Core interactions.</li><li>Identify the US Core profiles supported as part of the FHIR <code class="highlighter-rouge">meta.profile</code> attribute for each instance.</li></ul><h4 id="security">Security:</h4><p>US Core Servers <strong>SHALL</strong>:</p><ul><li>Implement the <a href="security.html">security requirements</a> documented in the this IG.</li><li>A server has ensured that every API request includes a valid Authorization token, supplied via: <code class="highlighter-rouge">Authorization: Bearer {server-specific-token-here}</code></li><li>A server has rejected any unauthorized requests by returning an <code class="highlighter-rouge">HTTP 401</code> Unauthorized response code.</li></ul><h4 id="profile-interaction-summary">Profile Interaction Summary:</h4><ul><li>All servers <strong>SHALL</strong> make available the <a href="http://hl7.org/fhir/STU3/http.html#read">read</a> and <a href="http://hl7.org/fhir/STU3/http.html#search">search</a> interactions for the Profiles the server chooses to support.</li><li>All servers <strong>SHOULD</strong> make available the <a href="http://hl7.org/fhir/STU3/http.html#vread">vread</a> and <a href="http://hl7.org/fhir/STU3/http.html#history">history-instance</a> interactions for the Profiles the server chooses to support.</li></ul><p><strong>Summary of US Core search criteria</strong></p><p>Specific server search capabilities are described in detail in each of the resource sections below.</p><table class="grid"><thead><tr><th>Resource Type</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported Includes</th></tr></thead><tbody><tr><td><a href="#patient">Patient</a></td><td>US Core Patient Profile</td><td>name , family , given , identifier , gender , birthdate , name + gender , name + birthdate , family + gender , given + gender</td><td/></tr><tr><td><a href="#allergyintolerance">AllergyIntolerance</a></td><td>US Core AllergyIntolerance Profile</td><td>patient</td><td/></tr><tr><td><a href="#careplan">CarePlan</a></td><td>US Core CarePlan Profile</td><td>patient , category , status , date, patient + category , patient + category + date , patient + category + status , patient + category + status + date</td><td/></tr><tr><td><a href="#careteam">CareTeam</a></td><td>US Core CareTeam Profile</td><td>patient , status, patient + status</td><td/></tr><tr><td><a href="#condition">Condition</a></td><td>US Core Condition Profile</td><td>patient , category , clinicalstatus, patient + clinicalstatus , patient + category</td><td/></tr><tr><td><a href="#device">Device</a></td><td>US Core Device Profile</td><td>patient</td><td/></tr><tr><td><a href="#diagnosticreport">DiagnosticReport</a></td><td>US Core DiagnosticReport Profile</td><td>patient , category , code , date, patient + category , patient + category + date , patient + category + code, patient + category + code + date</td><td/></tr><tr><td><a href="#goal">Goal</a></td><td>US Core Goal Profile</td><td>patient , date, patient + date</td><td/></tr><tr><td><a href="#immunization">Immunization</a></td><td>US Core Immunization Profile</td><td>patient</td><td/></tr><tr><td><a href="#location">Location</a></td><td>US Core Location Profile</td><td>name , address</td><td/></tr><tr><td><a href="#medication">Medication</a></td><td>US Core Medication Profile</td><td/><td/></tr><tr><td><a href="#medicationstatement">MedicationStatement</a></td><td>US Core MedicationStatement Profile</td><td>patient</td><td>MedicationStatement.medication</td></tr><tr><td><a href="#medicationrequest">MedicationRequest</a></td><td>US Core MedicationRequest Profile</td><td>patient</td><td>MedicationRequest.medication</td></tr><tr><td><a href="#observation">Observation</a></td><td>US Core Result Observation Profile, Vital Signs Profile, US Core Smoking Status Observation Profile</td><td>patient , category , code , date, patient + category , patient + category + date , patient + category + code, patient + category + code + date</td><td/></tr><tr><td><a href="#organization">Organization</a></td><td>US Core Organization Profile</td><td>identifier , name , address</td><td/></tr><tr><td><a href="#practitioner">Practitioner</a></td><td>US Core Practitioner Profile</td><td>identifier , name</td><td/></tr><tr><td><a href="#procedure">Procedure</a></td><td>US Core Procedure Profile</td><td>patient , date , patient + date</td><td/></tr></tbody></table><h4 id="resource--details" class="no_toc">Resource Details:</h4><h5 id="patient" class="no_toc">1. Patient</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-patient.html">US Core Patient Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning a patient using:</p><p><code class="highlighter-rouge">GET [base]/Patient/[id]</code>.</p></li><li><p>A server <strong>SHALL</strong> be capable of returning a patient by identifier using
<code class="highlighter-rouge">GET [base]/Patient?identifier=[system]|[code]</code></p></li><li><p>A server <strong>SHALL</strong> be capbable of returning a patient by supporting at a minimum the following search parameters when at least 2 are present:</p><ul><li>name</li><li>gender</li><li><p>birthdate</p><ul><li>for example:</li></ul><p><code class="highlighter-rouge">GET [base]/Patient?name=[name]&gender=[gender]</code></p></li></ul></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td>SHALL</td><td>name</td><td>string</td></tr><tr><td>SHALL</td><td>identifier</td><td>token</td></tr><tr><td>SHALL</td><td>family +gender</td><td>string + token</td></tr><tr><td>SHALL</td><td>given +gender</td><td>string + token</td></tr><tr><td>SHALL</td><td>name+gender</td><td>string + token</td></tr><tr><td>SHALL</td><td>name+birthdate</td><td>string + date</td></tr></tbody></table><h5 id="allergyintolerance" class="no_toc">2. AllergyIntolerance</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-allergyintolerance.html">US Core AllergyIntolerance Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning all patient's allergies using:</p><p><code class="highlighter-rouge">Get [base]/AllergyIntolerance?patient=[id]</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td>SHALL</td><td>patient</td><td>reference</td></tr></tbody></table><h5 id="careplan" class="no_toc">3. CarePlan</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-careplan.html">US Core CarePlan Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning all of a patient's Assessment and Plan of Treatment information using:</p><p><code class="highlighter-rouge">Get [base]/CarePlan?patient=[id]&category=assess-plan</code></p></li><li><p>A server <strong>SHALL</strong> be capable of returning a patient's Assessment and Plan of Treatment information over a specified time period using:</p><p><code class="highlighter-rouge">Get [base]/CarePlan?patient=[id]&category=assess-plan&date=[date]</code></p></li><li><p>A server <strong>SHOULD</strong> be capable returning all of a patient's active Assessment and Plan of Treatment information using</p><p><code class="highlighter-rouge">Get [base]/CarePlan?patient=[id]&category=assess-plan&status=active</code></p></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</p><p><code class="highlighter-rouge">Get [base]/CarePlan?patient=[id]&category=assess-plan&status=active&date=[date]</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Modifiers</th></tr></thead><tbody><tr><td>SHALL</td><td>patient + category</td><td>reference + token</td><td/></tr><tr><td>SHALL</td><td>patient + category + date</td><td>reference + token + date</td><td>date modifiers'ge','le','gt','lt'</td></tr><tr><td>SHOULD</td><td>patient + category + status</td><td>reference + token</td><td/></tr><tr><td>SHOULD</td><td>patient + category + date + status</td><td>reference + token + date</td><td>date modifiers'ge','le','gt','lt'</td></tr></tbody></table><h5 id="careteam" class="no_toc">4. CareTeam</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-careteam.html">US Core CareTeam Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning a patient's current care team members using:</p><p><code class="highlighter-rouge">Get [base]/CareTeam?patient=[id]&status=active</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td>SHALL</td><td>patient + status</td><td>reference + token</td></tr></tbody></table><h5 id="condition" class="no_toc">5. Condition</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-Condition.html">US Core Condition Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning a patient's conditions list using:</p><p><code class="highlighter-rouge">Get [base]/Condition?patient=[id]</code></p></li><li><p>A server <strong>SHOULD</strong> be capable returning all of a patient's active problems and health concerns using:</p><p><code class="highlighter-rouge">Get [base]/Condition?patient=[id]&clinicalstatus=active,recurrance,remission</code></p></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:</p><p><code class="highlighter-rouge">Get [base]/Condition?patient=[id]&category=[problem|health-concern]</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td>SHALL</td><td>patient</td><td>reference</td></tr><tr><td>SHOULD</td><td>patient + category</td><td>reference + token</td></tr><tr><td>SHOULD</td><td>patient + clinicalstatus</td><td>reference + token</td></tr></tbody></table><h5 id="device" class="no_toc">6. Device</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-device.html">US Core Device Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning all Unique device identifier(s)(UDI) for a patient's implanted device(s):</p><p><code class="highlighter-rouge">Get [base]/Device?patient=[id]</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td>SHALL</td><td>patient</td><td>reference</td></tr></tbody></table><h5 id="diagnosticreport" class="no_toc">7. DiagnosticReport</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-diagnosticreport.html">US Core DiagnosticReport Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning all of a patient's laboratory diagnostic reports queried by category using:</p><p><code class="highlighter-rouge">Get [base]/DiagnosticReport?patient=[id]&category=LAB</code></p></li><li><p>A server <strong>SHALL</strong> be capable of returning all of a patient's laboratory diagnostic reports queried by category code and date range using:</p><p><code class="highlighter-rouge">GET [base]/DiagnosticReport?patient=[id]&category=LAB&date=[date]{&date=[date]}</code></p></li><li><p>A server <strong>SHALL</strong> be capable of returning all of a patient's laboratory diagnostic reports queried by category and code using:</p><p><code class="highlighter-rouge">GET [base]/DiagnosticReport?patient=[id]&category=LAB&code=[LOINC]</code></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:</p><p><code class="highlighter-rouge">GET [base]/DiagnosticReport?patient=[id]&category=LAB&code=[LOINC1{,LOINC2,LOINC3,…}]&date=[date]{&date=[date]}</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Modifiers</th></tr></thead><tbody><tr><td>SHALL</td><td>patient + category</td><td>reference + token</td><td/></tr><tr><td>SHALL</td><td>patient + category + code</td><td>reference + token</td><td/></tr><tr><td>SHALL</td><td>patient + category + date</td><td>reference + token + date</td><td>date modifiers'ge','le','gt','lt'</td></tr><tr><td>SHOULD</td><td>patient + category + code + date</td><td>reference + token + date</td><td>date modifiers'ge','le','gt','lt'</td></tr></tbody></table><h5 id="goal" class="no_toc">8. Goal</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-goal.html">US Core Goal Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning all of a patient's goals using:</p><p><code class="highlighter-rouge">Get [base]/Goal?patient=[id]</code></p></li><li><p>A server <strong>SHALL</strong> be capable of returning all of all of a patient's goals over a specified time period using:</p><p><code class="highlighter-rouge">GET [base]/Goal?patient=[id]&date=[date]{&date=[date]}</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Modifiers</th></tr></thead><tbody><tr><td>SHALL</td><td>patient</td><td>reference</td><td/></tr><tr><td>SHALL</td><td>patient + date</td><td>reference + date</td><td>date modifiers'ge','le','gt','lt'</td></tr></tbody></table><h5 id="immunization" class="no_toc">9. Immunization</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-immunization.html">US Core Immunization Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning all patient's allergies using:</p><p><code class="highlighter-rouge">Get [base]/Immunization?patient=[id]</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td>SHALL</td><td>patient</td><td>reference</td></tr></tbody></table><h5 id="location" class="no_toc">10. Location</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-location.html">US Core Location Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning a location by name using:</p><p><code class="highlighter-rouge">Get [base]/Location?name=[string]</code></p></li><li><p>A server <strong>SHALL</strong> be capable of returning a location by address using:</p><p><code class="highlighter-rouge">GET [base]/Location?address=[string]</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td>SHALL</td><td>name</td><td>string</td></tr><tr><td>SHALL</td><td>address</td><td>string</td></tr></tbody></table><h5 id="medication" class="no_toc">11. Medication</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-medication.html">US Core Medication Profile</a></p><p>The MedicationStatement and MedicationRequest resources can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationStatement or a MedicationRequest, then the READ and SEARCH Criteria SHALL be supported.</p><h5 id="medicationstatement" class="no_toc">12. MedicationStatement</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-medicationstatement.html">US Core MedicationStatement Profile</a></p><p>Search Criteria:</p><p>The MedicationStatement resources can represent a medication using either a code or refer to the 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 <strong>MAY</strong> choose any one way or more than one method, but <em>if</em> an external reference to Medication is used, the server <strong>SHALL</strong> support the <a href="http://hl7.org/fhir/2017Jan/references.html#include"><code class="highlighter-rouge">_include</code></a> parameter for searching this element. The client application must support all methods.</p><p>A server <strong>SHALL</strong> be capable of returning all medications for a patient using one of or both:</p><p><code class="highlighter-rouge">GET /MedicationStatement?patient=[id]</code></p><p><code class="highlighter-rouge">GET /MedicationStatement?patient=[id]&_include=MedicationStatement:medication</code></p><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>_include(see documentation)</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td>patient</td><td>reference</td><td>MedicationStatement:medication</td></tr></tbody></table><h5 id="medicationrequest" class="no_toc">13. MedicationRequest</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-medicationrequest.html">US Core MedicationRequest Profile</a></p><p>Search Criteria:</p><p>The MedicationRequest resources can represent a medication using either a code or refer to the 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 <strong>MAY</strong> choose any one way or more than one method, but <em>if</em> an external reference to Medication is used, the server <strong>SHALL</strong> support the <a href="http://hl7.org/fhir/2017Jan/references.html#include"><code class="highlighter-rouge">_include</code></a> parameter for searching this element. The client application must support all methods.</p><p>A server <strong>SHALL</strong> be capable of returning all medications for a patient using one of or both:</p><p><code class="highlighter-rouge">GET /MedicationRequest?patient=[id]</code></p><p><code class="highlighter-rouge">GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication</code></p><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>_include(see documentation)</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td>patient</td><td>reference</td><td>MedicationRequest:medication</td></tr></tbody></table><h5 id="observation" class="no_toc">14. Observation</h5><p>Supported Profiles:
1. <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-observationresults.html">US Core Result Observation Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning all of a patient's laboratory results queried by category using:</p><p><code class="highlighter-rouge">GET [base]/Observation?patient=[id]&category=laboratory</code></p></li><li><p>A server <strong>SHALL</strong> be capable of returning all of a patient's laboratory results queried by category code and date range using:</p><p><code class="highlighter-rouge">GET [base]/Observation?patient=[id]&category=laboratory&date=[date]{&date=[date]}</code></p></li><li><p>A server <strong>SHALL</strong> be capable of returning all of a patient's laboratory results queried by category and code using:</p><p><code class="highlighter-rouge">GET [base]/Observation?patient=[id]&category=laboratory&code=[LOINC]</code></p></li><li><p>A server <strong>SHOULD</strong> be capable of returning all of a patient's laboratory results queried by category and one or more codes and date range using:</p><p><code class="highlighter-rouge">GET [base]/Observation?patient=[id]&category=laboratory&code=[LOINC1{,LOINC2,LOINC3,...}]&date=[date]{&date=[date]}</code></p></li></ul><ol><li><a href="http://hl7.org/fhir/STU3/vitalsigns.html">Vital Signs Profile</a></li></ol><p>Search Criteria</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning all of a patient's vital signs that it supports using:</p><p><code class="highlighter-rouge">GET [base]/Observation?patient=[id]&category=vital-signs</code></p></li><li><p>A server <strong>SHALL</strong> be capable of returning all of a patient's vital signs queried by date range using:</p><p><code class="highlighter-rouge">GET [base]/Observation?patient=[id]&category=vital-signs&date=[date]{&date=[date]}</code></p></li><li><p>A server <strong>SHALL</strong> be capable of returning any of a patient's vital signs queried by one or more of the codes listed below using:</p><p><code class="highlighter-rouge">GET [base]/Observation?patient=[id]&code[vital sign LOINC{,LOINC2,LOINC3,…}]</code></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:</p><p><code class="highlighter-rouge">GET [base]/Observation?patient=[id]&code=[LOINC{,LOINC2…}]vital-signs&date=[date]{&date=[date]}</code></p></li></ul><ol><li><a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-smokingstatus.html">US Core Smoking Status Observation Profile</a></li></ol><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning a patient's smoking status using:</p><p><code class="highlighter-rouge">GET [base]/Observation?patient=[id]&code=72166-2</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Modifiers</th></tr></thead><tbody><tr><td>SHALL</td><td>patient + category</td><td>reference + token</td><td/></tr><tr><td>SHALL</td><td>patient + category + code</td><td>reference + token</td><td/></tr><tr><td>SHALL</td><td>patient + category + date</td><td>reference + token + date</td><td>date modifiers'ge','le','gt','lt'</td></tr><tr><td>SHOULD</td><td>patient + category + code + date</td><td>reference + token + date</td><td>date modifiers'ge','le','gt','lt'</td></tr></tbody></table><h5 id="organization" class="no_toc">15. Organization</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-organization.html">US Core Organization Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning an organization by identifier using:</p><table><tbody><tr><td>`GET [base]/Organization?identifier=[system]</td><td>[code]'</td></tr></tbody></table></li><li><p>A server <strong>SHALL</strong> be capable of returning an organization by name using:</p><p><code class="highlighter-rouge">GET [base]/Organization?name=[string]</code></p></li><li><p>A server <strong>SHALL</strong> be capable of returning an organization by address using:</p><p><code class="highlighter-rouge">GET [base]/Organization?address=[string]</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td>SHALL</td><td>identifier</td><td>token</td></tr><tr><td>SHALL</td><td>name</td><td>string</td></tr><tr><td>SHALL</td><td>address</td><td>string</td></tr></tbody></table><h5 id="practitioner" class="no_toc">16. Practitioner</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-practitioner.html">US Core Practitioner Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning a practitioner by identifier using:</p><p><code class="highlighter-rouge">GET [base]/Practitioner?identifier=[system]|[code]</code></p></li><li><p>A server <strong>SHALL</strong> be capable of returning a practitioner by name using:</p><p><code class="highlighter-rouge">GET [base]/Practitioner?family=[string]&given=[string]</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th></tr></thead><tbody><tr><td>SHALL</td><td>identifier</td><td>token</td></tr><tr><td>SHALL</td><td>name</td><td>string</td></tr></tbody></table><h5 id="procedure" class="no_toc">17. Procedure</h5><p>Supported Profiles: <a href="http://hl7.org/fhir/us/core/StructureDefinition-us-core-procedure.html">US Core Procedure Profile</a></p><p>Search Criteria:</p><ul><li><p>A server <strong>SHALL</strong> be capable of returning a patient's procedures using:
<code class="highlighter-rouge">GET/Procedure?patient=[id]</code></p></li><li><p>A server <strong>SHALL</strong> be capable of returning all of a patient's procedures over a specified time period using:</p><p><code class="highlighter-rouge">GET /Procedure?patient=[id]&date=[date]{&date=[date]}</code></p></li></ul><p>Search Parameters:</p><table class="grid"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Modifiers</th></tr></thead><tbody><tr><td>SHALL</td><td>patient</td><td>reference</td><td/></tr><tr><td>SHALL</td><td>patient + date</td><td>reference + date</td><td>date modifiers'ge','le','gt','lt'</td></tr></tbody></table>
</div>"
},
"url" : "http://hl7.org/fhir/us/core/CapabilityStatement/server",
"version" : "1.0.0",
"name" : "US Core Server",
"status" : "draft",
"date" : "2017-03-20",
"publisher" : "HL7 US Realm Steering Committee",
"contact" : [
{
"telecom" : [
{
"system" : "other",
"value" : "http://www.hl7.org/SpecialCommittees/usrealm/index.cfm"
}
]
}
],
"description" : "This profile defines the expected capabilities of the US Core Server conforming to the US Core IG.",
"kind" : "requirements",
"fhirVersion" : "3.0.0",
"acceptUnknown" : "extensions",
"format" : [
"xml",
"json"
],
"profile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "AllergyIntolerance"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance",
"display" : "US Core AllergyIntolerance Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "CarePlan"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan",
"display" : "US Core CarePlan Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "CareTeam"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam",
"display" : "US Core CareTeam Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Condition"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition",
"display" : "US Core Condition Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Device"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-device",
"display" : "US Core Device Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Goal"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal",
"display" : "US Core Goal Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Immunization"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization",
"display" : "US Core Immunization Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "DiagnosticReport"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport",
"display" : "US Core DiagnosticReport Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Observation"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observationresults",
"display" : "US Core Result Observation Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Location"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location",
"display" : "US Core Location Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Medication"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication",
"display" : "US Core Medication Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "MedicationRequest"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest",
"display" : "US Core MedicationRequest Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "MedicationStatement"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationstatement",
"display" : "US Core MedicationStatement Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Observation"
}
],
"reference" : "http://hl7.org/fhir/StructureDefinition/vitalsigns",
"display" : "Vital Signs Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Observation"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus",
"display" : "US Core Smoking Status Observation Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Organization"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization",
"display" : "US Core Organization Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Patient"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient",
"display" : "US Core Patient Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Practitioner"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner",
"display" : "US Core Practitioner Profile"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-profile-link",
"valueCode" : "Procedure"
}
],
"reference" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure",
"display" : "US Core Procedure Profile"
}
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"extension" : [
{
"extension" : [
{
"url" : "required",
"valueString" : "name"
},
{
"url" : "required",
"valueString" : "gender"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "name"
},
{
"url" : "required",
"valueString" : "birthdate"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "family"
},
{
"url" : "required",
"valueString" : "gender"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "given"
},
{
"url" : "required",
"valueString" : "gender"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Patient",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core patient resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core patients by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core patient instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core patient instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-name",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "family",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-family",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "given",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-given",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-identifier",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "gender",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-gender",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "birthdate",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-birthdate",
"type" : "date"
}
]
},
{
"type" : "AllergyIntolerance",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core AllergyIntolerance resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core AllergyIntolerance by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core AllergyIntolerance instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core AllergyIntolerance instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-Patient",
"type" : "reference"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "status"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "CarePlan",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core careplan resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core careplan by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core careplan instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core careplan instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-Patient",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-Category",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-Status",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-Date",
"type" : "date",
"documentation" : "The server SHALL support the date search modifiers 'ge','le','gt', and 'lt'"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "CareTeam",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core careteam resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core careteam by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core careteam instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core careteam instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/CareTeam-Patient",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/CareTeam-Status",
"type" : "token"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "clinicalstatus"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Condition",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core condition resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core condition by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core condition instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core condition instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-Patient",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-Category",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "clinicalstatus",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-ClinicalStatus",
"type" : "token"
}
]
},
{
"type" : "Device",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core device resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core device by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core device instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core device instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Device-Patient",
"type" : "reference"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Goal",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core Goal resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core Goal by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core Goal instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core Goal instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-Patient",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-Date",
"type" : "date",
"documentation" : "The server SHALL support the date search modifiers 'ge','le','gt', and 'lt'"
}
]
},
{
"type" : "Immunization",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core immunization resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core immunization by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core immunization instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core immunization instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-Patient",
"type" : "reference"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "DiagnosticReport",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core diagnosticreport resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core diagnosticreport by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core diagnosticreport instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core diagnosticreport instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-Patient",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-Category",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-Code",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-Date",
"type" : "date",
"documentation" : "The server SHALL support the date search modifiers 'ge','le','gt', and 'lt'"
}
]
},
{
"type" : "Location",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core location resources using different search criteria."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a historical version of a US Core location instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core Medication instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core Medication instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-Name",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-Address",
"type" : "string"
}
]
},
{
"type" : "Medication",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "IF the Medication Resource is used in a MedicationStatement or a MedicationRequest. Allows discovery of existing US Core Medication resources using different search criteria."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "IF the Medication Resource is used in a MedicationStatement or a MedicationRequest. Allows retrieval of a specific US Core Medication by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core Medication instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core Medication instance"
}
]
},
{
"type" : "MedicationStatement",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core medicationstatement resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core medicationstatement by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core medicationstatement instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core medicationstatement instance"
}
],
"searchInclude" : [
"MedicationStatement.medicationReference"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationStatement-Patient",
"type" : "reference"
}
]
},
{
"type" : "MedicationRequest",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core medicationrequest resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core medicationrequest by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core medicationrequest instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core medicationrequest instance"
}
],
"searchInclude" : [
"MedicationRequest.medicationReference"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-Patient",
"type" : "reference"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Observation",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core results observation, smokingstatus, and vitals signs observation using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core results observation, smokingstatus, and vitals signs observation by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core results observation, smokingstatus, and vitals signs observation over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core results observation, smokingstatus, and vitals signs observation instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-Patient",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-Category",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-Code",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-Date",
"type" : "date",
"documentation" : "The server SHALL support the date search modifiers 'ge','le','gt', and 'lt'"
}
]
},
{
"type" : "Organization",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core organization resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core organization by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core organization instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core organization instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-Identifier",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-Name",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-Address",
"type" : "string"
}
]
},
{
"type" : "Practitioner",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core practitioner resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core practitioner by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core practitioner instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core practitioner instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-Identifier",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-Name",
"type" : "string"
}
]
},
{
"extension" : [
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Procedure",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows discovery of existing US Core procedure resources using different search criteria"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a specific US Core procedure by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance",
"documentation" : "Allows review of changes to US Core procedure instance over time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread",
"documentation" : "Allows retrieval of a historical version of a US Core procedure instance"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-Patient",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-Date",
"type" : "date",
"documentation" : "The server SHALL support the date search modifiers 'ge','le','gt', and 'lt'"
}
]
}
]
}
]
}
US Core © v1.0.0 (STU1) based on FHIR Release 3 (STU; 3.0.0) generated on Tue, Mar 21, 2017 11:28+1100. |
