This page is part of the US Core (v5.0.0: STU5) 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
Active as of 2022-05-04 |
{
"resourceType" : "CapabilityStatement",
"id" : "us-core-client",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"> <h3 id=\"should_igs\" class=\"no_toc\">SHOULD Support the Following Implementation Guides:</h3> <ul> <li><a href=\"http://hl7.org/fhir/smart-app-launch/index.html\">SMART Application Launch Framework Implementation Guide</a></li> </ul> <ul> <li><a href=\"http://hl7.org/fhir/uv/bulkdata/index.html\">Bulk Data Access IG</a></li> </ul> <h3 id=\"shall_css\" class=\"no_toc\">SHALL Implement All Or Parts Of The Following Capability Statements:</h3> <ul> <li><a href=\"CapabilityStatement-us-core-client.html\">US Core Client CapabilityStatement</a></li> </ul> <h3 id=\"behavior\">FHIR RESTful Capabilities</h3> <p>The US Core Client <strong>SHALL</strong>:</p> <ol> <li>Support fetching and querying of one or more US Core profile(s), using the supported RESTful interactions and search parameters declared in the US Core Server CapabilityStatement.</li> <li>Follow the requirements documented in the <a href=\"general-requirements.html\">General Requirements</a> and <a href=\"must-support.html\">Must Support</a> pages</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> </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> <h4>Summary</h4> <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+status+date, patient+category, patient+category+date, patient+category+status </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, role patient+role, patient+status </td> <td> CareTeam:participant:PractitionerRole, CareTeam:participant:Practitioner, CareTeam:participant:Patient, CareTeam:participant:RelatedPerson </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#condition\">Condition</a> </td> <td> <a href=\"StructureDefinition-us-core-condition-encounter-diagnosis.html\">US Core Condition Encounter Diagnosis Profile</a>, <a href=\"StructureDefinition-us-core-condition-problems-health-concerns.html\">US Core Condition Problems and Health Concerns Profile</a> </td> <td> category, clinical-status, patient, onset-date, asserted-date, recorded-date, abatement-date, code, encounter patient+abatement-date, patient+asserted-date, patient+code, patient+category+encounter, patient+category, patient+recorded-date, patient+onset-date, patient+clinical-status </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-note.html\">US Core DiagnosticReport Profile for Report and Note exchange</a>, <a href=\"StructureDefinition-us-core-diagnosticreport-lab.html\">US Core DiagnosticReport Profile for Laboratory Results Reporting</a> </td> <td> status, patient, category, code, date patient+category+date, patient+status, patient+code, 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+status, patient+category, patient+type+period, patient+type </td> <td> - </td> <td> Provenance:target </td> <td> docref </td> </tr> <tr> <td> <a href=\"#encounter\">Encounter</a> </td> <td> - </td> <td> _id, class, date, identifier, patient, location, status, type, discharge-disposition patient+discharge-disposition, class+patient, patient+location, date+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, description patient+target-date, patient+lifecycle-status, patient+description </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+status, patient+date </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+status, patient+intent+authoredon, patient+intent+encounter, patient+intent </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-observation-sdoh-assessment.html\">US Core Observation SDOH Assessment Profile</a>, <a href=\"StructureDefinition-us-core-respiratory-rate.html\">US Core Respiratory Rate Profile</a>, <a href=\"StructureDefinition-us-core-observation-social-history.html\">US Core Observation Social History Profile</a>, <a href=\"StructureDefinition-us-core-heart-rate.html\">US Core Heart Rate Profile</a>, <a href=\"StructureDefinition-us-core-body-temperature.html\">US Core Body Temperature 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-smokingstatus.html\">US Core Smoking Status Observation Profile</a>, <a href=\"StructureDefinition-us-core-observation-sexual-orientation.html\">US Core Observation Sexual Orientation 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-bmi.html\">US Core BMI Profile</a>, <a href=\"StructureDefinition-us-core-observation-survey.html\">US Core Observation Survey Profile</a>, <a href=\"StructureDefinition-us-core-blood-pressure.html\">US Core Blood Pressure Profile</a>, <a href=\"StructureDefinition-us-core-observation-imaging.html\">US Core Observation Imaging Result Profile</a>, <a href=\"StructureDefinition-us-core-observation-clinical-test.html\">US Core Observation Clinical Test Result 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-us-core-body-weight.html\">US Core Body Weight Profile</a>, <a href=\"StructureDefinition-us-core-vital-signs.html\">US Core Vital Signs Profile</a> </td> <td> status, category, code, date, patient patient+category+date, patient+code, patient+code+date, patient+category, patient+category+status </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 birthdate+family, birthdate+name, family+gender, gender+name </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> _id, 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+code+date, patient+status, 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=\"#questionnaireresponse\">QuestionnaireResponse</a> </td> <td> <a href=\"StructureDefinition-us-core-questionnaireresponse.html\">US Core QuestionnaireResponse Profile</a> </td> <td> _id, patient, status, _tag, authored, questionnaire patient+authored, patient+_tag+authored, patient+status, patient+_tag, patient+questionnaire </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#relatedperson\">RelatedPerson</a> </td> <td> <a href=\"StructureDefinition-us-core-relatedperson.html\">US Core RelatedPerson Profile</a> </td> <td> _id, patient </td> <td> - </td> <td> Provenance:target </td> <td> - </td> </tr> <tr> <td> <a href=\"#servicerequest\">ServiceRequest</a> </td> <td> <a href=\"StructureDefinition-us-core-servicerequest.html\">US Core ServiceRequest Profile</a> </td> <td> status, patient, category, code, authored, _id patient+category+authored, patient+status, patient+code, patient+code+authored, patient+category </td> <td> - </td> <td> Provenance:target </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>SHOULD</strong></p> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-allergyintolerance.html\">US Core AllergyIntolerance Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a AllergyIntolerance resource using: <code class=\"highlighter-rouge\">GET [base]/AllergyIntolerance/[id]</code> </li> <li> A Client <strong>SHOULD</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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-allergyintolerance-patient.html\"> patient</a> </td> <td> reference </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> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-allergyintolerance-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-allergyintolerance-clinical-status.html\"> clinical-status</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-allergyintolerance-clinical-status.html\"> clinical-status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-allergyintolerance-patient.html\"> patient</a> (reference):<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> </li> </ul> </div> <hr/> <h4 id=\"careplan\" class=\"no_toc\">CarePlan</h4> <p>Conformance Expectation: <strong>SHOULD</strong></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>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-careplan.html\">US Core CarePlan Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a CarePlan resource using: <code class=\"highlighter-rouge\">GET [base]/CarePlan/[id]</code> </li> <li> A Client <strong>SHOULD</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 Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-careplan-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-careplan-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-careplan-status.html\"> status</a>+ <a href=\"SearchParameter-us-core-careplan-date.html\"> date</a> </td> <td>reference+token+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-careplan-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-careplan-category.html\"> category</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-careplan-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-careplan-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-careplan-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-careplan-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-careplan-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-careplan-status.html\"> status</a> </td> <td>reference+token+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-careplan-category.html\"> category</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-careplan-date.html\"> date</a> (date):<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> </li><li><a href=\"SearchParameter-us-core-careplan-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-careplan-status.html\"> status</a> (token):<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> </li> </ul> </div> <hr/> <h4 id=\"careteam\" class=\"no_toc\">CareTeam</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>In order to access care team member's names, identifiers, locations, and contact information, the CareTeam profile supports several types of care team participants. They are represented as references to other profiles and include the following four profiles which are marked as must support:</p> <ol> <li>US Core Practitioner Profile</li> <li>US Core PractitionerRole Profile</li> <li>US Core Patient Profile</li> <li>US Core RelatedPerson Profile</li> </ol> <ul> <li>Although <em>both</em> US Core Practitioner Profile and US Core PractitionerRole are must support, the server system is not required to support both types of references (and <code>_include</code> search parameters), but <strong>SHALL</strong> support <em>at least</em> one of them.</li> <li>The client application <strong>SHALL</strong> support all four profile references.</li> <li>Bacause the <em>US Core PractitionerRole Profile</em> supplies the provider's location and contact information and a reference to the Practitioner, server systems <strong>SHOULD</strong> reference it instead of the <em>US Core Practitioner Profile</em>.</li> <li>Servers that supports only <em>US Core Practitioner Profile</em> <strong>SHALL</strong> provide implementation specific guidance how to access a provider's location and contact information using only the Practitioner resource.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-careteam.html\">US Core CareTeam Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a CareTeam resource using: <code class=\"highlighter-rouge\">GET [base]/CareTeam/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _includes: <ul> <li> CareTeam:participant:PractitionerRole: <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:PractitionerRole</code> </li> <li> CareTeam:participant:Practitioner: <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:Practitioner</code> </li> <li> CareTeam:participant:Patient: <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:Patient</code> </li> <li> CareTeam:participant:RelatedPerson: <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:RelatedPerson</code> </li> </ul> </li> <li> A Client <strong>SHOULD</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> </tr> </thead> <tbody><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-careteam-role.html\"> role</a> </td> <td> token </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> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-careteam-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-careteam-role.html\"> role</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-careteam-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-careteam-status.html\"> status</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-careteam-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-careteam-status.html\"> status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-careteam-role.html\"> role</a> (token):<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> </li> </ul> </div> <hr/> <h4 id=\"condition\" class=\"no_toc\">Condition</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>For Encounter Diagnosis use the <em>US Core Condition Encounter Diagnosis Profile</em>. <ul> <li>When <code>Condition.category</code> is "encounter-diagnosis" the encounter, <strong>SHOULD</strong> be referenced in <code>Condition.encounter</code>.</li> </ul> </li> <li>For Problems and Health Concerns use the <em>US Core Condition Problems and Health Concerns Profile</em>. <ul> <li>When <code>Condition.category</code> is a "problems-list-item", the `Condition.clinicalStatus <strong>SHOULD NOT</strong> be unknown.</li> </ul> </li> <li>There is no single element in Condition that represents the date of diagnosis. It may be the assertedDate Extension, <code>Condition.onsetDate</code>, or <code>Condition.recordedDate</code>. <ul> <li>Although all three are marked as must support, the server is not required to support all.</li> <li>A server <strong>SHALL</strong> support <code>Condition.recordedDate</code>.</li> <li>A server <strong>SHALL</strong> support at least one of [assertedDate Extension] and <code>Condition.onsetDate</code>. A server may support both, which means they support all 3 locations.</li> <li>The client application <strong>SHALL</strong> support all three elements.</li> </ul> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-condition-encounter-diagnosis.html\">US Core Condition Encounter Diagnosis Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-condition-problems-health-concerns.html\">US Core Condition Problems and Health Concerns Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a Condition resource using: <code class=\"highlighter-rouge\">GET [base]/Condition/[id]</code> </li> <li> A Client <strong>SHOULD</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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a> </td> <td> reference </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> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-abatement-date.html\"> abatement-date</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-asserted-date.html\"> asserted-date</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-code.html\"> code</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-condition-encounter.html\"> encounter</a> </td> <td>reference+token+reference </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-category.html\"> category</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-recorded-date.html\"> recorded-date</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-onset-date.html\"> onset-date</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-condition-clinical-status.html\"> clinical-status</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-condition-category.html\"> category</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-condition-clinical-status.html\"> clinical-status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-condition-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-condition-onset-date.html\"> onset-date</a> (date):<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> </li><li><a href=\"SearchParameter-us-core-condition-asserted-date.html\"> asserted-date</a> (date):<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> </li><li><a href=\"SearchParameter-us-core-condition-recorded-date.html\"> recorded-date</a> (date):<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> </li><li><a href=\"SearchParameter-us-core-condition-abatement-date.html\"> abatement-date</a> (date):<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> </li><li><a href=\"SearchParameter-us-core-condition-code.html\"> code</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-condition-encounter.html\"> encounter</a> (reference):<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> </li> </ul> </div> <hr/> <h4 id=\"device\" class=\"no_toc\">Device</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li> <p>Implantable medical devices that have UDI information <strong>SHALL</strong> represent the UDI code in <code>Device.udiCarrier.carrierHRF</code>.</p> <ul> <li>All of the five UDI-PI elements that are present in the UDI code <strong>SHALL</strong> be represented in the corresponding US Core Implantable Device Profile element.</li> </ul> <p>UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants. If UDI is not present and the manufacturer and/or model number information is available, they <strong>SHOULD</strong> be included to support historical reports of implantable medical devices as follows:</p> <p>manufacturer -> <code>Device.manufacturer</code><br/> model -> <code>Device.model</code></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> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-implantable-device.html\">US Core Implantable Device Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a Device resource using: <code class=\"highlighter-rouge\">GET [base]/Device/[id]</code> </li> <li> A Client <strong>SHOULD</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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-device-patient.html\"> patient</a> </td> <td> reference </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> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-device-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-device-type.html\"> type</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-device-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-device-type.html\"> type</a> (token):<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> </li> </ul> </div> <hr/> <h4 id=\"diagnosticreport\" class=\"no_toc\">DiagnosticReport</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-diagnosticreport-note.html\">US Core DiagnosticReport Profile for Report and Note exchange</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-diagnosticreport-lab.html\">US Core DiagnosticReport Profile for Laboratory Results Reporting</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a DiagnosticReport resource using: <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport/[id]</code> </li> <li> A Client <strong>SHOULD</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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a> </td> <td> reference </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> </tr> </thead> <tbody> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-code.html\"> code</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-code.html\"> code</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-diagnosticreport-category.html\"> category</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-diagnosticreport-status.html\"> status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-diagnosticreport-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-diagnosticreport-category.html\"> category</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-diagnosticreport-code.html\"> code</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-diagnosticreport-date.html\"> date</a> (date):<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> </li> </ul> </div> <hr/> <h4 id=\"documentreference\" class=\"no_toc\">DocumentReference</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>The <code>DocumentReference.type</code> binding <strong>SHALL</strong> 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</li> <li>The DocumentReference resources can represent the referenced content using either an address where the document can be retrieved using <code>DocumentReference.attachment.url</code> or the content as inline base64 encoded data using <code>DocumentReference.attachment.data</code>. <ul> <li>Although both are marked as must support, the server system is not required to support both an address and inline base64 encoded data, but <strong>SHALL</strong> support at least one of these elements.</li> <li>The client application <strong>SHALL</strong> support both elements.</li> <li>The <code>content.url</code> may refer to a FHIR Binary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or other endpoint. <ul> <li>If the endpoint is outside of the FHIR base URL, it <strong>SHOULD NOT</strong> require additional authorization to access.</li> </ul> </li> </ul> </li> <li>The organization responsible for the DocumentReference <strong>SHALL</strong> be present either in <code>DocumentReference.custodian</code> or accessible in the Provenance resource targeting the DocumentReference using <code>Provenance.agent.who</code> or <code>Provenance.agent.onBehalfOf</code>.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profile</a> </li> </ul> <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>SHOULD</strong> support the <a href=\"OperationDefinition-docref.html\">$docref</a> operation <p>A client <strong>SHOULD</strong> be capable of transacting a $docref operation and capable of receiving at least a reference to a generated CCD document, and <strong>MAY</strong> be able to receive other document types, if available. <strong>SHOULD</strong> be capable of receiving documents as included resources in response to the operation.</p> <p><code>GET [base]/DocumentReference/$docref?patient=[id]</code></p> </li> </ul> <p>Fetch and Search Criteria:</p> <ul> <li> A Client <strong>SHALL</strong> be capable of fetching a DocumentReference resource using: <code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]</code> </li> <li> A Client <strong>SHOULD</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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a> </td> <td> reference </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> </tr> </thead> <tbody> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-documentreference-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-documentreference-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-documentreference-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-documentreference-category.html\"> category</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-documentreference-type.html\"> type</a>+ <a href=\"SearchParameter-us-core-documentreference-period.html\"> period</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-documentreference-type.html\"> type</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-documentreference-status.html\"> status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-documentreference-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-documentreference-category.html\"> category</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-documentreference-type.html\"> type</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-documentreference-date.html\"> date</a> (date):<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> </li><li><a href=\"SearchParameter-us-core-documentreference-period.html\"> period</a> (date):<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> </li> </ul> </div> <hr/> <h4 id=\"encounter\" class=\"no_toc\">Encounter</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li> <p>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.</p> <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> <p>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>.</p> <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.location.location</code> it <strong>SHOULD</strong> conform to US Core Location.</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 Client <strong>SHALL</strong> be capable of fetching a Encounter resource using: <code class=\"highlighter-rouge\">GET [base]/Encounter/[id]</code> </li> <li> A Client <strong>SHOULD</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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-identifier.html\"> identifier</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a> </td> <td> reference </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> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-encounter-discharge-disposition.html\"> discharge-disposition</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-class.html\"> class</a>+ <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a> </td> <td>token+reference </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-encounter-location.html\"> location</a> </td> <td>reference+reference </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-date.html\"> date</a>+ <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a> </td> <td>date+reference </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-encounter-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-encounter-type.html\"> type</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-encounter-class.html\"> class</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-encounter-date.html\"> date</a> (date):<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> </li><li><a href=\"SearchParameter-us-core-encounter-identifier.html\"> identifier</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-encounter-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-encounter-location.html\"> location</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-encounter-status.html\"> status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-encounter-type.html\"> type</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-encounter-discharge-disposition.html\"> discharge-disposition</a> (token):<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> </li> </ul> </div> <hr/> <h4 id=\"goal\" class=\"no_toc\">Goal</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-goal.html\">US Core Goal Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a Goal resource using: <code class=\"highlighter-rouge\">GET [base]/Goal/[id]</code> </li> <li> A Client <strong>SHOULD</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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-goal-patient.html\"> patient</a> </td> <td> reference </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> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-goal-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-goal-target-date.html\"> target-date</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-goal-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-goal-lifecycle-status.html\"> lifecycle-status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-goal-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-goal-description.html\"> description</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-goal-lifecycle-status.html\"> lifecycle-status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-goal-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-goal-target-date.html\"> target-date</a> (date):<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> </li> </ul> </div> <hr/> <h4 id=\"immunization\" class=\"no_toc\">Immunization</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Based upon the ONC U.S. Core Data for Interoperability (USCDI) requirements, CVX vaccine codes are required and the NDC vaccine codes <strong>SHOULD</strong> be supported as translations to them.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-immunization.html\">US Core Immunization Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a Immunization resource using: <code class=\"highlighter-rouge\">GET [base]/Immunization/[id]</code> </li> <li> A Client <strong>SHOULD</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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-immunization-patient.html\"> patient</a> </td> <td> reference </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> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-immunization-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-immunization-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-immunization-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-immunization-date.html\"> date</a> </td> <td>reference+date </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-immunization-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-immunization-status.html\"> status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-immunization-date.html\"> date</a> (date):<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> </li> </ul> </div> <hr/> <h4 id=\"location\" class=\"no_toc\">Location</h4> <p>Conformance Expectation: <strong>SHOULD</strong></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>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-location.html\">US Core Location Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a Location resource using: <code class=\"highlighter-rouge\">GET [base]/Location/[id]</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</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> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-location-address.html\"> address</a> </td> <td> string </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> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-location-address-state.html\"> address-state</a> </td> <td> string </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> </tr> </tbody> </table> <hr/> <h4 id=\"medication\" class=\"no_toc\">Medication</h4> <p>Conformance Expectation: <strong>SHOULD</strong></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>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-medication.html\">US Core Medication Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a Medication resource using: <code class=\"highlighter-rouge\">GET [base]/Medication/[id]</code> </li> </ul> <hr/> <h4 id=\"medicationrequest\" class=\"no_toc\">MedicationRequest</h4> <p>Conformance Expectation: <strong>SHOULD</strong></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>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-medicationrequest.html\">US Core MedicationRequest Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a MedicationRequest resource using: <code class=\"highlighter-rouge\">GET [base]/MedicationRequest/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _includes: <ul> <li> MedicationRequest:medication: <code class=\"highlighter-rouge\">GET [base]/MedicationRequest?[parameter=value]&_include=MedicationRequest:medication</code> </li> </ul> </li> <li> A Client <strong>SHOULD</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 Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-medicationrequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-medicationrequest-intent.html\"> intent</a>+ <a href=\"SearchParameter-us-core-medicationrequest-status.html\"> status</a> </td> <td>reference+token+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-medicationrequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-medicationrequest-intent.html\"> intent</a>+ <a href=\"SearchParameter-us-core-medicationrequest-authoredon.html\"> authoredon</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-medicationrequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-medicationrequest-intent.html\"> intent</a>+ <a href=\"SearchParameter-us-core-medicationrequest-encounter.html\"> encounter</a> </td> <td>reference+token+reference </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-medicationrequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-medicationrequest-intent.html\"> intent</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-medicationrequest-status.html\"> status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-medicationrequest-intent.html\"> intent</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-medicationrequest-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-medicationrequest-encounter.html\"> encounter</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-medicationrequest-authoredon.html\"> authoredon</a> (date):<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> </li> </ul> </div> <hr/> <h4 id=\"observation\" class=\"no_toc\">Observation</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Systems <strong>SHOULD</strong> support <code>Observation.effectivePeriod</code> to accurately represent 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 <ul> <li>Systems that never provide an observation without a value are not required to support <code>Observation.dataAbsentReason</code></li> </ul> </li> <li>An <code>Observation.component</code> without a value, <strong>SHALL</strong> include a reason why the data is absent. <ul> <li>Systems that never provide an component observation without a component value are not required to support <code>Observation.component.dataAbsentReason</code>.</li> </ul> </li> <li>Systems <strong>SHOULD</strong> support <code>Observation.effectivePeriod</code> to accurately represent procedure tests that are collected over a period of time.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-lab.html\">US Core Laboratory Result Observation Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-sdoh-assessment.html\">US Core Observation SDOH Assessment Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-respiratory-rate.html\">US Core Respiratory Rate Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-social-history.html\">US Core Observation Social History Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-heart-rate.html\">US Core Heart Rate Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-body-temperature.html\">US Core Body Temperature Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-pediatric-weight-for-height.html\">US Core Pediatric Weight for Height Observation Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-pulse-oximetry.html\">US Core Pulse Oximetry Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-smokingstatus.html\">US Core Smoking Status Observation Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-sexual-orientation.html\">US Core Observation Sexual Orientation Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-head-circumference.html\">US Core Head Circumference Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-body-height.html\">US Core Body Height Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-bmi.html\">US Core BMI Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-survey.html\">US Core Observation Survey Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-blood-pressure.html\">US Core Blood Pressure Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-imaging.html\">US Core Observation Imaging Result Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-observation-clinical-test.html\">US Core Observation Clinical Test Result Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-pediatric-bmi-for-age.html\">US Core Pediatric BMI for Age Observation Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-head-occipital-frontal-circumference-percentile.html\">US Core Pediatric Head Occipital-frontal Circumference Percentile Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-body-weight.html\">US Core Body Weight Profile</a>, </li> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-vital-signs.html\">US Core Vital Signs Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a Observation resource using: <code class=\"highlighter-rouge\">GET [base]/Observation/[id]</code> </li> <li> A Client <strong>SHOULD</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 Combination Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter Combination</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-observation-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-observation-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-observation-code.html\"> code</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-observation-code.html\"> code</a>+ <a href=\"SearchParameter-us-core-observation-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-observation-category.html\"> category</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-observation-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-observation-status.html\"> status</a> </td> <td>reference+token+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-observation-status.html\"> status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-observation-category.html\"> category</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-observation-code.html\"> code</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-observation-date.html\"> date</a> (date):<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> </li><li><a href=\"SearchParameter-us-core-observation-patient.html\"> patient</a> (reference):<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> </li> </ul> </div> <hr/> <h4 id=\"organization\" class=\"no_toc\">Organization</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Systems <strong>SHALL</strong> support National Provider Identifier (NPI) for organizations and <strong>SHOULD</strong> support Clinical Laboratory Improvement Amendments (CLIA) identifiers for <code>Organization.Identifier</code>.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-organization.html\">US Core Organization Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a Organization resource using: <code class=\"highlighter-rouge\">GET [base]/Organization/[id]</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</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> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-organization-address.html\"> address</a> </td> <td> string </td> </tr> </tbody> </table> <hr/> <h4 id=\"patient\" class=\"no_toc\">Patient</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li> <p>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.</p> <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> </li> <li> <p>The Patient's Social Security Numbers <strong>SHOULD NOT</strong> be used as a patient identifier in <code>Patient.identifier.value</code>.</p> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-patient.html\">US Core Patient Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a Patient resource using: <code class=\"highlighter-rouge\">GET [base]/Patient/[id]</code> </li> <li> A Client <strong>SHOULD</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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-identifier.html\"> identifier</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-name.html\"> name</a> </td> <td> string </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> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-birthdate.html\"> birthdate</a>+ <a href=\"SearchParameter-us-core-patient-family.html\"> family</a> </td> <td>date+string </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-birthdate.html\"> birthdate</a>+ <a href=\"SearchParameter-us-core-patient-name.html\"> name</a> </td> <td>date+string </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-family.html\"> family</a>+ <a href=\"SearchParameter-us-core-patient-gender.html\"> gender</a> </td> <td>string+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-patient-gender.html\"> gender</a>+ <a href=\"SearchParameter-us-core-patient-name.html\"> name</a> </td> <td>token+string </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-patient-birthdate.html\"> birthdate</a> (date):<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> </li><li><a href=\"SearchParameter-us-core-patient-family.html\"> family</a> (string):<p>A server <strong>SHALL</strong> support a value precise to the <em>day</em>.</p> </li><li><a href=\"SearchParameter-us-core-patient-gender.html\"> gender</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-patient-identifier.html\"> identifier</a> (token):<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> </li> </ul> </div> <hr/> <h4 id=\"practitioner\" class=\"no_toc\">Practitioner</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-practitioner.html\">US Core Practitioner Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a Practitioner resource using: <code class=\"highlighter-rouge\">GET [base]/Practitioner/[id]</code> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> </tr> </thead> <tbody><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-practitioner-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-practitioner-name.html\"> name</a> </td> <td> string </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-practitioner-identifier.html\"> identifier</a> </td> <td> token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-practitioner-identifier.html\"> identifier</a> (token):<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> </li> </ul> </div> <hr/> <h4 id=\"practitionerrole\" class=\"no_toc\">PractitionerRole</h4> <p>Conformance Expectation: <strong>SHOULD</strong></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>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-practitionerrole.html\">US Core PractitionerRole Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a PractitionerRole resource using: <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _includes: <ul> <li> PractitionerRole:endpoint: <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:endpoint</code> </li> <li> PractitionerRole:practitioner: <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner</code> </li> </ul> </li> </ul> <p>Search Parameter Summary:</p> <table class=\"grid\"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</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> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-practitionerrole-practitioner.html\"> practitioner</a> </td> <td> reference </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-practitionerrole-specialty.html\"> specialty</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-practitionerrole-practitioner.html\"> practitioner</a> (reference):<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> </li> </ul> </div> <hr/> <h4 id=\"procedure\" class=\"no_toc\">Procedure</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li>Procedure codes can be taken from SNOMED-CT, CPT, HCPCS II, ICD-10-PCS, CDT. LOINC. <ul> <li>Only LOINC concepts that reflect actual procedures <strong>SHOULD</strong> be used</li> </ul> </li> <li>A procedure including an implantable device <strong>SHOULD</strong> use <code>Procedure.focalDevice</code> with a reference to the <em>US Core Implantable Device Profile</em>.</li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-procedure.html\">US Core Procedure Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a Procedure resource using: <code class=\"highlighter-rouge\">GET [base]/Procedure/[id]</code> </li> <li> A Client <strong>SHOULD</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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-procedure-patient.html\"> patient</a> </td> <td> reference </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> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-procedure-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-procedure-code.html\"> code</a>+ <a href=\"SearchParameter-us-core-procedure-date.html\"> date</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-procedure-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-procedure-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-procedure-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-procedure-date.html\"> date</a> </td> <td>reference+date </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-procedure-status.html\"> status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-procedure-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-procedure-date.html\"> date</a> (date):<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> </li><li><a href=\"SearchParameter-us-core-procedure-code.html\"> code</a> (token):<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> </li> </ul> </div> <hr/> <h4 id=\"provenance\" class=\"no_toc\">Provenance</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><ul> <li> <p>The US Core Provenance resource <strong>SHALL</strong> be supported for these US Core resources:</p> <ul> <li>US Core CarePlan Profile</li> <li>US Core DiagnosticReport Profile for Laboratory Results Reporting</li> <li>US Core Encounter Profile</li> <li>US Core Observation Sexual Orientation Profile</li> <li>US Core Head Circumference Profile</li> <li>US Core ServiceRequest Profile</li> <li>US Core Vital Signs Profile</li> <li>US Core DiagnosticReport Profile for Report and Note Exchange</li> <li>US Core Implantable Device Profile</li> <li>US Core Observation Imaging Result Profile</li> <li>US Core CareTeam Profile</li> <li>US Core Pulse Oximetry Profile</li> <li>US Core BMI Profile</li> <li>US Core Blood Pressure Profile</li> <li>US Core Body Weight Profile</li> <li>US Core RelatedPerson Profile</li> <li>US Core Pediatric BMI for Age Observation Profile</li> <li>US Core MedicationRequest Profile</li> <li>US Core Condition Encounter Diagnosis Profile</li> <li>US Core Pediatric Head Occipital-frontal Circumference Percentile Profile</li> <li>US Core Procedure Profile</li> <li>US Core Laboratory Result Observation Profile</li> <li>US Core Body Height Profile</li> <li>US Core Observation SDOH Assessment Profile</li> <li>US Core Observation Survey Profile</li> <li>US Core Body Temperature Profile</li> <li>US Core Condition Problems and Health Concerns Profile</li> <li>US Core Pediatric Weight for Height Observation Profile</li> <li>US Core Goal Profile</li> <li>US Core AllergyIntolerance Profile</li> <li>US Core Immunization Profile</li> <li>US Core Observation Social History Profile</li> <li>US Core Heart Rate Profile</li> <li>US Core Smoking Status Observation Profile</li> <li>US Core Patient Profile</li> <li>US Core QuestionnaireResponse Profile</li> <li>US Core Respiratory Rate Profile</li> <li>US Core Observation Clinical Test Result Profile</li> <li>US Core DocumentReference Profile</li> </ul> </li> <li> <p>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.</p> </li> <li> <p>Systems that need to know the activity has occurred <strong>SHOULD</strong> populate the activity.</p> </li> </ul> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-provenance.html\">US Core Provenance Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a Provenance resource using: <code class=\"highlighter-rouge\">GET [base]/Provenance/[id]</code> </li> </ul> <hr/> <h4 id=\"questionnaireresponse\" class=\"no_toc\">QuestionnaireResponse</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Resource Specific Documentation:</p> <blockquote><p>US Core provides two ways to represent SDOH assessment screening results using:</p> <ol> <li>Observation: [US Core Observation SDOH Assessment Profile]</li> <li>QuestionnaireResponse: [US Core QuestionnaireResponse Profile]</li> </ol> <p>US Core Servers <strong>SHALL</strong> support [US Core Observation SDOH Assessment Profile] for SDOH Assessments and <strong>MAY</strong> support the [US Core QuestionnaireResponse Profile] for SDOH Assessments.</p> </blockquote> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-questionnaireresponse.html\">US Core QuestionnaireResponse Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a QuestionnaireResponse resource using: <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse?[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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-questionnaireresponse-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\"> patient</a> </td> <td> reference </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> </tr> </thead> <tbody> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-questionnaireresponse-authored.html\"> authored</a> </td> <td>reference+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-questionnaireresponse-tag.html\"> _tag</a>+ <a href=\"SearchParameter-us-core-questionnaireresponse-authored.html\"> authored</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-questionnaireresponse-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-questionnaireresponse-tag.html\"> _tag</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-questionnaireresponse-questionnaire.html\"> questionnaire</a> </td> <td>reference+reference </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-questionnaireresponse-status.html\"> status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-questionnaireresponse-tag.html\"> _tag</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-questionnaireresponse-authored.html\"> authored</a> (date):<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> </li><li><a href=\"SearchParameter-us-core-questionnaireresponse-questionnaire.html\"> questionnaire</a> (reference):<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> </li> </ul> </div> <hr/> <h4 id=\"relatedperson\" class=\"no_toc\">RelatedPerson</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-relatedperson.html\">US Core RelatedPerson Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a RelatedPerson resource using: <code class=\"highlighter-rouge\">GET [base]/RelatedPerson/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/RelatedPerson?[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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-relatedperson-id.html\"> _id</a> </td> <td> token </td> </tr><tr> <td> <strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-relatedperson-patient.html\"> patient</a> </td> <td> reference </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-relatedperson-patient.html\"> patient</a> (reference):<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> </li> </ul> </div> <hr/> <h4 id=\"servicerequest\" class=\"no_toc\">ServiceRequest</h4> <p>Conformance Expectation: <strong>SHOULD</strong></p> <p>Supported Profiles:</p> <ul> <li><strong>SHALL</strong> support: <a href=\"StructureDefinition-us-core-servicerequest.html\">US Core ServiceRequest Profile</a> </li> </ul> <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 Client <strong>SHALL</strong> be capable of fetching a ServiceRequest resource using: <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]</code> </li> <li> A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes: Provenance:target - <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?[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> </tr> </thead> <tbody><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a> </td> <td> reference </td> </tr><tr> <td> <strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-id.html\"> _id</a> </td> <td> token </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> </tr> </thead> <tbody> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-servicerequest-category.html\"> category</a>+ <a href=\"SearchParameter-us-core-servicerequest-authored.html\"> authored</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-servicerequest-status.html\"> status</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-servicerequest-code.html\"> code</a> </td> <td>reference+token </td> </tr> <tr> <td><strong>SHOULD</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-servicerequest-code.html\"> code</a>+ <a href=\"SearchParameter-us-core-servicerequest-authored.html\"> authored</a> </td> <td>reference+token+date </td> </tr> <tr> <td><strong>SHALL</strong> </td> <td> <a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a>+ <a href=\"SearchParameter-us-core-servicerequest-category.html\"> category</a> </td> <td>reference+token </td> </tr> </tbody> </table> <div> <p>Search Parameter Requirements (When Used Alone or in Combination):</p> <ul><li><a href=\"SearchParameter-us-core-servicerequest-status.html\"> status</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-servicerequest-patient.html\"> patient</a> (reference):<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> </li><li><a href=\"SearchParameter-us-core-servicerequest-category.html\"> category</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-servicerequest-code.html\"> code</a> (token):<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> </li><li><a href=\"SearchParameter-us-core-servicerequest-authored.html\"> authored</a> (date):<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> </li> </ul> </div> <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>"
},
"url" : "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client",
"version" : "5.0.0",
"name" : "UsCoreClientCapabilityStatement",
"title" : "US Core Client CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2022-05-04T20:36:17.985710-08:00",
"publisher" : "HL7 International - Cross-Group Projects",
"contact" : [
{
"name" : "HL7 International - Cross-Group Projects",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/cgp"
},
{
"system" : "email",
"value" : "cgp@lists.HL7.org"
}
]
}
],
"description" : "This Section describes the expected capabilities of the US Core Client which is responsible for creating and initiating the queries for information about an individual patient. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined in the [Conformance Requirements for Server](CapabilityStatement-us-core-server.html). 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" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"copyright" : "Used by permission of HL7 International, all rights reserved Creative Commons License",
"kind" : "requirements",
"instantiates" : [
"http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client"
],
"_instantiates" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"_format" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"patchFormat" : [
"application/json-patch+json"
],
"_patchFormat" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"implementationGuide" : [
"http://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch",
"http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata"
],
"_implementationGuide" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"rest" : [
{
"mode" : "client",
"documentation" : "The US Core Client **SHALL**:\n\n1. Support fetching and querying of one or more US Core profile(s), using the supported RESTful interactions and search parameters declared in the US Core Server CapabilityStatement.\n1. Follow the requirements documented in the [General Requirements](general-requirements.html) and [Must Support](must-support.html) pages",
"security" : {
"description" : "1. See the [General Security Considerations](security.html) section for requirements and recommendations."
},
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "clinical-status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "AllergyIntolerance",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "clinical-status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "status"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "CarePlan",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* 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:\n - US Core Goal **SHOULD** be present in CarePlan.goal\n - US Core Condition **SHOULD** be present in CarePlan.addresses\n - Assement and Plan **MAY** be included as narrative text",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-category",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careplan-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "role"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "CareTeam",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "In order to access care team member's names, identifiers, locations, and contact information, the CareTeam profile supports several types of care team participants. They are represented as references to other profiles and include the following four profiles which are marked as must support:\n 1. US Core Practitioner Profile\n 1. US Core PractitionerRole Profile\n 1. US Core Patient Profile\n 1. US Core RelatedPerson Profile\n\n * Although *both* US Core Practitioner Profile and US Core PractitionerRole are must support, the server system is not required to support both types of references (and `_include` search parameters), but **SHALL** support *at least* one of them.\n * The client application **SHALL** support all four profile references.\n * Bacause the *US Core PractitionerRole Profile* supplies the provider's location and contact information and a reference to the Practitioner, server systems **SHOULD** reference it instead of the *US Core Practitioner Profile*.\n * Servers that supports only *US Core Practitioner Profile* **SHALL** provide implementation specific guidance how to access a provider's location and contact information using only the Practitioner resource.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchInclude" : [
"CareTeam:participant:PractitionerRole",
"CareTeam:participant:Practitioner",
"CareTeam:participant:Patient",
"CareTeam:participant:RelatedPerson"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "role",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-careteam-role",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "abatement-date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "asserted-date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "encounter"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "recorded-date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "onset-date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "clinical-status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Condition",
"supportedProfile" : [
"http://hl7.org/fhir/us/core//StructureDefinition/us-core-condition-encounter-diagnosis",
"http://hl7.org/fhir/us/core//StructureDefinition/us-core-condition-problems-health-concerns"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* For Encounter Diagnosis use the *US Core Condition Encounter Diagnosis Profile*.\n * When `Condition.category` is \"encounter-diagnosis\" the encounter, **SHOULD** be referenced in `Condition.encounter`.\n* For Problems and Health Concerns use the *US Core Condition Problems and Health Concerns Profile*.\n * When `Condition.category` is a \"problems-list-item\", the `Condition.clinicalStatus **SHOULD NOT** be unknown.\n* There is no single element in Condition that represents the date of diagnosis. It may be the assertedDate Extension, `Condition.onsetDate`, or `Condition.recordedDate`.\n * Although all three are marked as must support, the server is not required to support all.\n\t* A server **SHALL** support `Condition.recordedDate`.\n * A server **SHALL** support at least one of [assertedDate Extension] and `Condition.onsetDate`. A server may support both, which means they support all 3 locations.\n * The client application **SHALL** support all three elements.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "clinical-status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "onset-date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-onset-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "asserted-date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-asserted-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "recorded-date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-recorded-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "abatement-date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-abatement-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-code",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "encounter",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-encounter",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "type"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Device",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Implantable medical devices that have UDI information **SHALL** represent the UDI code in `Device.udiCarrier.carrierHRF`.\n - All of the five UDI-PI elements that are present in the UDI code **SHALL** be represented in the corresponding US Core Implantable Device Profile element.\n \n UDI may not be present in all scenarios such as historical implantable devices, patient reported implant information, payer reported devices, or improperly documented implants. If UDI is not present and the manufacturer and/or model number information is available, they **SHOULD** be included to support historical reports of implantable medical devices as follows:\n\n manufacturer -> `Device.manufacturer` \n model -> `Device.model` \n\n* 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.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-device-type",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "DiagnosticReport",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "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**."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "type"
},
{
"url" : "required",
"valueString" : "period"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "type"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "DocumentReference",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* 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\n* The DocumentReference resources can represent the referenced content using either an address where the document can be retrieved using `DocumentReference.attachment.url` or the content as inline base64 encoded data using `DocumentReference.attachment.data`.\n * Although both are marked as must support, the server system is not required to support both an address and inline base64 encoded data, but **SHALL** support at least one of these elements.\n * The client application **SHALL** support both elements.\n * The `content.url` may refer to a FHIR Binary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or other endpoint.\n * If the endpoint is outside of the FHIR base URL, it **SHOULD NOT** require additional authorization to access.\n* The organization responsible for the DocumentReference **SHALL** be present either in `DocumentReference.custodian` or accessible in the Provenance resource targeting the DocumentReference using `Provenance.agent.who` or `Provenance.agent.onBehalfOf`.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "period",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "docref",
"definition" : "http://hl7.org/fhir/us/core/OperationDefinition/docref",
"documentation" : "A client **SHOULD** be capable of transacting a $docref operation and capable of receiving at least a reference to a generated CCD document, and **MAY** be able to receive other document types, if available. **SHOULD** be capable of receiving documents as included resources in response to the operation.\n\n`GET [base]/DocumentReference/$docref?patient=[id]`"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "discharge-disposition"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "class"
},
{
"url" : "required",
"valueString" : "patient"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "location"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "date"
},
{
"url" : "required",
"valueString" : "patient"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "type"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Encounter",
"documentation" : "* 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.\n * 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.\n * The client application **SHALL** support both elements.\n * 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)\n\n* 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`.\n * 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.\n * The client application **SHALL** support both elements.\n * if using `Encounter.location.location` it **SHOULD** conform to US Core Location.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "class",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-class",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-identifier",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "location",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-location",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-type",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "discharge-disposition",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-discharge-disposition",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "target-date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "lifecycle-status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "description"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Goal",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "lifecycle-status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-lifecycle-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "target-date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-target-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *day*.\n\nA server **SHALL** support a value a value precise to the *day*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "description",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-description",
"type" : "token"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Immunization",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Based upon the ONC U.S. Core Data for Interoperability (USCDI) 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" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Location",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* 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" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-name",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "address",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "address-city",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-city",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "address-state",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-state",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "address-postalcode",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-location-address-postalcode",
"type" : "string"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Medication",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* 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" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "intent"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "intent"
},
{
"url" : "required",
"valueString" : "authoredon"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "intent"
},
{
"url" : "required",
"valueString" : "encounter"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "intent"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "MedicationRequest",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* 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.\n\n For example, A server **SHALL** be capable of returning all medications for a patient using one of or both:\n\n `GET /MedicationRequest?patient=[id]`\n\n `GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication`\n\n* 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.\n * 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.\n * The client application **SHALL** support both elements.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchInclude" : [
"MedicationRequest:medication"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "intent",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "encounter",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-encounter",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "authoredon",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Observation",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-sdoh-assessment",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-social-history",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature",
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-sexual-orientation",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-survey",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-imaging",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-test",
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age",
"http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Systems **SHOULD** support `Observation.effectivePeriod` to accurately represent tests that are collected over a period of time (for example, a 24-Hour Urine Collection test).\n* 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\n * Systems that never provide an observation without a value are not required to support `Observation.dataAbsentReason`\n* An `Observation.component` without a value, **SHALL** include a reason why the data is absent.\n * Systems that never provide an component observation without a component value are not required to support `Observation.component.dataAbsentReason`.\n* Systems **SHOULD** support `Observation.effectivePeriod` to accurately represent procedure tests that are collected over a period of time.\n\n",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Organization",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Systems **SHALL** support National Provider Identifier (NPI) for organizations and **SHOULD** support Clinical Laboratory Improvement Amendments (CLIA) identifiers for `Organization.Identifier`.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-name",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "address",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-organization-address",
"type" : "string"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "birthdate"
},
{
"url" : "required",
"valueString" : "family"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "birthdate"
},
{
"url" : "required",
"valueString" : "name"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "family"
},
{
"url" : "required",
"valueString" : "gender"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "gender"
},
{
"url" : "required",
"valueString" : "name"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Patient",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* 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.\n\n 1. contact detail (e.g. a telephone number or an email address)\n 1. a communication language\n 1. a race\n 1. an ethnicity\n 1. a birth sex*\n 1. previous name\n - Previous name is represented by providing an end date in the `Patient.name.period` element for a previous name.\n 1. suffix\n - Suffix is represented using the `Patient.name.suffix` element.\n* The Patient's Social Security Numbers **SHOULD NOT** be used as a patient identifier in `Patient.identifier.value`.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "birthdate",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *day*.\n\nA server **SHALL** support a value a value precise to the *day*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "family",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family",
"type" : "string",
"documentation" : "A server **SHALL** support a value precise to the *day*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "gender",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "given",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name",
"type" : "string"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Practitioner",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-name",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "PractitionerRole",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* 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" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchInclude" : [
"PractitionerRole:endpoint",
"PractitionerRole:practitioner"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "specialty",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-specialty",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "practitioner",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-practitioner",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Procedure",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* Procedure codes can be taken from SNOMED-CT, CPT, HCPCS II, ICD-10-PCS, CDT. LOINC.\n * Only LOINC concepts that reflect actual procedures **SHOULD** be used\n* 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" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-code",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Provenance",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "* The US Core Provenance resource **SHALL** be supported for these US Core\nresources:\n\n * US Core CarePlan Profile\n * US Core DiagnosticReport Profile for Laboratory Results Reporting\n * US Core Encounter Profile\n * US Core Observation Sexual Orientation Profile\n * US Core Head Circumference Profile\n * US Core ServiceRequest Profile\n * US Core Vital Signs Profile\n * US Core DiagnosticReport Profile for Report and Note Exchange\n * US Core Implantable Device Profile\n * US Core Observation Imaging Result Profile\n * US Core CareTeam Profile\n * US Core Pulse Oximetry Profile\n * US Core BMI Profile\n * US Core Blood Pressure Profile\n * US Core Body Weight Profile\n * US Core RelatedPerson Profile\n * US Core Pediatric BMI for Age Observation Profile\n * US Core MedicationRequest Profile\n * US Core Condition Encounter Diagnosis Profile\n * US Core Pediatric Head Occipital-frontal Circumference Percentile Profile\n * US Core Procedure Profile\n * US Core Laboratory Result Observation Profile\n * US Core Body Height Profile\n * US Core Observation SDOH Assessment Profile\n * US Core Observation Survey Profile\n * US Core Body Temperature Profile\n * US Core Condition Problems and Health Concerns Profile\n * US Core Pediatric Weight for Height Observation Profile\n * US Core Goal Profile\n * US Core AllergyIntolerance Profile\n * US Core Immunization Profile\n * US Core Observation Social History Profile\n * US Core Heart Rate Profile\n * US Core Smoking Status Observation Profile\n * US Core Patient Profile\n * US Core QuestionnaireResponse Profile\n * US Core Respiratory Rate Profile\n * US Core Observation Clinical Test Result Profile\n * US Core DocumentReference Profile\n\n* 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.\n* Systems that need to know the activity has occurred **SHOULD** populate the activity.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "authored"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "_tag"
},
{
"url" : "required",
"valueString" : "authored"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "_tag"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "questionnaire"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "QuestionnaireResponse",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-questionnaireresponse"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "US Core provides two ways to represent SDOH assessment screening results using: \n \n1. Observation: [US Core Observation SDOH Assessment Profile] \n1. QuestionnaireResponse: [US Core QuestionnaireResponse Profile]\n\nUS Core Servers **SHALL** support [US Core Observation SDOH Assessment Profile] for SDOH Assessments and **MAY** support the [US Core QuestionnaireResponse Profile] for SDOH Assessments.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "_tag",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-tag",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "authored",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-authored",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "questionnaire",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-questionnaire",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "RelatedPerson",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-relatedperson-id",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-relatedperson-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "authored"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "required",
"valueString" : "authored"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "ServiceRequest",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"referencePolicy" : [
"resolves"
],
"searchRevInclude" : [
"Provenance:target"
],
"_searchRevInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-status",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-patient",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-category",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-code",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "authored",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-authored",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\nA server **SHALL** support a value precise to the *second + time offset*."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-id",
"type" : "token"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "ValueSet",
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "expand",
"definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-expand",
"documentation" : "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."
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "transaction"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "batch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-system"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-system"
}
]
}
]
}