US Core Implementation Guide
3.2.0 - ballot
US Core Implementation Guide
3.2.0 - ballot
This page is part of the US Core (v3.2.0: STU4 Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions 
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="us-core-server"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"> <h2 id="title">US Core Server CapabilityStatement</h2> <ul> <li>Implementation Guide Version: 3.1.1</li> <li>FHIR Version: 4.0.1</li> <li>Supported formats: xml, json</li> <li>Published: 2020-11-20</li> <li>Published by: HL7 International - US Realm Steering Committee</li> </ul> <p>This 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) and and the ONC <a href="https://www.healthit.gov/isa/sites/isa/files/2020-03/USCDI-Version1-2020-Final-Standard.pdf">U.S. Core Data for Interoperability (USCDI)</a>. 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> <h3 id="behavior">FHIR RESTful Capabilities</h3> <p>The US Core Server <strong>SHALL</strong>:</p> <ol> <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 400): invalid parameter</li> <li>(Status 401/4xx): unauthorized request</li> <li>(Status 403): insufficient scopes</li> <li>(Status 404): unknown resource</li> </ul> </li> <li>Support json source formats for all US Core interactions.</li> </ol> <p>The US Core Server <strong>SHOULD</strong>:</p> <ol> <li>Support xml source formats for all US Core interactions.</li> <li>Identify the US Core profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li> <li>Support xml resource formats for all Argonaut questionnaire interactions.</li> </ol> <p id="security"><strong>Security:</strong></p> <ol> <li>See the <a href="security.html">General Security Considerations</a> section for requirements and recommendations.</li> <li>A server <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li> </ol> <p><strong>Summary of System Wide Interactions</strong></p> <ul> <li><strong>MAY</strong> support the <code>transaction</code> interaction.</li> <li><strong>MAY</strong> support the <code>batch</code> interaction.</li> <li><strong>MAY</strong> support the <code>search-system</code> interaction.</li> <li><strong>MAY</strong> support the <code>history-system</code> interaction.</li> </ul> <h3 id="resource--details" class="no_toc">RESTful Capabilities by Resource/Profile:</h3> <p><strong>Summary of Search Criteria</strong></p> <table class="grid"> <thead> <tr> <th>Resource Type</th> <th>Supported Profiles</th> <th>Supported Searches</th> <th>Supported <code>_includes</code></th> <th>Supported <code>_revincludes</code></th> <th>Supported Operations</th> </tr> </thead> <tbody> <tr> <td> <a href="#allergyintolerance">AllergyIntolerance</a> </td> <td> <a href="StructureDefinition-us-core-allergyintolerance.html">US Core AllergyIntolerance Profile</a> </td> <td> clinical-status, patient patient+clinical-status </td> <td> </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#careplan">CarePlan</a> </td> <td> <a href="StructureDefinition-us-core-careplan.html">US Core CarePlan Profile</a> </td> <td> category, date, patient, status patient+category, patient+category+status, patient+category+date, patient+category+status+date </td> <td> </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#careteam">CareTeam</a> </td> <td> <a href="StructureDefinition-us-core-careteam.html">US Core CareTeam Profile</a> </td> <td> patient, status patient+status </td> <td> </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#condition">Condition</a> </td> <td> <a href="StructureDefinition-us-core-condition.html">US Core Condition Profile</a> </td> <td> category, clinical-status, patient, onset-date, code patient+category, patient+code, patient+clinical-status, patient+onset-date </td> <td> </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#device">Device</a> </td> <td> <a href="StructureDefinition-us-core-implantable-device.html">US Core Implantable Device Profile</a> </td> <td> patient, type patient+type </td> <td> </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#diagnosticreport">DiagnosticReport</a> </td> <td> <a href="StructureDefinition-us-core-diagnosticreport-lab.html">US Core DiagnosticReport Profile for Laboratory Results Reporting</a>, <a href="StructureDefinition-us-core-diagnosticreport-note.html">US Core DiagnosticReport Profile for Report and Note exchange</a> </td> <td> status, patient, category, code, date patient+category+date, patient+code, patient+status, patient+code+date, patient+category </td> <td> </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#documentreference">DocumentReference</a> </td> <td> <a href="StructureDefinition-us-core-documentreference.html">US Core DocumentReference Profile</a> </td> <td> _id, status, patient, category, type, date, period patient+category+date, patient+type+period, patient+type, patient+status, patient+category </td> <td> </td> <td> Provenance:target </td> <td> docref </td> </tr> <tr> <td> <a href="#encounter">Encounter</a> </td> <td> <a href="StructureDefinition-us-core-encounter.html">US Core Encounter Profile</a> </td> <td> _id, class, date, identifier, patient, status, type date+patient, class+patient, patient+status, patient+type </td> <td> </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#goal">Goal</a> </td> <td> <a href="StructureDefinition-us-core-goal.html">US Core Goal Profile</a> </td> <td> lifecycle-status, patient, target-date patient+target-date, patient+lifecycle-status </td> <td> </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#immunization">Immunization</a> </td> <td> <a href="StructureDefinition-us-core-immunization.html">US Core Immunization Profile</a> </td> <td> patient, status, date patient+date, patient+status </td> <td> </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#location">Location</a> </td> <td> <a href="StructureDefinition-us-core-location.html">US Core Location Profile</a> </td> <td> name, address, address-city, address-state, address-postalcode </td> <td> </td> <td> </td> <td> </td> </tr> <tr> <td> <a href="#medication">Medication</a> </td> <td> <a href="StructureDefinition-us-core-medication.html">US Core Medication Profile</a> </td> <td> </td> <td> </td> <td> </td> <td> </td> </tr> <tr> <td> <a href="#medicationrequest">MedicationRequest</a> </td> <td> <a href="StructureDefinition-us-core-medicationrequest.html">US Core MedicationRequest Profile</a> </td> <td> status, intent, patient, encounter, authoredon patient+intent+authoredon, patient+intent, patient+intent+status, patient+intent+encounter </td> <td> MedicationRequest:medication </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#observation">Observation</a> </td> <td> <a href="StructureDefinition-us-core-observation-lab.html">US Core Laboratory Result Observation Profile</a>, <a href="StructureDefinition-us-core-vital-signs.html">US Core Vital Signs Profile</a>, <a href="StructureDefinition-us-core-blood-pressure.html">US Core Blood Pressure Profile</a>, <a href="StructureDefinition-us-core-bmi.html">US Core BMI Profile</a>, <a href="StructureDefinition-us-core-head-circumference.html">US Core Head Circumference Profile</a>, <a href="StructureDefinition-us-core-body-height.html">US Core Body Height Profile</a>, <a href="StructureDefinition-us-core-body-weight.html">US Core Body Weight Profile</a>, <a href="StructureDefinition-us-core-body-temperature.html">US Core Body Temperature Profile</a>, <a href="StructureDefinition-us-core-heart-rate.html">US Core Heart Rate Profile</a>, <a href="StructureDefinition-pediatric-bmi-for-age.html">US Core Pediatric BMI for Age Observation Profile</a>, <a href="StructureDefinition-head-occipital-frontal-circumference-percentile.html">US Core Pediatric Head Occipital-frontal Circumference Percentile Profile</a>, <a href="StructureDefinition-pediatric-weight-for-height.html">US Core Pediatric Weight for Height Observation Profile</a>, <a href="StructureDefinition-us-core-pulse-oximetry.html">US Core Pulse Oximetry Profile</a>, <a href="StructureDefinition-us-core-respiratory-rate.html">US Core Respiratory Rate Profile</a>, <a href="StructureDefinition-us-core-smokingstatus.html">US Core Smoking Status Observation Profile</a> </td> <td> status, category, code, date, patient patient+category+date, patient+code, patient+category+status, patient+code+date, patient+category </td> <td> </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#organization">Organization</a> </td> <td> <a href="StructureDefinition-us-core-organization.html">US Core Organization Profile</a> </td> <td> name, address </td> <td> </td> <td> </td> <td> </td> </tr> <tr> <td> <a href="#patient">Patient</a> </td> <td> <a href="StructureDefinition-us-core-patient.html">US Core Patient Profile</a> </td> <td> _id, birthdate, family, gender, given, identifier, name family+gender, gender+name, birthdate+name, birthdate+family </td> <td> </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#practitioner">Practitioner</a> </td> <td> <a href="StructureDefinition-us-core-practitioner.html">US Core Practitioner Profile</a> </td> <td> name, identifier </td> <td> </td> <td> </td> <td> </td> </tr> <tr> <td> <a href="#practitionerrole">PractitionerRole</a> </td> <td> <a href="StructureDefinition-us-core-practitionerrole.html">US Core PractitionerRole Profile</a> </td> <td> specialty, practitioner </td> <td> PractitionerRole:endpoint, PractitionerRole:practitioner </td> <td> </td> <td> </td> </tr> <tr> <td> <a href="#procedure">Procedure</a> </td> <td> <a href="StructureDefinition-us-core-procedure.html">US Core Procedure Profile</a> </td> <td> status, patient, date, code patient+status, patient+code+date, patient+date </td> <td> </td> <td> Provenance:target </td> <td> </td> </tr> <tr> <td> <a href="#provenance">Provenance</a> </td> <td> <a href="StructureDefinition-us-core-provenance.html">US Core Provenance Profile</a> </td> <td> </td> <td> </td> <td> </td> <td> </td> </tr> <tr> <td> <a href="#valueset">ValueSet</a> </td> <td> </td> <td> </td> <td> </td> <td> </td> <td> expand </td> </tr> </tbody> </table> <h4 id="allergyintolerance" class="no_toc">AllergyIntolerance</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-allergyintolerance.html">US Core AllergyIntolerance Profile</a> </p> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a AllergyIntolerance resource using: <code class="highlighter-rouge">GET [base]/AllergyIntolerance/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/AllergyIntolerance?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-allergyintolerance-clinical-status.html">clinical-status</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-allergyintolerance-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td>patient+clinical-status </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="careplan" class="no_toc">CarePlan</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-careplan.html">US Core CarePlan Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Additional considerations for systems aligning with <a href="http://www.hl7.org/implement/standards/product_brief.cfm?product_id=492">HL7 Consolidated (C-CDA)</a> Care Plan requirements: <ul> <li>US Core Goal <strong>SHOULD</strong> be present in CarePlan.goal</li> <li>US Core Condition <strong>SHOULD</strong> be present in CarePlan.addresses</li> <li>Assement and Plan <strong>MAY</strong> be included as narrative text</li> </ul> </li> </ul> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a CarePlan resource using: <code class="highlighter-rouge">GET [base]/CarePlan/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/CarePlan?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-careplan-category.html">category</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-careplan-date.html">date</a> </td> <td> date </td> <td align="left"> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-careplan-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-careplan-status.html">status</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHALL</strong> </td> <td>patient+category </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+category+status </td> <td>reference+token+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+category+date </td> <td>reference+token+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+category+status+date </td> <td>reference+token+token+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="careteam" class="no_toc">CareTeam</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-careteam.html">US Core CareTeam Profile</a> </p> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a CareTeam resource using: <code class="highlighter-rouge">GET [base]/CareTeam/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/CareTeam?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-careteam-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-careteam-status.html">status</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHALL</strong> </td> <td>patient+status </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="condition" class="no_toc">Condition</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-condition.html">US Core Condition Profile</a> </p> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Condition resource using: <code class="highlighter-rouge">GET [base]/Condition/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/Condition?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-condition-category.html">category</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-condition-clinical-status.html">clinical-status</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-condition-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-condition-onset-date.html">onset-date</a> </td> <td> date </td> <td align="left"> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-condition-code.html">code</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td>patient+category </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+code </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+clinical-status </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+onset-date </td> <td>reference+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="device" class="no_toc">Device</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-implantable-device.html">US Core Implantable Device Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Implantable medical devices that have UDI information <strong>SHALL</strong> represent this information in either <code>carrierAIDC</code> or <code>carrierHRF</code>. <ul> <li>UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants.</li> <li>Servers are not required to support both <code>carrierAIDC</code> and <code>carrierHR</code>.</li> </ul> </li> </ul> <ul> <li> <p>For Implantable medical devices that have UDI information, at least one of the Production Identifiers (UDI-PI) <strong>SHALL</strong> be present.</p> </li> <li> <p>Servers <strong>SHOULD</strong> support query by Device.type to allow clients to request the patient's devices by a specific type. Note: The Device.type is too granular to differentiate implantable vs. non-implantable devices.</p> </li> <li> <p>In the [Quick Start] section below, searching for all devices is described. Records of implanted devices <strong>MAY</strong> be queried against UDI data including:</p> <ul> <li>UDI HRF string (<code>udi-carrier</code>)</li> <li>UDI Device Identifier (<code>udi-di</code>)</li> <li>Manufacturer (<code>manufacturer</code>)</li> <li>Model number (<code>model</code>)</li> </ul> <p>Implementers <strong>MAY</strong> also adopt custom SearchParameters for searching by:</p> <ul> <li>lot numbers</li> <li>serial number</li> <li>expiration date</li> <li>manufacture date</li> <li>distinct identifier</li> </ul> </li> </ul> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Device resource using: <code class="highlighter-rouge">GET [base]/Device/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/Device?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-device-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-device-type.html">type</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td>patient+type </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="diagnosticreport" class="no_toc">DiagnosticReport</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-diagnosticreport-lab.html">US Core DiagnosticReport Profile for Laboratory Results Reporting</a>, <a href="StructureDefinition-us-core-diagnosticreport-note.html">US Core DiagnosticReport Profile for Report and Note exchange</a> </p> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>create</code><sup>†</sup>, <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <blockquote>create<sup>†</sup><p>This conformance expectation applies <strong>only</strong> to the <em>US Core DiagnosticReport Profile for Report and Note exchange</em> profile. The conformance expectation for the <em>US Core DiagnosticReport Profile for Laboratory Results Reporting</em> is <strong>MAY</strong>.</p> </blockquote> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a DiagnosticReport resource using: <code class="highlighter-rouge">GET [base]/DiagnosticReport/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/DiagnosticReport?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-diagnosticreport-status.html">status</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-diagnosticreport-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-diagnosticreport-category.html">category</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-diagnosticreport-code.html">code</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-diagnosticreport-date.html">date</a> </td> <td> date </td> <td align="left"> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHALL</strong> </td> <td>patient+category+date </td> <td>reference+token+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHALL</strong> </td> <td>patient+code </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+status </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+code+date </td> <td>reference+token+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHALL</strong> </td> <td>patient+category </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="documentreference" class="no_toc">DocumentReference</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-documentreference.html">US Core DocumentReference Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><p>The DocumentReference.type binding SHALL support at a minimum the <a href="ValueSet-us-core-clinical-note-type.html">5 Common Clinical Notes</a> and may extend to the full US Core DocumentReference Type Value Set</p> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>create</code>, <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Operation Summary:</p> <ul> <li><strong>SHALL</strong> support the <a href="OperationDefinition-docref.html">$docref</a> operation <p>A server <strong>SHALL</strong> be capable of responding to a $docref operation and capable of returning at least a reference to a generated CCD document, if available. <strong>MAY</strong> provide references to other 'on-demand' and 'stable' documents (or 'delayed/deferred assembly') that meet the query parameters as well. If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range If no date range is supplied, then the server <strong>SHALL</strong> provide references to last or current encounter. <strong>SHOULD</strong> document what resources, if any, are returned as included resources</p> <p><code>GET [base]/DocumentReference/$docref?patient=[id]</code></p> </li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a DocumentReference resource using: <code class="highlighter-rouge">GET [base]/DocumentReference/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/DocumentReference?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-documentreference-id.html">_id</a> </td> <td> token </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-documentreference-status.html">status</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-documentreference-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-documentreference-category.html">category</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-documentreference-type.html">type</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-documentreference-date.html">date</a> </td> <td> date </td> <td align="left"> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-documentreference-period.html">period</a> </td> <td> date </td> <td align="left"> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHALL</strong> </td> <td>patient+category+date </td> <td>reference+token+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+type+period </td> <td>reference+token+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHALL</strong> </td> <td>patient+type </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+status </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHALL</strong> </td> <td>patient+category </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="encounter" class="no_toc">Encounter</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-encounter.html">US Core Encounter Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>The Encounter resource can represent a reason using either a code with <code>Encounter.reasonCode</code>, or a reference with <code>Encounter.reasonReference</code> to Condition or other resource. <ul> <li>Although both are marked as must support, the server systems are not required to support both a code and a reference, but they <strong>SHALL</strong> support <em>at least one</em> of these elements.</li> <li>The client application <strong>SHALL</strong> support both elements.</li> <li>if <code>Encounter.reasonReference</code> references an Observation, it <strong>SHOULD</strong> conform to a US Core Observation if applicable. (for example, a laboratory result should conform to the US Core Laboratory Result Observation Profile)</li> </ul> </li> <li>The intent of this profile is to support <em>where the encounter occurred</em>. The location address can be represented by either by the Location referenced by <code>Encounter.location.location</code> or indirectly through the Organization referenced by <code>Encounter.serviceProvider</code>. <ul> <li>Although both are marked as must support, the server systems are not required to support both <code>Encounter.location.location</code> and <code>Encounter.serviceProvider</code>, but they <strong>SHALL</strong> support <em>at least one</em> of these elements.</li> <li>The client application <strong>SHALL</strong> support both elements.</li> <li>if using <code>Encounter.locatison.location</code> it <strong>SHOULD</strong> conform to US Core Location. However, as a result of implementation feedback, it <strong>MAY</strong> reference the base FHIR Location resource. See this guidance on [Referencing US Core Profiles]</li> </ul> </li> </ul> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Encounter resource using: <code class="highlighter-rouge">GET [base]/Encounter/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/Encounter?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-encounter-id.html">_id</a> </td> <td> token </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-encounter-class.html">class</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-encounter-date.html">date</a> </td> <td> date </td> <td align="left"> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href="SearchParameter-us-core-encounter-identifier.html">identifier</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-encounter-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-encounter-status.html">status</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-encounter-type.html">type</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHALL</strong> </td> <td>date+patient </td> <td>date+reference </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>class+patient </td> <td>token+reference </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+status </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+type </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="goal" class="no_toc">Goal</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-goal.html">US Core Goal Profile</a> </p> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Goal resource using: <code class="highlighter-rouge">GET [base]/Goal/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/Goal?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-goal-lifecycle-status.html">lifecycle-status</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-goal-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-goal-target-date.html">target-date</a> </td> <td> date </td> <td align="left"> <p>A client <strong>SHALL</strong> provide a value precise to the <em>day</em>.</p> <p>A server <strong>SHALL</strong> support a value a value precise to the <em>day</em>.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td>patient+target-date </td> <td>reference+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+lifecycle-status </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="immunization" class="no_toc">Immunization</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-immunization.html">US Core Immunization Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Based upon the ONC U.S. Core Data for Interoperability (USCDI) v1 requirements, CVX vaccine codes are required and the NDC vaccine codes <strong>SHOULD</strong> be supported as translations to them.</li> </ul> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Immunization resource using: <code class="highlighter-rouge">GET [base]/Immunization/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/Immunization?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-immunization-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-immunization-status.html">status</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-immunization-date.html">date</a> </td> <td> date </td> <td align="left"> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td>patient+date </td> <td>reference+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+status </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="location" class="no_toc">Location</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-location.html">US Core Location Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>The US Core Location and PractitionerRole Profiles are not explicitly referenced in any US Core Profile. However they <strong>SHOULD</strong> be used as the default profile if referenced by another US Core profile.</li> </ul> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Location resource using: <code class="highlighter-rouge">GET [base]/Location/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-location-name.html">name</a> </td> <td> string </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-location-address.html">address</a> </td> <td> string </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href="SearchParameter-us-core-location-address-city.html">address-city</a> </td> <td> string </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href="SearchParameter-us-core-location-address-state.html">address-state</a> </td> <td> string </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href="SearchParameter-us-core-location-address-postalcode.html">address-postalcode</a> </td> <td> string </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <hr/> <h4 id="medication" class="no_toc">Medication</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-medication.html">US Core Medication Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>The MedicationRequest resource can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationRequest, then the READ <strong>SHALL</strong> be supported.</li> </ul> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Medication resource using: <code class="highlighter-rouge">GET [base]/Medication/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> </ul> <hr/> <h4 id="medicationrequest" class="no_toc">MedicationRequest</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-medicationrequest.html">US Core MedicationRequest Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be <a href="http://hl7.org/fhir/R4/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 if an external reference to Medication is used, the server <strong>SHALL</strong> support the _include` parameter for searching this element. The client application must support all methods.</li> </ul> <p>For example, A server <strong>SHALL</strong> be capable of returning all medications for a patient using one of or both:</p> <p><code>GET /MedicationRequest?patient=[id]</code></p> <p><code>GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication</code></p> <ul> <li>The MedicationRequest resource can represent that information is from a secondary source using either a boolean flag or reference in <code>MedicationRequest.reportedBoolean</code>, or a reference using <code>MedicationRequest.reportedReference</code> to Practitioner or other resource. <ul> <li>Although both are marked as must support, the server systems are not required to support both a boolean and a reference, but <strong>SHALL</strong> choose to support at least one of these elements.</li> <li>The client application <strong>SHALL</strong> support both elements.</li> </ul> </li> </ul> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a MedicationRequest resource using: <code class="highlighter-rouge">GET [base]/MedicationRequest/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHOULD</strong> be capable of supporting the following _includes: MedicationRequest:medication - <code class="highlighter-rouge">GET [base]/MedicationRequest?[parameter=value]&_include=MedicationRequest:medication</code> </li> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/MedicationRequest?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-medicationrequest-status.html">status</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-medicationrequest-intent.html">intent</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-medicationrequest-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-medicationrequest-encounter.html">encounter</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-medicationrequest-authoredon.html">authoredon</a> </td> <td> date </td> <td align="left"> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td>patient+intent+authoredon </td> <td>reference+token+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHALL</strong> </td> <td>patient+intent </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHALL</strong> </td> <td>patient+intent+status </td> <td>reference+token+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+intent+encounter </td> <td>reference+token+reference </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="observation" class="no_toc">Observation</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-observation-lab.html">US Core Laboratory Result Observation Profile</a>, <a href="StructureDefinition-us-core-vital-signs.html">US Core Vital Signs Profile</a>, <a href="StructureDefinition-us-core-blood-pressure.html">US Core Blood Pressure Profile</a>, <a href="StructureDefinition-us-core-bmi.html">US Core BMI Profile</a>, <a href="StructureDefinition-us-core-head-circumference.html">US Core Head Circumference Profile</a>, <a href="StructureDefinition-us-core-body-height.html">US Core Body Height Profile</a>, <a href="StructureDefinition-us-core-body-weight.html">US Core Body Weight Profile</a>, <a href="StructureDefinition-us-core-body-temperature.html">US Core Body Temperature Profile</a>, <a href="StructureDefinition-us-core-heart-rate.html">US Core Heart Rate Profile</a>, <a href="StructureDefinition-pediatric-bmi-for-age.html">US Core Pediatric BMI for Age Observation Profile</a>, <a href="StructureDefinition-head-occipital-frontal-circumference-percentile.html">US Core Pediatric Head Occipital-frontal Circumference Percentile Profile</a>, <a href="StructureDefinition-pediatric-weight-for-height.html">US Core Pediatric Weight for Height Observation Profile</a>, <a href="StructureDefinition-us-core-pulse-oximetry.html">US Core Pulse Oximetry Profile</a>, <a href="StructureDefinition-us-core-respiratory-rate.html">US Core Respiratory Rate Profile</a>, <a href="StructureDefinition-us-core-smokingstatus.html">US Core Smoking Status Observation Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Systems <strong>SHOULD</strong> support <code>Observation.effectivePeriod</code> to accurately represent laboratory tests that are collected over a period of time (for example, a 24-Hour Urine Collection test).</li> <li>An Observation without a value, <strong>SHALL</strong> include a reason why the data is absent unless there are component observations, or references to other Observations that are grouped within it.</li> </ul> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Observation resource using: <code class="highlighter-rouge">GET [base]/Observation/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/Observation?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-observation-status.html">status</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-observation-category.html">category</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-observation-code.html">code</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-observation-date.html">date</a> </td> <td> date </td> <td align="left"> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-observation-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHALL</strong> </td> <td>patient+category+date </td> <td>reference+token+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHALL</strong> </td> <td>patient+code </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+category+status </td> <td>reference+token+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+code+date </td> <td>reference+token+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHALL</strong> </td> <td>patient+category </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="organization" class="no_toc">Organization</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-organization.html">US Core Organization Profile</a> </p> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Organization resource using: <code class="highlighter-rouge">GET [base]/Organization/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-organization-name.html">name</a> </td> <td> string </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-organization-address.html">address</a> </td> <td> string </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <hr/> <h4 id="patient" class="no_toc">Patient</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-patient.html">US Core Patient Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>For ONC's USCDI requirements, each Patient must support the following additional elements. These elements are included in the formal definition of the profile. The patient examples include all of these elements.</li> </ul> <ol> <li>contact detail (e.g. a telephone number or an email address)</li> <li>a communication language</li> <li>a race</li> <li>an ethnicity</li> <li>a birth sex*</li> <li>previous name <ul> <li>Previous name is represented by providing an end date in the <code>Patient.name.period</code> element for a previous name.</li> </ul> </li> <li>suffix <ul> <li>Suffix is represented using the <code>Patient.name.suffix</code> element.</li> </ul> </li> </ol> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Patient resource using: <code class="highlighter-rouge">GET [base]/Patient/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/Patient?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-patient-id.html">_id</a> </td> <td> token </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-patient-birthdate.html">birthdate</a> </td> <td> date </td> <td align="left"> <p>A client <strong>SHALL</strong> provide a value precise to the <em>day</em>.</p> <p>A server <strong>SHALL</strong> support a value a value precise to the <em>day</em>.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-patient-family.html">family</a> </td> <td> string </td> <td align="left"> <ul> <li>A server <strong>SHALL</strong> support a value precise to the <em>day</em>.</li> </ul> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-patient-gender.html">gender</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-patient-given.html">given</a> </td> <td> string </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-patient-identifier.html">identifier</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-patient-name.html">name</a> </td> <td> string </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td>family+gender </td> <td>string+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHALL</strong> </td> <td>gender+name </td> <td>token+string </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHALL</strong> </td> <td>birthdate+name </td> <td>date+string </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>birthdate+family </td> <td>date+string </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="practitioner" class="no_toc">Practitioner</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-practitioner.html">US Core Practitioner Profile</a> </p> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Practitioner resource using: <code class="highlighter-rouge">GET [base]/Practitioner/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-practitioner-name.html">name</a> </td> <td> string </td> <td align="left"> - <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-practitioner-identifier.html">identifier</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <hr/> <h4 id="practitionerrole" class="no_toc">PractitionerRole</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-practitionerrole.html">US Core PractitionerRole Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>The US Core Location and PractitionerRole Profiles are not explicitly referenced in any US Core Profile. However they <strong>SHOULD</strong> be used as the default profile if referenced by another US Core profile.</li> </ul> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a PractitionerRole resource using: <code class="highlighter-rouge">GET [base]/PractitionerRole/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHOULD</strong> be capable of supporting the following _includes: PractitionerRole:endpoint - <code class="highlighter-rouge">GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:endpoint</code> PractitionerRole:practitioner - <code class="highlighter-rouge">GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner</code> </li> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-practitionerrole-specialty.html">specialty</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-practitionerrole-practitioner.html">practitioner</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <hr/> <h4 id="procedure" class="no_toc">Procedure</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-procedure.html">US Core Procedure Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>A procedure including an implantable device <strong>SHOULD</strong> use <code>Procedure.focalDevice</code> with a reference to the [US Core Implantable Device Profile].</li> </ul> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Procedure resource using: <code class="highlighter-rouge">GET [base]/Procedure/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> <li> A Server <strong>SHALL</strong> be capable of supporting the following _revincludes: Provenance:target - <code class="highlighter-rouge">GET [base]/Procedure?[parameter=value]&_revinclude=Provenance:target</code> </li> </ul> <p>Search Parameter Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-procedure-status.html">status</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href="SearchParameter-us-core-procedure-patient.html">patient</a> </td> <td> reference </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-procedure-date.html">date</a> </td> <td> date </td> <td align="left"> <p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p> <p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr><tr> <td> <strong>MAY</strong> </td> <td> <a href="SearchParameter-us-core-procedure-code.html">code</a> </td> <td> token </td> <td align="left"> <p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p> <p>The server <strong>SHALL</strong> support both.</p> <!-- <code class="highlighter-rouge">GET [base]/{{r.type}}?{{s.name}}{%- if s.name == '_id' %}=[id]
{%- elif s.name == 'status' %}=[status]
{%- elif s.type == 'composite' %}=[code]&[value]
{%- elif s.type == 'uri' %}=[uri]
{%- elif s.type == 'string' %}=[{{s.name}}]
{%- elif s.type == 'token' %}=[system]|[code]
{%- elif s.name in ['us-core-includeprovenance'] %}
{%- else %}=[{{s.name}}]
{%- endif %}</code> --> </td> </tr> </tbody> </table> <p>Search Parameter Combination Summary:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> <!-- <th>Example</th> --> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td>patient+status </td> <td>reference+token </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHOULD</strong> </td> <td>patient+code+date </td> <td>reference+token+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> <tr> <td><strong>SHALL</strong> </td> <td>patient+date </td> <td>reference+date </td> <!-- <td>
<code class="highlighter-rouge">GET [base]/{{r.type}}?
{%- for combo in combos.extension if combo.url == 'required' or combo.url == 'optional'-%}
{%- set p = combo.valueString -%}{%- set t = sp_map[combo.valueString] -%}
{{p}}{%- if p == '_id' %}=[id]
{%- elif p == 'status' %}=[status]
{%- elif t == 'composite' %}=[code]&[value]
{%- elif t == 'uri' %}=[uri]
{%- elif t == 'string' %}=[{{p}}]
{%- elif t== 'token' %}=[system]|[code]
{%- elif p in ['us-core-includeprovenance'] %}
{%- else %}=[{{p}}]
{%- endif %}
{%- if not loop.last %}&{%- endif %}
{%- endfor -%}
</code>
</td> --> </tr> </tbody> </table> <hr/> <h4 id="provenance" class="no_toc">Provenance</h4> <p>Conformance Expectation: <strong>SHALL</strong></p> <p>Supported Profiles: <a href="StructureDefinition-us-core-provenance.html">US Core Provenance Profile</a> </p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>If a system receives a provider in <code>Provenance.agent.who</code> as free text they must capture who sent them the information as the organization. On request they <strong>SHALL</strong> provide this organization as the source and <strong>MAY</strong> include the free text provider.</li> <li>Systems that need to know the activity has occurred <strong>SHOULD</strong> populate the activity.</li> </ul> </blockquote> <p>Reference Policy: <code>resolves</code></p> <p>Profile Interaction Summary:</p> <ul> <li><strong>SHALL</strong> support <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>, <code>history-instance</code>.</li><li><strong>MAY</strong> support <code>create</code>, <code>search-type</code>, <code>update</code>, <code>patch</code>, <code>delete</code>, <code>history-type</code>.</li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Server <strong>SHALL</strong> be capable of returning a Provenance resource using: <code class="highlighter-rouge">GET [base]/Provenance/[id]</code> </li> <!-- Only SHOULDs for include for now the capability statement does not create the primitive extensios for this yet --> <!-- Only SHALLs for revinclude for now the capability statement does not create the primitive extensios for this yet --> </ul> <hr/> <h4 id="valueset" class="no_toc">ValueSet</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Operation Summary:</p> <ul> <li><strong>SHOULD</strong> support the <a href="http://hl7.org/fhir/OperationDefinition/ValueSet-expand">$expand</a> operation <p>A client can determine the note and report types support by a server by invoking the standard FHIR Value Set Expansion ($expand) operation defined in the FHIR R4 specification. Because servers may support different read and write formats, it also is used to determine the formats (for example, text, pdf) the server supports read and write transactions.</p> </li> </ul> <hr/> </div>
</text>
<url value="http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server"/>
<version value="3.2.0"/>
<name value="UsCoreServerCapabilityStatement"/>
<title value="US Core Server CapabilityStatement"/>
<status value="active"/>
<experimental value="false"/>
<date value="2020-11-20"/>
<publisher value="HL7 International - US Realm Steering Committee"/>
<contact>
<name value="HL7 International - US Realm Steering Committee"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/usrealm/index.cfm"/>
</telecom>
</contact>
<description
value="This 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) and and the ONC [U.S. Core Data for Interoperability (USCDI)](https://www.healthit.gov/isa/sites/isa/files/2020-03/USCDI-Version1-2020-Final-Standard.pdf). 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."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<copyright
value="Used by permission of HL7 International, all rights reserved Creative Commons License"/>
<kind value="requirements"/>
<fhirVersion value="4.0.1"/>
<format value="xml"/>
<format value="json"/>
<patchFormat value="application/json-patch+json"/>
<implementationGuide
value="http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core|3.2.0"/>
<rest>
<mode value="server"/>
<documentation
value="The US Core Server **SHALL**:
1. Support the US Core Patient resource profile.
1. Support at least one additional resource profile from the list of US Core Profiles.
1. Implement the RESTful behavior according to the FHIR specification.
1. Return the following response classes:
- (Status 400): invalid parameter
- (Status 401/4xx): unauthorized request
- (Status 403): insufficient scopes
- (Status 404): unknown resource
1. Support json source formats for all US Core interactions.
The US Core Server **SHOULD**:
1. Support xml source formats for all US Core interactions.
1. Identify the US Core profiles supported as part of the FHIR `meta.profile` attribute for each instance.
1. Support xml resource formats for all Argonaut questionnaire interactions."/>
<security>
<description
value="1. See the [General Security Considerations](security.html) section for requirements and recommendations.
1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."/>
</security>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="clinical-status"/>
</extension>
</extension>
<type value="AllergyIntolerance"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="clinical-status"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<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/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<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/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<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"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"/>
<documentation
value="* Additional considerations for systems aligning with [HL7 Consolidated (C-CDA)](http://www.hl7.org/implement/standards/product_brief.cfm?product_id=492) Care Plan requirements:
- US Core Goal **SHOULD** be present in CarePlan.goal
- US Core Condition **SHOULD** be present in CarePlan.addresses
- Assement and Plan **MAY** be included as narrative text"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="category"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-category"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="date"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-date"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *second + time offset*.
A server **SHALL** support a value precise to the *second + time offset*."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-status"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<type value="CareTeam"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-status"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="code"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="clinical-status"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="onset-date"/>
</extension>
</extension>
<type value="Condition"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="category"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="clinical-status"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="onset-date"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-onset-date"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *second + time offset*.
A server **SHALL** support a value precise to the *second + time offset*."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="code"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-code"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="type"/>
</extension>
</extension>
<type value="Device"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"/>
<documentation
value="* Implantable medical devices that have UDI information **SHALL** represent this information in either `carrierAIDC` or `carrierHRF`.
- UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants.
- Servers are not required to support both `carrierAIDC` and `carrierHR`.
- For Implantable medical devices that have UDI information, at least one of the Production Identifiers (UDI-PI) **SHALL** be present.
- Servers **SHOULD** support query by Device.type to allow clients to request the patient's devices by a specific type. Note: The Device.type is too granular to differentiate implantable vs. non-implantable devices.
- In the [Quick Start] section below, searching for all devices is described. Records of implanted devices **MAY** be queried against UDI data including:
- UDI HRF string (`udi-carrier`)
- UDI Device Identifier (`udi-di`)
- Manufacturer (`manufacturer`)
- Model number (`model`)
Implementers **MAY** also adopt custom SearchParameters for searching by:
- lot numbers
- serial number
- expiration date
- manufacture date
- distinct identifier"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-device-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="type"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-device-type"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<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/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="code"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="code"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
</extension>
<type value="DiagnosticReport"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="create"/>
<documentation
value="This conformance expectation applies **only** to the *US Core DiagnosticReport Profile for Report and Note exchange* profile. The conformance expectation for the *US Core DiagnosticReport Profile for Laboratory Results Reporting* is **MAY**."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-status"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="category"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="code"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="date"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *second + time offset*.
A server **SHALL** support a value precise to the *second + time offset*."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<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/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="type"/>
</extension>
<extension url="required">
<valueString value="period"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="type"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
</extension>
<type value="DocumentReference"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"/>
<documentation
value="The DocumentReference.type binding SHALL support at a minimum the [5 Common Clinical Notes](ValueSet-us-core-clinical-note-type.html) and may extend to the full US Core DocumentReference Type Value Set"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-status"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="category"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="type"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="date"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *second + time offset*.
A server **SHALL** support a value precise to the *second + time offset*."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="period"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *second + time offset*.
A server **SHALL** support a value precise to the *second + time offset*."/>
</searchParam>
<operation>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="docref"/>
<definition
value="http://hl7.org/fhir/us/core/OperationDefinition/docref"/>
<documentation
value="A server **SHALL** be capable of responding to a $docref operation and capable of returning at least a reference to a generated CCD document, if available. **MAY** provide references to other 'on-demand' and 'stable' documents (or 'delayed/deferred assembly') that meet the query parameters as well. If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range If no date range is supplied, then the server **SHALL** provide references to last or current encounter. **SHOULD** document what resources, if any, are returned as included resources
`GET [base]/DocumentReference/$docref?patient=[id]`"/>
</operation>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="class"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="type"/>
</extension>
</extension>
<type value="Encounter"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"/>
<documentation
value="* The Encounter resource can represent a reason using either a code with `Encounter.reasonCode`, or a reference with `Encounter.reasonReference` to Condition or other resource.
* Although both are marked as must support, the server systems are not required to support both a code and a reference, but they **SHALL** support *at least one* of these elements.
* The client application **SHALL** support both elements.
* if `Encounter.reasonReference` references an Observation, it **SHOULD** conform to a US Core Observation if applicable. (for example, a laboratory result should conform to the US Core Laboratory Result Observation Profile)
* The intent of this profile is to support *where the encounter occurred*. The location address can be represented by either by the Location referenced by `Encounter.location.location` or indirectly through the Organization referenced by `Encounter.serviceProvider`.
* Although both are marked as must support, the server systems are not required to support both `Encounter.location.location` and `Encounter.serviceProvider`, but they **SHALL** support *at least one* of these elements.
* The client application **SHALL** support both elements.
* if using `Encounter.locatison.location` it **SHOULD** conform to US Core Location. However, as a result of implementation feedback, it **MAY** reference the base FHIR Location resource. See this guidance on [Referencing US Core Profiles]"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-id"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="class"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-class"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="date"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-date"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *second + time offset*.
A server **SHALL** support a value precise to the *second + time offset*."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-identifier"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-status"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="type"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-type"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="target-date"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="lifecycle-status"/>
</extension>
</extension>
<type value="Goal"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="lifecycle-status"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-lifecycle-status"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="target-date"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-target-date"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *day*.
A server **SHALL** support a value a value precise to the *day*."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<type value="Immunization"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"/>
<documentation
value="* Based upon the ONC U.S. Core Data for Interoperability (USCDI) v1 requirements, CVX vaccine codes are required and the NDC vaccine codes **SHOULD** be supported as translations to them."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-status"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="date"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *second + time offset*.
A server **SHALL** support a value precise to the *second + time offset*."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Location"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"/>
<documentation
value="* The US Core Location and PractitionerRole Profiles are not explicitly referenced in any US Core Profile. However they **SHOULD** be used as the default profile if referenced by another US Core profile."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-location-name"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="address-city"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-city"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="address-state"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-state"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="address-postalcode"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-postalcode"/>
<type value="string"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Medication"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"/>
<documentation
value="* The MedicationRequest resource can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationRequest, then the READ **SHALL** be supported."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="intent"/>
</extension>
<extension url="required">
<valueString value="authoredon"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="intent"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="intent"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="intent"/>
</extension>
<extension url="required">
<valueString value="encounter"/>
</extension>
</extension>
<type value="MedicationRequest"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"/>
<documentation
value="* The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be [contained](http://hl7.org/fhir/R4/references.html#contained) or an external resource. The server application **MAY** choose any one way or more than one method, but if an external reference to Medication is used, the server **SHALL** support the _include` parameter for searching this element. The client application must support all methods.
For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:
`GET /MedicationRequest?patient=[id]`
`GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication`
* The MedicationRequest resource can represent that information is from a secondary source using either a boolean flag or reference in `MedicationRequest.reportedBoolean`, or a reference using `MedicationRequest.reportedReference` to Practitioner or other resource.
* Although both are marked as must support, the server systems are not required to support both a boolean and a reference, but **SHALL** choose to support at least one of these elements.
* The client application **SHALL** support both elements."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchInclude value="MedicationRequest:medication"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="intent"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="encounter"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-encounter"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="authoredon"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *second + time offset*.
A server **SHALL** support a value precise to the *second + time offset*."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<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/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="code"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<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/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="code"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="category"/>
</extension>
</extension>
<type value="Observation"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"/>
<documentation
value="* Systems **SHOULD** support `Observation.effectivePeriod` to accurately represent laboratory tests that are collected over a period of time (for example, a 24-Hour Urine Collection test).
* An Observation without a value, **SHALL** include a reason why the data is absent unless there are component observations, or references to other Observations that are grouped within it."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-status"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="category"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="code"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="date"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *second + time offset*.
A server **SHALL** support a value precise to the *second + time offset*."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Organization"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-name"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-address"/>
<type value="string"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="family"/>
</extension>
<extension url="required">
<valueString value="gender"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="gender"/>
</extension>
<extension url="required">
<valueString value="name"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="birthdate"/>
</extension>
<extension url="required">
<valueString value="name"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="birthdate"/>
</extension>
<extension url="required">
<valueString value="family"/>
</extension>
</extension>
<type value="Patient"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/>
<documentation
value="* For ONC's USCDI requirements, each Patient must support the following additional elements. These elements are included in the formal definition of the profile. The patient examples include all of these elements.
1. contact detail (e.g. a telephone number or an email address)
1. a communication language
1. a race
1. an ethnicity
1. a birth sex*
1. previous name
- Previous name is represented by providing an end date in the `Patient.name.period` element for a previous name.
1. suffix
- Suffix is represented using the `Patient.name.suffix` element.
"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="birthdate"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *day*.
A server **SHALL** support a value a value precise to the *day*."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="family"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family"/>
<type value="string"/>
<documentation
value="* A server **SHALL** support a value precise to the *day*."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="gender"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="given"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name"/>
<type value="string"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Practitioner"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-name"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="PractitionerRole"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"/>
<documentation
value="* The US Core Location and PractitionerRole Profiles are not explicitly referenced in any US Core Profile. However they **SHOULD** be used as the default profile if referenced by another US Core profile."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchInclude value="PractitionerRole:endpoint"/>
<searchInclude value="PractitionerRole:practitioner"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="specialty"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-specialty"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="practitioner"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-practitioner"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="status"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="code"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension url="required">
<valueString value="patient"/>
</extension>
<extension url="required">
<valueString value="date"/>
</extension>
</extension>
<type value="Procedure"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"/>
<documentation
value="* A procedure including an implantable device **SHOULD** use `Procedure.focalDevice` with a reference to the [US Core Implantable Device Profile]."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-status"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-patient"/>
<type value="reference"/>
<documentation
value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="date"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date"/>
<type value="date"/>
<documentation
value="A client **SHALL** provide a value precise to the *second + time offset*.
A server **SHALL** support a value precise to the *second + time offset*."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="code"/>
<definition
value="http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-code"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Provenance"/>
<supportedProfile
value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"/>
<documentation
value="* If a system receives a provider in `Provenance.agent.who` as free text they must capture who sent them the information as the organization. On request they **SHALL** provide this organization as the source and **MAY** include the free text provider.
* Systems that need to know the activity has occurred **SHOULD** populate the activity."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="create"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="patch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
</interaction>
<referencePolicy value="resolves"/>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<type value="ValueSet"/>
<operation>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="expand"/>
<definition
value="http://hl7.org/fhir/OperationDefinition/ValueSet-expand"/>
<documentation
value="A client can determine the note and report types support by a server by invoking the standard FHIR Value Set Expansion ($expand) operation defined in the FHIR R4 specification. Because servers may support different read and write formats, it also is used to determine the formats (for example, text, pdf) the server supports read and write transactions."/>
</operation>
</resource>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="transaction"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="batch"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="search-system"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-system"/>
</interaction>
</rest>
</CapabilityStatement>
IG © 2020+ HL7 International - US Realm Steering Committee. Package hl7.fhir.us.core#3.2.0 based on FHIR 4.0.1. Generated 2020-12-16
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change