US Core Implementation Guide TEST
9.0.0 - CI Build
US Core Implementation Guide TEST
9.0.0 - CI Build
US Core Implementation Guide TEST, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 9.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 3 |
{
"resourceType" : "CapabilityStatement",
"id" : "us-core-client",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <!-- TODO\n Jurisdiction\n Prohibited extension - http://hl7.org/fhir/StructureDefinition/capabilitystatement-prohibited -->\n <!-- set include_symbols = false to turn off confonrmance symbols and legend, true to turn on -->\n \n\n <!-- This is already rendered by the ig publisher in the header and footer\n <h2 id=\"title\">US Core Client CapabilityStatement</h2>\n <ul>\n <li><b>Title:</b>US Core Client CapabilityStatement</li>\n <li><b>Implementation Guide Version:</b> 9.0.0</li>\n <li><b>FHIR Version:</b> 4.0.1</li>\n <li><b>Intended Use:</b> Requirements</li>\n <li><b>Supported Formats: </b>\n\n \n \n \n <strong>SHALL</strong> support\n \n json;\n \n \n \n <strong>SHOULD</strong> support\n \n xml;\n \n\n </li>\n \n <li><b>Supported Patch Formats:</b>\n \n \n \n <strong>SHOULD</strong> support\n \n application/json-patch+json;\n \n </li>\n \n <li><b>Published:</b> 2025-12-19 19:16:08-0800</li>\n\n <li><b>Published by:</b> HL7 International / Cross-Group Projects</li>\n <li><b>Status:</b> Active</li>\n <li><b>Copyright:</b> <div><p>Used by permission of HL7 International, all rights reserved Creative Commons License</p>\n</div></li>\n </ul>\n <br/>\n\n\n\n \n <strong>Description:</strong> <div><div><p>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 <a href=\"CapabilityStatement-us-core-server.html\">Conformance Requirements for Server</a>. US Core Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.</p>\n</div></div>\n \n <br/> -->\n\n \n\n\n\n \n <h3>Support and Requirements for Other Artifacts</h3>\n <table>\n <tbody>\n \n \n \n <tr>\n <th>Supports other guides:</th>\n <td>\n <ul>\n \n \n \n \n \n \n </ul>\n </td>\n </tr>\n \n </tbody>\n </table>\n \n\n <!-- <br/>\n TODO - Make this a summary of capabilities, including system wide and each paradigm\n <p>\n <b>Jump to:</b>\n </p>\n <ul>\n \n <li><a href=\"#Client\">REST Client</a></li>\n \n \n \n </ul>\n\n\n\n <!-- REST Capabilities -->\n \n <!-- <br/> -->\n <a name=\"Client\"> </a>\n <h3 id=\"behavior\">FHIR Client RESTful Capabilities</h3>\n \n <div><div><p>The US Core Client <strong>SHALL</strong>:</p>\n<ol>\n<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>\n<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>\n</ol>\n<p><strong>NOTE</strong>: US Core SearchParameters referenced in this CapabilityStatement that are derived from standard FHIR SearchParameters are only defined to document Server and Client expectations. They specify additional expectations for the following SearchParameter elements:</p>\n<ul>\n<li><code>multipleAnd</code></li>\n<li><code>multipleOr</code></li>\n<li><code>comparator</code></li>\n<li><code>modifier</code></li>\n<li><code>chain</code></li>\n</ul>\n<p>They <strong>SHALL NOT</strong> be interpreted as search parameters for search. Servers and Clients <strong>SHOULD</strong> use the standard FHIR SearchParameters.</p>\n</div></div>\n \n\n <!-- REST Security -->\n \n <br/>\n <p id=\"security\"><strong>Security:</strong></p>\n \n <div><div><ol>\n<li>See the <a href=\"security.html\">General Security Considerations</a> section for requirements and recommendations.</li>\n</ol>\n</div></div>\n \n \n \n\n <!-- REST System wide Capabilities -->\n \n <h3>System-wide Client Capabilities</h3>\n\n <!-- REST System wide interactions -->\n \n <h4>Interactions</h4>\n\n <ul>\n \n <li>\n \n <strong>MAY</strong> support the\n \n <code>transaction</code> interaction.</li>\n \n <li>\n \n <strong>MAY</strong> support the\n \n <code>batch</code> interaction.</li>\n \n <li>\n \n <strong>MAY</strong> support the\n \n <code>search-system</code> interaction.</li>\n \n <li>\n \n <strong>MAY</strong> support the\n \n <code>history-system</code> interaction.</li>\n \n </ul>\n \n \n \n \n \n \n \n \n \n \n\n <!-- REST System wide operations -->\n \n\n\n <!-- REST System wide search parameters -->\n \n \n\n\n\n <!-- Resource Capabilities Summary Table -->\n \n\n <h4>Summary of Resource/Profile Capabilities</h4>\n <table style=\"width: 100%;\" class=\"grid\">\n <colgroup>\n <col style=\"width: 15%;\"/> <!-- First column: 20% -->\n <col style=\"width: 25%;\"/> <!-- Second: 20% -->\n <col style=\"width: 15%;\"/> <!-- Third: 15% -->\n <col style=\"width: 20%;\"/> <!-- fourth column: 20% -->\n <col style=\"width: 15%;\"/> <!-- fifth: 15% -->\n <col style=\"width: 10%;\"/> <!-- six: 10% -->\n </colgroup>\n <thead>\n <tr>\n <th>Resource Type</th>\n <!-- <th>Supported Interactions</th> -->\n <th>Supported Profiles</th>\n <th>Supported Searches</th>\n <th>Supported <code>_includes</code></th>\n <th>Supported <code>_revincludes</code></th>\n <th>Supported Operations</th>\n </tr>\n </thead>\n <tbody>\n \n <tr>\n <td>\n <a href=\"#Client_AllergyIntolerance\"><span style=\"white-space: nowrap;\">AllergyIntolerance</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-allergyintolerance.html\">US Core AllergyIntolerance Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n clinical-status, patient\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+clinical-status\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_CarePlan\"><span style=\"white-space: nowrap;\">CarePlan</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-careplan.html\">US Core CarePlan Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n category, date, patient, status\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+category+status, patient+category, patient+category+date, patient+category+status+date\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_CareTeam\"><span style=\"white-space: nowrap;\">CareTeam</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-careteam.html\">US Core CareTeam Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n patient, role, status\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+status, patient+role\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n CareTeam:participant:PractitionerRole\nCareTeam:participant:Practitioner\nCareTeam:participant:Patient\nCareTeam:participant:RelatedPerson\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Condition\"><span style=\"white-space: nowrap;\">Condition</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-condition-encounter-diagnosis.html\">US Core Condition Encounter Diagnosis Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-condition-problems-health-concerns.html\">US Core Condition Problems and Health Concerns Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n abatement-date, asserted-date, category, clinical-status, code, encounter, onset-date, patient, recorded-date, _lastUpdated\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+clinical-status, patient+code, patient+category, patient+abatement-date, patient+recorded-date, patient+_lastUpdated, patient+asserted-date, patient+category+clinical-status, patient+onset-date, patient+category+encounter\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Coverage\"><span style=\"white-space: nowrap;\">Coverage</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-coverage.html\">US Core Coverage Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n patient\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Device\"><span style=\"white-space: nowrap;\">Device</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-device.html\">US Core Device Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n patient, status, type\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+type, patient+status\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_DiagnosticReport\"><span style=\"white-space: nowrap;\">DiagnosticReport</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-diagnosticreport-note.html\">US Core DiagnosticReport Profile for Report and Note exchange</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-diagnosticreport-lab.html\">US Core DiagnosticReport Profile for Laboratory Results Reporting</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n category, code, date, _lastUpdated, patient, status\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+code+date, patient+category+_lastUpdated, patient+category+date, patient+category, patient+status, patient+code\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_DocumentReference\"><span style=\"white-space: nowrap;\">DocumentReference</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-adi-documentreference.html\">US Core ADI DocumentReference Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n _id, category, date, patient, period, status, type\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+type, patient+category+date, patient+category, patient+type+period, patient+status\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n $docref\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Encounter\"><span style=\"white-space: nowrap;\">Encounter</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-encounter.html\">US Core Encounter Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n _id, class, date, _lastUpdated, discharge-disposition, identifier, location, patient, status, type\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+type, class+patient, patient+status, patient+_lastUpdated, patient+location, date+patient, patient+discharge-disposition\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Endpoint\"><span style=\"white-space: nowrap;\">Endpoint</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_FamilyMemberHistory\"><span style=\"white-space: nowrap;\">FamilyMemberHistory</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-familymemberhistory.html\">US Core FamilyMemberHistory Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n patient, code\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+code\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Goal\"><span style=\"white-space: nowrap;\">Goal</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-goal.html\">US Core Goal Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n description, lifecycle-status, patient, target-date\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+description, patient+target-date, patient+lifecycle-status\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_HealthcareService\"><span style=\"white-space: nowrap;\">HealthcareService</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Immunization\"><span style=\"white-space: nowrap;\">Immunization</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-immunization.html\">US Core Immunization Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n date, patient, status\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+date, patient+status\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Location\"><span style=\"white-space: nowrap;\">Location</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-location.html\">US Core Location Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n address, address-city, address-postalcode, address-state, name\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Media\"><span style=\"white-space: nowrap;\">Media</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Medication\"><span style=\"white-space: nowrap;\">Medication</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-medication.html\">US Core Medication Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_MedicationDispense\"><span style=\"white-space: nowrap;\">MedicationDispense</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-medicationdispense.html\">US Core MedicationDispense Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n patient, status, type\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+status+type, patient+status\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n MedicationDispense:medication\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_MedicationRequest\"><span style=\"white-space: nowrap;\">MedicationRequest</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-medicationrequest.html\">US Core MedicationRequest Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n authoredon, encounter, intent, patient, status\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+intent+authoredon, patient+intent+encounter, patient+intent, patient+intent+status\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n MedicationRequest:medication\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Observation\"><span style=\"white-space: nowrap;\">Observation</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-observation-adi-documentation.html\">US Core Observation ADI Documentation Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-observation-lab.html\">US Core Laboratory Result Observation Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-observation-pregnancystatus.html\">US Core Observation Pregnancy Status Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-observation-pregnancyintent.html\">US Core Observation Pregnancy Intent Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-observation-occupation.html\">US Core Observation Occupation Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-respiratory-rate.html\">US Core Respiratory Rate Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-simple-observation.html\">US Core Simple Observation Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-treatment-intervention-preference.html\">US Core Treatment Intervention Preference Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-care-experience-preference.html\">US Core Care Experience Preference Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-heart-rate.html\">US Core Heart Rate Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-body-temperature.html\">US Core Body Temperature Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-pediatric-weight-for-height.html\">US Core Pediatric Weight for Height Observation Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-pulse-oximetry.html\">US Core Pulse Oximetry Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-smokingstatus.html\">US Core Smoking Status Observation Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-observation-sexual-orientation.html\">US Core Observation Sexual Orientation Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-head-circumference.html\">US Core Head Circumference Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-body-height.html\">US Core Body Height Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-bmi.html\">US Core BMI Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-observation-screening-assessment.html\">US Core Observation Screening Assessment Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-average-blood-pressure.html\">US Core Average Blood Pressure Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-blood-pressure.html\">US Core Blood Pressure Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-observation-clinical-result.html\">US Core Observation Clinical Result Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-pediatric-bmi-for-age.html\">US Core Pediatric BMI for Age Observation Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-head-occipital-frontal-circumference-percentile.html\">US Core Pediatric Head Occipital Frontal Circumference Percentile Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-body-weight.html\">US Core Body Weight Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-vital-signs.html\">US Core Vital Signs Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n category, code, date, _lastUpdated, patient, status\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+code+date, patient+category+_lastUpdated, patient+category+date, patient+category, patient+category+status, patient+code\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Organization\"><span style=\"white-space: nowrap;\">Organization</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-organization.html\">US Core Organization Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n address, name\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Patient\"><span style=\"white-space: nowrap;\">Patient</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-patient.html\">US Core Patient Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n _id, birthdate, death-date, family, given, identifier, name\n \n <!-- Each set of optional and required combo search parameters -->\n , birthdate+name, birthdate+family, death-date+family\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Practitioner\"><span style=\"white-space: nowrap;\">Practitioner</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-practitioner.html\">US Core Practitioner Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n _id, identifier, name\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_PractitionerRole\"><span style=\"white-space: nowrap;\">PractitionerRole</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-practitionerrole.html\">US Core PractitionerRole Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n practitioner, specialty\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n PractitionerRole:endpoint\nPractitionerRole:practitioner\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Procedure\"><span style=\"white-space: nowrap;\">Procedure</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-procedure.html\">US Core Procedure Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n code, date, patient, status\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+code+date, patient+date, patient+status\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Provenance\"><span style=\"white-space: nowrap;\">Provenance</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-provenance.html\">US Core Provenance Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Questionnaire\"><span style=\"white-space: nowrap;\">Questionnaire</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"https://hl7.org/fhir/uv/sdc/StructureDefinition-sdc-questionnaire.html\">SDC Base Questionnaire Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_QuestionnaireResponse\"><span style=\"white-space: nowrap;\">QuestionnaireResponse</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-questionnaireresponse.html\">US Core QuestionnaireResponse Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n _id, authored, patient, questionnaire, status\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+questionnaire, patient+authored, patient+status\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_RelatedPerson\"><span style=\"white-space: nowrap;\">RelatedPerson</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-relatedperson.html\">US Core RelatedPerson Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n _id, name, patient\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+name\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_ServiceRequest\"><span style=\"white-space: nowrap;\">ServiceRequest</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-pmo-servicerequest.html\">US Core PMO ServiceRequest Profile</a><br/>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-servicerequest.html\">US Core ServiceRequest Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n _id, authored, category, code, patient, status\n \n <!-- Each set of optional and required combo search parameters -->\n , patient+code+authored, patient+category+authored, patient+category, patient+status, patient+code\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n Provenance:target\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Specimen\"><span style=\"white-space: nowrap;\">Specimen</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n \n \n \n \n <span style=\"color: grey;\">•</span><a href=\"StructureDefinition-us-core-specimen.html\">US Core Specimen Profile</a><br/>\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n _id, patient\n \n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_ValueSet\"><span style=\"white-space: nowrap;\">ValueSet</span></a>\n </td>\n\n <!-- Supported Interactions\n <td>\n \n </td> -->\n\n <!-- Supported Profiles -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>exist\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n <span style=\"color: grey;\">-</span>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n $expand\n \n </td>\n </tr>\n \n </tbody>\n </table>\n <br/>\n\n <h3 id=\"resource-details\" class=\"no_toc\">RESTful Client Capabilities by Resource/Profile:</h3>\n\n\n <!-- Resource Detail -->\n\n \n <h4 id=\"Client_AllergyIntolerance\" class=\"no_toc\">AllergyIntolerance</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n \n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-allergyintolerance.html\">US Core AllergyIntolerance Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a AllergyIntolerance resource using:\n <code class=\"highlighter-rouge\">POST [base]/AllergyIntolerance {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing AllergyIntolerance resource using:\n <code class=\"highlighter-rouge\">PUT [base]/AllergyIntolerance/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing AllergyIntolerance resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/AllergyIntolerance/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a AllergyIntolerance resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching AllergyIntolerance resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/AllergyIntolerance/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a AllergyIntolerance resource using:\n <code class=\"highlighter-rouge\">GET [base]/AllergyIntolerance/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a AllergyIntolerance resource using:\n <code class=\"highlighter-rouge\">GET [base]/AllergyIntolerance/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a AllergyIntolerance using:\n <code class=\"highlighter-rouge\">GET [base]/AllergyIntolerance/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of AllergyIntolerance resources using:\n <code class=\"highlighter-rouge\">GET [base]/AllergyIntolerance/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/AllergyIntolerance?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-allergyintolerance-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/AllergyIntolerance?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-allergyintolerance-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-allergyintolerance-clinical-status.html\">clinical-status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/AllergyIntolerance?patient=[type]/[id]&clinical-status=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-allergyintolerance-clinical-status.html\">clinical-status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values. The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-allergyintolerance-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values. The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_CarePlan\" class=\"no_toc\">CarePlan</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<p>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:</p>\n<ul>\n<li>\n<p>US Core Goal <strong>SHOULD</strong> be present in CarePlan.goal</p>\n</li>\n<li>\n<p>US Core Condition <strong>SHOULD</strong> be present in\nCarePlan.addresses</p>\n</li>\n<li>\n<p>Assessment and Plan <strong>MAY</strong> be included as narrative\ntext</p>\n</li>\n</ul>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-careplan.html\">US Core CarePlan Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a CarePlan resource using:\n <code class=\"highlighter-rouge\">POST [base]/CarePlan {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing CarePlan resource using:\n <code class=\"highlighter-rouge\">PUT [base]/CarePlan/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing CarePlan resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/CarePlan/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a CarePlan resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching CarePlan resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/CarePlan/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a CarePlan resource using:\n <code class=\"highlighter-rouge\">GET [base]/CarePlan/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a CarePlan resource using:\n <code class=\"highlighter-rouge\">GET [base]/CarePlan/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a CarePlan using:\n <code class=\"highlighter-rouge\">GET [base]/CarePlan/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of CarePlan resources using:\n <code class=\"highlighter-rouge\">GET [base]/CarePlan/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/CarePlan?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/CarePlan?patient=[type]/[id]&category=[system]|[code]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-careplan-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-careplan-category.html\">category</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/CarePlan?patient=[type]/[id]&category=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/CarePlan?patient=[type]/[id]&category=[system]|[code]&date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/CarePlan?patient=[type]/[id]&category=[system]|[code]&status=[system]|[code]&date=[dateTime]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-careplan-category.html\">category</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-careplan-date.html\">date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-careplan-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-careplan-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_CareTeam\" class=\"no_toc\">CareTeam</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<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>\n<ol>\n<li>\n<p>US Core Practitioner Profile</p>\n</li>\n<li>\n<p>US Core PractitionerRole Profile</p>\n</li>\n<li>\n<p>US Core Patient Profile</p>\n</li>\n<li>\n<p>US Core RelatedPerson Profile</p>\n</li>\n</ol>\n</li>\n<li>\n<p>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, but <strong>SHALL</strong> support <em>at least</em> one of them.</p>\n</li>\n<li>\n<p>The client application <strong>SHALL</strong> support all four profile references.</p>\n</li>\n<li>\n<p>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>.</p>\n</li>\n<li>\n<p>Servers that support only US Core Practitioner Profile and do not support the US Core PractitionerRole Profile <strong>SHALL</strong> provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.</p>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-careteam.html\">US Core CareTeam Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a CareTeam resource using:\n <code class=\"highlighter-rouge\">POST [base]/CareTeam {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing CareTeam resource using:\n <code class=\"highlighter-rouge\">PUT [base]/CareTeam/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing CareTeam resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/CareTeam/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a CareTeam resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching CareTeam resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/CareTeam/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a CareTeam resource using:\n <code class=\"highlighter-rouge\">GET [base]/CareTeam/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a CareTeam resource using:\n <code class=\"highlighter-rouge\">GET [base]/CareTeam/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a CareTeam using:\n <code class=\"highlighter-rouge\">GET [base]/CareTeam/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of CareTeam resources using:\n <code class=\"highlighter-rouge\">GET [base]/CareTeam/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _includes:\n <ul>\n \n \n <li>CareTeam:participant:PractitionerRole - <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:PractitionerRole</code></li>\n \n \n \n <li>CareTeam:participant:Practitioner - <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:Practitioner</code></li>\n \n \n \n <li>CareTeam:participant:Patient - <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:Patient</code></li>\n \n \n \n <li>CareTeam:participant:RelatedPerson - <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_include=CareTeam:participant:RelatedPerson</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/CareTeam?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-careteam-role.html\">role</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/CareTeam?role=[system]|[code]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-careteam-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-careteam-status.html\">status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/CareTeam?patient=[type]/[id]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-careteam-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-careteam-role.html\">role</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/CareTeam?patient=[type]/[id]&role=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-careteam-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-careteam-role.html\">role</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-careteam-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Condition\" class=\"no_toc\">Condition</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>For Encounter Diagnosis use the <em>US Core Condition Encounter Diagnosis Profile</em>.\n<ul>\n<li>When <code>Condition.category</code> is "encounter-diagnosis" the encounter, <strong>SHOULD</strong> be referenced in <code>Condition.encounter</code>.</li>\n</ul>\n</li>\n<li>For Problems and Health Concerns use the <em>US Core Condition Problems and Health Concerns Profile</em>.\n<ul>\n<li>When <code>Condition.category</code> is a "problems-list-item", the `Condition.clinicalStatus <strong>SHOULD</strong> be present.</li>\n<li>There is no single element in Condition that represents the date of diagnosis. It may be the assertedDate Extension, <code>Condition.onsetDateTime</code>, or <code>Condition.recordedDate</code>.\n<ul>\n<li>Although all three are marked as must support, the server is not required to support all.</li>\n<li>A server <strong>SHALL</strong> support <code>Condition.recordedDate</code>.\n<ul>\n<li>A server <strong>SHALL</strong> support at least one of the assertedDate Extension and <code>Condition.onsetDateTime</code>. A server may support both, which means they support all three elements.</li>\n<li>The client application <strong>SHALL</strong> support all three elements.</li>\n</ul>\n</li>\n</ul>\n</li>\n<li>See the US Core General Guidance page for <a href=\"general-guidance.html#searching-using-lastupdated\">Searching Using lastUpdated</a>. Updates to <code>Condition.meta.lastUpdated</code> <strong>SHOULD</strong> reflect:\n<ul>\n<li>New problems and health concerns</li>\n<li>Changes in the clinical status or verifications status of problems or health concern</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-condition-encounter-diagnosis.html\">US Core Condition Encounter Diagnosis Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-condition-problems-health-concerns.html\">US Core Condition Problems and Health Concerns Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Condition resource using:\n <code class=\"highlighter-rouge\">POST [base]/Condition {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Condition resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Condition/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Condition resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Condition/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Condition resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching Condition resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Condition/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Condition resource using:\n <code class=\"highlighter-rouge\">GET [base]/Condition/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Condition resource using:\n <code class=\"highlighter-rouge\">GET [base]/Condition/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Condition using:\n <code class=\"highlighter-rouge\">GET [base]/Condition/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Condition resources using:\n <code class=\"highlighter-rouge\">GET [base]/Condition/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Condition?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-condition-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Condition?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-condition-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-condition-clinical-status.html\">clinical-status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Condition?patient=[type]/[id]&clinical-status=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-condition-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-condition-code.html\">code</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Condition?patient=[type]/[id]&code=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-condition-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-condition-category.html\">category</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Condition?patient=[type]/[id]&category=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-condition-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-condition-abatement-date.html\">abatement-date</a>\n </td>\n <td>\n Reference+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Condition?patient=[type]/[id]&abatement-date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-condition-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-condition-recorded-date.html\">recorded-date</a>\n </td>\n <td>\n Reference+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Condition?patient=[type]/[id]&recorded-date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-condition-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-condition-lastupdated.html\">_lastUpdated</a>\n </td>\n <td>\n Reference+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Condition?patient=[type]/[id]&_lastUpdated=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-condition-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-condition-asserted-date.html\">asserted-date</a>\n </td>\n <td>\n Reference+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Condition?patient=[type]/[id]&asserted-date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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-clinical-status.html\">clinical-status</a>\n </td>\n <td>\n Reference+Token+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Condition?patient=[type]/[id]&category=[system]|[code]&clinical-status=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-condition-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-condition-onset-date.html\">onset-date</a>\n </td>\n <td>\n Reference+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Condition?patient=[type]/[id]&onset-date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Condition?patient=[type]/[id]&category=[system]|[code]&encounter=[type]/[id]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-condition-abatement-date.html\">abatement-date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-condition-asserted-date.html\">asserted-date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-condition-category.html\">category</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-condition-clinical-status.html\">clinical-status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-condition-code.html\">code</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-condition-encounter.html\">encounter</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-condition-onset-date.html\">onset-date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-condition-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-condition-recorded-date.html\">recorded-date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-condition-lastupdated.html\">_lastUpdated</a> (Date/DateTime):<div><p>A server <strong>SHALL</strong> document the types of changes that can be detected using this parameter.</p>\n<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Coverage\" class=\"no_toc\">Coverage</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n \n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-coverage.html\">US Core Coverage Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Coverage resource using:\n <code class=\"highlighter-rouge\">POST [base]/Coverage {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Coverage resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Coverage/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Coverage resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Coverage/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Coverage resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching Coverage resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Coverage/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Coverage resource using:\n <code class=\"highlighter-rouge\">GET [base]/Coverage/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Coverage resource using:\n <code class=\"highlighter-rouge\">GET [base]/Coverage/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Coverage using:\n <code class=\"highlighter-rouge\">GET [base]/Coverage/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Coverage resources using:\n <code class=\"highlighter-rouge\">GET [base]/Coverage/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Coverage?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-coverage-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Coverage?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-coverage-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Device\" class=\"no_toc\">Device</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<p>Medical devices with UDI information <strong>SHALL</strong> represent the UDI code in <code>Device.udiCarrier.carrierHRF</code>. All five UDI-PI elements defined in the UDI code may not always be present in every UDI instance. However, those UDI-PI elements present <strong>SHALL</strong> be represented in the corresponding *US Core Device Profile elements.</p>\n<p>UDI may not be present in all scenarios, such as\nhistorical medical devices, patient-reported implant information, payer-reported devices, or improperly documented implants. If UDI is not present and the manufacturer or model number information is available, they <strong>SHOULD</strong> be included to support historical reports of medical devices as follows:</p>\n<blockquote>\n<table class=\"grid\">\n<thead>\n<tr>\n<th>medical device data element</th>\n<th>US Core Device Profile element</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>manufacturer</td>\n<td><code>Device.manufacturer</code></td>\n</tr>\n<tr>\n<td>model</td>\n<td><code>Device.model</code></td>\n</tr>\n</tbody>\n</table>\n</blockquote>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-device.html\">US Core Device Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Device resource using:\n <code class=\"highlighter-rouge\">POST [base]/Device {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Device resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Device/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Device resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Device/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Device resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching Device resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Device/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Device resource using:\n <code class=\"highlighter-rouge\">GET [base]/Device/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Device resource using:\n <code class=\"highlighter-rouge\">GET [base]/Device/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Device using:\n <code class=\"highlighter-rouge\">GET [base]/Device/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Device resources using:\n <code class=\"highlighter-rouge\">GET [base]/Device/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Device?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-device-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Device?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-device-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-device-type.html\">type</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Device?patient=[type]/[id]&type=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-device-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-device-status.html\">status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Device?patient=[type]/[id]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-device-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-device-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-device-type.html\">type</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_DiagnosticReport\" class=\"no_toc\">DiagnosticReport</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<p>For laboratory result reports use the <em>US Core DiagnosticReport Profile for Laboratory Results Reporting Profile</em>.</p>\n<ul>\n<li>\n<p>Updates to <code>.meta.lastUpdated</code> <strong>SHOULD</strong> reflect:</p>\n<ul>\n<li>\n<p>New laboratory reports</p>\n</li>\n<li>\n<p>Changes in the status of laboratory reports including\nevents that trigger the same status (e.g., amended → amended).</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li>\n<p>For imaging and non-laboratory clinical test result reports use the <em>US Core DiagnosticReport Profile for Report and Note Exchange Profile</em>.</p>\n<ul>\n<li>\n<p>Diagnostic imaging results in visual images requiring\ninterpretation and clinical test results/reports may also reference images as part of the report. There is no single approach for accessing imaging studies alongside clinical data using a single authorization flow to give patients and providers access to the images.</p>\n<ul>\n<li>\n<p>The <code>DiagnosticReport.media.link</code> element <strong>SHOULD</strong>\nbe used to support links to various patient-friendly content, such as jpg images of x-rays (see the DiagnosticReport Chest X-ray Report Example).</p>\n</li>\n<li>\n<p>The <code>DiagnosticReport.imagingStudy</code> element <strong>SHOULD</strong>\nbe used to support exchange with systems that can view DICOM (Digital Imaging and Communications in Medicine) studies, series, and SOP (Service-Object Pair) instances referenced in the [ImagingStudy] resource.</p>\n</li>\n<li>\n<p>Alternatively, systems can use business identifiers\nsuch as accession numbers in the <code>identifier</code> element to access the source images from external sources.</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li>\n<p>The <code>DiagnosticRequest.basedOn</code> element connects the DiagnosticReport to the originating order in the EHR. Systems that initiate the lab order <strong>SHOULD</strong> use this element when reporting the results.</p>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-diagnosticreport-note.html\">US Core DiagnosticReport Profile for Report and Note exchange</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-diagnosticreport-lab.html\">US Core DiagnosticReport Profile for Laboratory Results Reporting</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support create, search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>SHALL</strong> be capable of posting a DiagnosticReport resource using:\n <code class=\"highlighter-rouge\">POST [base]/DiagnosticReport {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing DiagnosticReport resource using:\n <code class=\"highlighter-rouge\">PUT [base]/DiagnosticReport/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing DiagnosticReport resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/DiagnosticReport/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a DiagnosticReport resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching DiagnosticReport resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a DiagnosticReport resource using:\n <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a DiagnosticReport resource using:\n <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a DiagnosticReport using:\n <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of DiagnosticReport resources using:\n <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n <blockquote>\n <p>create</p><div><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>\n</div>\n </blockquote>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport?patient=[type]/[id]&code=[system]|[code]&date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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-lastupdated.html\">_lastUpdated</a>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport?patient=[type]/[id]&category=[system]|[code]&_lastUpdated=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport?patient=[type]/[id]&category=[system]|[code]&date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-diagnosticreport-category.html\">category</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport?patient=[type]/[id]&category=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-diagnosticreport-status.html\">status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport?patient=[type]/[id]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-diagnosticreport-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-diagnosticreport-code.html\">code</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DiagnosticReport?patient=[type]/[id]&code=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-diagnosticreport-category.html\">category</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-diagnosticreport-code.html\">code</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-diagnosticreport-date.html\">date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-diagnosticreport-lastupdated.html\">_lastUpdated</a> (Date/DateTime):<div><p>A server <strong>SHALL</strong> document the types of changes that can be detected using this parameter.</p>\n<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-diagnosticreport-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-diagnosticreport-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_DocumentReference\" class=\"no_toc\">DocumentReference</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<p>For Advance Directive Information (ADI) documents use the <em>US Core ADI DocumentReference Profile</em>.</p>\n</li>\n<li>\n<p>For other clinical documents use the <em>US Core DiagnosticReport Profile for Report and Note Exchange</em>.</p>\n<ul>\n<li>\n<p>See the <a href=\"clinical-notes.html\">Clinical Notes</a> page for\nimportant definitions, requirements, and guidance on creating, using, and sharing Clinical Notes.</p>\n</li>\n<li>\n<p>The <code>DocumentReference.type</code> binding Must Support at\na minimum the <a href=\"ValueSet-us-core-clinical-note-type.html\">10 Common Clinical Notes</a> and may extend to the full US Core DocumentReference Type Value Set</p>\n</li>\n</ul>\n</li>\n<li>\n<p>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>.</p>\n<ul>\n<li>\n<p>Although both are marked as must support, the server\nsystem is not required to support an address, and inline base64 encoded data, but <strong>SHALL</strong> support at least one of these elements.</p>\n</li>\n<li>\n<p>The client application <strong>SHALL</strong> support both\nelements.</p>\n</li>\n<li>\n<p>The <code>content.attachment.url</code> may refer to a FHIR\nBinary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or another endpoint.</p>\n</li>\n<li>\n<p>If there are multiple <code>DocumentReference.content</code>\nelement repetitions, these <strong>SHALL</strong> all represent the same document in different format or attachment metadata. The content element <strong>SHALL NOT</strong> contain different versions of the same content. For version handling use multiple DocumentReferences with <code>DocumentReference.relatesTo</code></p>\n</li>\n</ul>\n</li>\n<li>\n<p>Every DocumentReference must have a responsible Organization. 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>.</p>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-adi-documentreference.html\">US Core ADI DocumentReference Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support create, search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>SHALL</strong> be capable of posting a DocumentReference resource using:\n <code class=\"highlighter-rouge\">POST [base]/DocumentReference {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing DocumentReference resource using:\n <code class=\"highlighter-rouge\">PUT [base]/DocumentReference/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing DocumentReference resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/DocumentReference/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a DocumentReference resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching DocumentReference resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a DocumentReference resource using:\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a DocumentReference resource using:\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a DocumentReference using:\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of DocumentReference resources using:\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/DocumentReference?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-documentreference-id.html\">_id</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference?_id=[id]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-documentreference-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-documentreference-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-documentreference-type.html\">type</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference?patient=[type]/[id]&type=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference?patient=[type]/[id]&category=[system]|[code]&date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-documentreference-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-documentreference-category.html\">category</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference?patient=[type]/[id]&category=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference?patient=[type]/[id]&type=[system]|[code]&period=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-documentreference-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-documentreference-status.html\">status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference?patient=[type]/[id]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-documentreference-category.html\">category</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-documentreference-date.html\">date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-documentreference-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-documentreference-period.html\">period</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-documentreference-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-documentreference-type.html\">type</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n <p>FHIR Operations:</p>\n \n\n <ul>\n \n \n\n \n \n <li> <strong>SHOULD</strong> support\n \n \n \n <a href=\"OperationDefinition-docref.html\"><code>$docref</code></a>\n \n </li>\n \n\n \n \n\n \n \n\n \n \n\n </ul>\n \n \n <blockquote>\n <p><code>$docref</code>:</p><div><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>\n<p><code>GET [base]/DocumentReference/$docref?patient=[id]</code></p>\n</div>\n </blockquote>\n \n \n \n\n <hr/>\n \n <h4 id=\"Client_Encounter\" class=\"no_toc\">Encounter</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<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>\n<ul>\n<li>\n<p>Although both are marked as must support, the server\nsystems 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.</p>\n</li>\n<li>\n<p>The client application <strong>SHALL</strong> support both elements.</p>\n</li>\n<li>\n<p>if <code>Encounter.reasonReference</code> references an\nObservation, 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)</p>\n</li>\n</ul>\n</li>\n<li>\n<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>\n<ul>\n<li>\n<p>Although both are marked as must support, the server\nsystems 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.</p>\n</li>\n<li>\n<p>The client application <strong>SHALL</strong> support both elements.</p>\n</li>\n</ul>\n</li>\n<li>\n<p>If the event facility/location differs from the <code>Encounter.location</code>, systems <strong>SHOULD</strong> reference it directly:</p>\n</li>\n<li>\n<p>Servers can use the US Core Interpreter Needed Extension on this profile or the [US Core Patient Profile] to communicate whether a patient needs an interpreter. Although the extension is marked as an <em>Additional USCDI Requirements</em> on both US Core Patient and US Core Encounter Profiles, the certifying Server system is not required to support the extension on both profiles, but <strong>SHALL</strong> support the extension on at least one. The certifying Client application <strong>SHALL</strong> support the extension on both profiles.</p>\n<ul>\n<li>Systems <strong>SHOULD</strong> designate the patient's preferred\nlanguage in the <code>Patient.communication.preferred</code> element.</li>\n</ul>\n</li>\n<li>\n<p>Updates to <code>.meta.lastUpdated</code> <strong>SHOULD</strong> reflect:</p>\n<ul>\n<li>\n<p>New encounters/visits</p>\n</li>\n<li>\n<p>Changes in the status of encounters, including events\nthat trigger the same status (e.g., in-progress → in-progress). These status changes correspond to events that can initiate [HL7 V2] ADT messages.</p>\n</li>\n</ul>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-encounter.html\">US Core Encounter Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Encounter resource using:\n <code class=\"highlighter-rouge\">POST [base]/Encounter {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Encounter resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Encounter/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Encounter resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Encounter/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Encounter resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching Encounter resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Encounter/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Encounter resource using:\n <code class=\"highlighter-rouge\">GET [base]/Encounter/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Encounter resource using:\n <code class=\"highlighter-rouge\">GET [base]/Encounter/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Encounter using:\n <code class=\"highlighter-rouge\">GET [base]/Encounter/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Encounter resources using:\n <code class=\"highlighter-rouge\">GET [base]/Encounter/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Encounter?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-encounter-id.html\">_id</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Encounter?_id=[id]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-encounter-identifier.html\">identifier</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Encounter?identifier=[system]|[code]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-encounter-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Encounter?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-encounter-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-encounter-type.html\">type</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Encounter?patient=[type]/[id]&type=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-encounter-class.html\">class</a>+<a href=\"SearchParameter-us-core-encounter-patient.html\">patient</a>\n </td>\n <td>\n Token+Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Encounter?class=[system]|[code]&patient=[type]/[id]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-encounter-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-encounter-status.html\">status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Encounter?patient=[type]/[id]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-encounter-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-encounter-lastupdated.html\">_lastUpdated</a>\n </td>\n <td>\n Reference+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Encounter?patient=[type]/[id]&_lastUpdated=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-encounter-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-encounter-location.html\">location</a>\n </td>\n <td>\n Reference+Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Encounter?patient=[type]/[id]&location=[type]/[id]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-encounter-date.html\">date</a>+<a href=\"SearchParameter-us-core-encounter-patient.html\">patient</a>\n </td>\n <td>\n Date/DateTime+Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Encounter?date=[dateTime]&patient=[type]/[id]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-encounter-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-encounter-discharge-disposition.html\">discharge-disposition</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Encounter?patient=[type]/[id]&discharge-disposition=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-encounter-class.html\">class</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-encounter-date.html\">date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-encounter-lastupdated.html\">_lastUpdated</a> (Date/DateTime):<div><p>A server <strong>SHALL</strong> document the types of changes that can be detected using this parameter.</p>\n<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-encounter-discharge-disposition.html\">discharge-disposition</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-encounter-identifier.html\">identifier</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-encounter-location.html\">location</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-encounter-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-encounter-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-encounter-type.html\">type</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Endpoint\" class=\"no_toc\">Endpoint</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>The Media Resource is a Must Support referenced resource when using the US Core PractitionerRole Profile.</p>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n \n \n <li><strong>SHOULD</strong> support read, vread</li>\n \n \n <li><strong>MAY</strong> support create, search-type, update, patch, delete, history-instance, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Endpoint resource using:\n <code class=\"highlighter-rouge\">POST [base]/Endpoint {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Endpoint resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Endpoint/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Endpoint resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Endpoint/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Endpoint resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching Endpoint resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Endpoint/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a Endpoint resource using:\n <code class=\"highlighter-rouge\">GET [base]/Endpoint/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Endpoint resource using:\n <code class=\"highlighter-rouge\">GET [base]/Endpoint/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Endpoint using:\n <code class=\"highlighter-rouge\">GET [base]/Endpoint/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Endpoint resources using:\n <code class=\"highlighter-rouge\">GET [base]/Endpoint/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_FamilyMemberHistory\" class=\"no_toc\">FamilyMemberHistory</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n \n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-familymemberhistory.html\">US Core FamilyMemberHistory Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a FamilyMemberHistory resource using:\n <code class=\"highlighter-rouge\">POST [base]/FamilyMemberHistory {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing FamilyMemberHistory resource using:\n <code class=\"highlighter-rouge\">PUT [base]/FamilyMemberHistory/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing FamilyMemberHistory resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/FamilyMemberHistory/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a FamilyMemberHistory resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching FamilyMemberHistory resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/FamilyMemberHistory/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a FamilyMemberHistory resource using:\n <code class=\"highlighter-rouge\">GET [base]/FamilyMemberHistory/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a FamilyMemberHistory resource using:\n <code class=\"highlighter-rouge\">GET [base]/FamilyMemberHistory/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a FamilyMemberHistory using:\n <code class=\"highlighter-rouge\">GET [base]/FamilyMemberHistory/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of FamilyMemberHistory resources using:\n <code class=\"highlighter-rouge\">GET [base]/FamilyMemberHistory/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/FamilyMemberHistory?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-familymemberhistory-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/FamilyMemberHistory?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-familymemberhistory-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-familymemberhistory-code.html\">code</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/FamilyMemberHistory?patient=[type]/[id]&code=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-familymemberhistory-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-familymemberhistory-code.html\">code</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Goal\" class=\"no_toc\">Goal</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>Although both <code>Goal.startDate</code> and <code>Goal.target.dueDate</code> are marked as must support, the server system is not required to support both, but <strong>SHALL</strong> support at least one of these elements. The client application <strong>SHALL</strong> support both elements.</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-goal.html\">US Core Goal Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Goal resource using:\n <code class=\"highlighter-rouge\">POST [base]/Goal {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Goal resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Goal/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Goal resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Goal/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Goal resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching Goal resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Goal/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Goal resource using:\n <code class=\"highlighter-rouge\">GET [base]/Goal/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Goal resource using:\n <code class=\"highlighter-rouge\">GET [base]/Goal/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Goal using:\n <code class=\"highlighter-rouge\">GET [base]/Goal/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Goal resources using:\n <code class=\"highlighter-rouge\">GET [base]/Goal/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Goal?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-goal-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Goal?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-goal-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-goal-description.html\">description</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Goal?patient=[type]/[id]&description=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-goal-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-goal-target-date.html\">target-date</a>\n </td>\n <td>\n Reference+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Goal?patient=[type]/[id]&target-date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-goal-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-goal-lifecycle-status.html\">lifecycle-status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Goal?patient=[type]/[id]&lifecycle-status=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-goal-lifecycle-status.html\">lifecycle-status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-goal-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-goal-target-date.html\">target-date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>day</em>.</p>\n<p>A server <strong>SHALL</strong> support a value a value precise to the <em>day</em>.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_HealthcareService\" class=\"no_toc\">HealthcareService</h4>\n\n <p>Conformance Expectation:\t<strong>MAY</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>The HealthcareService Resource is a referenced resource when using the US Core PractitionerRole Profile and subject to constraint us-core-13: "SHALL have a practitioner, an organization, a healthcare service, or a location."</p>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n \n \n <li><strong>SHOULD</strong> support read, vread</li>\n \n \n <li><strong>MAY</strong> support create, search-type, update, patch, delete, history-instance, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a HealthcareService resource using:\n <code class=\"highlighter-rouge\">POST [base]/HealthcareService {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing HealthcareService resource using:\n <code class=\"highlighter-rouge\">PUT [base]/HealthcareService/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing HealthcareService resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/HealthcareService/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a HealthcareService resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching HealthcareService resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/HealthcareService/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a HealthcareService resource using:\n <code class=\"highlighter-rouge\">GET [base]/HealthcareService/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a HealthcareService resource using:\n <code class=\"highlighter-rouge\">GET [base]/HealthcareService/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a HealthcareService using:\n <code class=\"highlighter-rouge\">GET [base]/HealthcareService/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of HealthcareService resources using:\n <code class=\"highlighter-rouge\">GET [base]/HealthcareService/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Immunization\" class=\"no_toc\">Immunization</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>Based upon the ASTP U.S. Core Data for Interoperability (USCDI) requirements, CVX vaccine codes are required and the NDC vaccine codes <strong>SHOULD</strong> be supported as an additional code.</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-immunization.html\">US Core Immunization Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Immunization resource using:\n <code class=\"highlighter-rouge\">POST [base]/Immunization {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Immunization resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Immunization/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Immunization resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Immunization/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Immunization resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching Immunization resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Immunization/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Immunization resource using:\n <code class=\"highlighter-rouge\">GET [base]/Immunization/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Immunization resource using:\n <code class=\"highlighter-rouge\">GET [base]/Immunization/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Immunization using:\n <code class=\"highlighter-rouge\">GET [base]/Immunization/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Immunization resources using:\n <code class=\"highlighter-rouge\">GET [base]/Immunization/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Immunization?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-immunization-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Immunization?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-immunization-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-immunization-date.html\">date</a>\n </td>\n <td>\n Reference+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Immunization?patient=[type]/[id]&date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-immunization-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-immunization-status.html\">status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Immunization?patient=[type]/[id]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-immunization-date.html\">date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-immunization-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-immunization-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Location\" class=\"no_toc\">Location</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>Systems <strong>SHOULD</strong> follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for <code>Location.address.line</code> and <code>Location.address.city</code>.</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-location.html\">US Core Location Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Location resource using:\n <code class=\"highlighter-rouge\">POST [base]/Location {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Location resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Location/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Location resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Location/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Location resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching Location resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Location/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Location resource using:\n <code class=\"highlighter-rouge\">GET [base]/Location/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Location resource using:\n <code class=\"highlighter-rouge\">GET [base]/Location/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Location using:\n <code class=\"highlighter-rouge\">GET [base]/Location/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Location resources using:\n <code class=\"highlighter-rouge\">GET [base]/Location/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-location-address.html\">address</a>\n </td>\n <td>\n String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Location?address=[address]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-location-address-city.html\">address-city</a>\n </td>\n <td>\n String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Location?address-city=[address-city]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-location-address-postalcode.html\">address-postalcode</a>\n </td>\n <td>\n String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Location?address-postalcode=[address-postalcode]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-location-address-state.html\">address-state</a>\n </td>\n <td>\n String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Location?address-state=[address-state]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-location-name.html\">name</a>\n </td>\n <td>\n String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Location?name=[name]\n </code>\n </td>\n </tr>\n\n \n \n </tbody>\n </table>\n \n\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Media\" class=\"no_toc\">Media</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>The Media Resource is a Must Support referenced resource when using the US Core DiagnosticReport Profile for Report and Note Exchange.</p>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n \n \n <li><strong>SHOULD</strong> support read, vread</li>\n \n \n <li><strong>MAY</strong> support create, search-type, update, patch, delete, history-instance, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Media resource using:\n <code class=\"highlighter-rouge\">POST [base]/Media {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Media resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Media/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Media resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Media/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Media resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching Media resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Media/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a Media resource using:\n <code class=\"highlighter-rouge\">GET [base]/Media/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Media resource using:\n <code class=\"highlighter-rouge\">GET [base]/Media/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Media using:\n <code class=\"highlighter-rouge\">GET [base]/Media/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Media resources using:\n <code class=\"highlighter-rouge\">GET [base]/Media/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Medication\" class=\"no_toc\">Medication</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<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>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-medication.html\">US Core Medication Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, search-type, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Medication resource using:\n <code class=\"highlighter-rouge\">POST [base]/Medication {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Medication resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Medication/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Medication resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Medication/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Medication resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching Medication resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Medication/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Medication resource using:\n <code class=\"highlighter-rouge\">GET [base]/Medication/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Medication resource using:\n <code class=\"highlighter-rouge\">GET [base]/Medication/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Medication using:\n <code class=\"highlighter-rouge\">GET [base]/Medication/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Medication resources using:\n <code class=\"highlighter-rouge\">GET [base]/Medication/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_MedicationDispense\" class=\"no_toc\">MedicationDispense</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<p>This Profile can represent a medication using a code or reference a Medication resource.</p>\n<ul>\n<li>\n<p>The Server systems are not required to support both\na code and a reference, but <strong>SHALL</strong> support at least one of these methods.</p>\n</li>\n<li>\n<p>The Client application <strong>SHALL</strong> support all methods.</p>\n</li>\n<li>\n<p>Systems that primarily rely on NDC codes instead of\nRxNorm to represent medications can use the National Library of Medicine's (NLM) NDC to RxNorm mappings to aid in additional codings.</p>\n</li>\n<li>\n<p>When referencing a Medication resource in\n<code>.medicationReference</code>, the resource may be contained or an external resource. If an external reference to a Medication resource is used, the Server <strong>SHALL</strong> support the <code>_include</code> parameter for searching this element.</p>\n</li>\n</ul>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-medicationdispense.html\">US Core MedicationDispense Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a MedicationDispense resource using:\n <code class=\"highlighter-rouge\">POST [base]/MedicationDispense {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing MedicationDispense resource using:\n <code class=\"highlighter-rouge\">PUT [base]/MedicationDispense/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing MedicationDispense resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/MedicationDispense/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a MedicationDispense resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching MedicationDispense resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/MedicationDispense/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a MedicationDispense resource using:\n <code class=\"highlighter-rouge\">GET [base]/MedicationDispense/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a MedicationDispense resource using:\n <code class=\"highlighter-rouge\">GET [base]/MedicationDispense/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a MedicationDispense using:\n <code class=\"highlighter-rouge\">GET [base]/MedicationDispense/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of MedicationDispense resources using:\n <code class=\"highlighter-rouge\">GET [base]/MedicationDispense/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _includes:\n <ul>\n \n \n <li>MedicationDispense:medication - <code class=\"highlighter-rouge\">GET [base]/MedicationDispense?[parameter=value]&_include=MedicationDispense:medication</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/MedicationDispense?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-medicationdispense-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/MedicationDispense?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-medicationdispense-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-medicationdispense-status.html\">status</a>+<a href=\"SearchParameter-us-core-medicationdispense-type.html\">type</a>\n </td>\n <td>\n Reference+Token+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/MedicationDispense?patient=[type]/[id]&status=[system]|[code]&type=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-medicationdispense-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-medicationdispense-status.html\">status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/MedicationDispense?patient=[type]/[id]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-medicationdispense-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-medicationdispense-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-medicationdispense-type.html\">type</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_MedicationRequest\" class=\"no_toc\">MedicationRequest</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<p>This Profile can represent a medication using a code or reference a Medication resource.</p>\n<ul>\n<li>The Server systems are not required to support both a code and a reference, but <strong>SHALL</strong> support at least one of these methods.</li>\n<li>The Client application <strong>SHALL</strong> support all methods.</li>\n<li>Systems that primarily rely on NDC codes instead of RxNorm to represent medications can use the National Library of Medicine's (NLM) NDC to RxNorm mappings to aid in additional codings.</li>\n<li>When referencing a Medication resource in <code>.medicationReference</code>, the resource may be contained or an external resource. If an external reference to a Medication resource is used, the Server <strong>SHALL</strong> support the <code>_include</code> parameter for searching this element.</li>\n</ul>\n</li>\n<li>\n<p>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.</p>\n<ul>\n<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>\n<li>The client application <strong>SHALL</strong> support both elements.</li>\n</ul>\n</li>\n<li>\n<p>When recording “self-prescribed” medication, requester <strong>SHOULD</strong> be used to indicate the Patient or RelatedPerson as the prescriber. (See the Medication List section for guidance on accessing a patient medications including over the counter (OTC) medication and other substances taken for medical and recreational use.)</p>\n</li>\n<li>\n<p>The MedicationRequest resource can communicate the reason or indication for treatment using either a code in MedicationRequest.reasonCode or a reference using MedicationRequest.reasonReference.</p>\n<ul>\n<li>Although both <code>MedicationRequest.reasonCode</code> and <code>MedicationRequest.reasonReference</code> are marked as Additional USCDI Requirements. The certifying server system is not required to support both but <strong>SHALL</strong> support at least one of these elements. The certifying client application <strong>SHALL</strong> support both elements.</li>\n<li>when using MedicationRequest.reasonReference:\n<ul>\n<li>Servers <strong>SHALL</strong> support at least one target resource in <code>MedicationRequest.reasonReference</code>. Clients <strong>SHALL</strong> support all target resources.</li>\n<li>The referenced resources <strong>SHOULD</strong> be a US Core Profile as documented in Referencing US Core Profiles.</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-medicationrequest.html\">US Core MedicationRequest Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a MedicationRequest resource using:\n <code class=\"highlighter-rouge\">POST [base]/MedicationRequest {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing MedicationRequest resource using:\n <code class=\"highlighter-rouge\">PUT [base]/MedicationRequest/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing MedicationRequest resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/MedicationRequest/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a MedicationRequest resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching MedicationRequest resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/MedicationRequest/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a MedicationRequest resource using:\n <code class=\"highlighter-rouge\">GET [base]/MedicationRequest/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a MedicationRequest resource using:\n <code class=\"highlighter-rouge\">GET [base]/MedicationRequest/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a MedicationRequest using:\n <code class=\"highlighter-rouge\">GET [base]/MedicationRequest/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of MedicationRequest resources using:\n <code class=\"highlighter-rouge\">GET [base]/MedicationRequest/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _includes:\n <ul>\n \n \n <li>MedicationRequest:medication - <code class=\"highlighter-rouge\">GET [base]/MedicationRequest?[parameter=value]&_include=MedicationRequest:medication</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/MedicationRequest?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/MedicationRequest?patient=[type]/[id]&intent=[system]|[code]&authoredon=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/MedicationRequest?patient=[type]/[id]&intent=[system]|[code]&encounter=[type]/[id]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-medicationrequest-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-medicationrequest-intent.html\">intent</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/MedicationRequest?patient=[type]/[id]&intent=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/MedicationRequest?patient=[type]/[id]&intent=[system]|[code]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-medicationrequest-authoredon.html\">authoredon</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-medicationrequest-encounter.html\">encounter</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-medicationrequest-intent.html\">intent</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-medicationrequest-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-medicationrequest-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Observation\" class=\"no_toc\">Observation</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<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>\n<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\n<ul>\n<li>Systems that never provide an observation without a value are not required to support <code>Observation.dataAbsentReason</code></li>\n</ul>\n</li>\n<li>An <code>Observation.component</code> without a value, <strong>SHALL</strong> include a reason why the data is absent.\n<ul>\n<li>Systems that never provide an component observation without a component value are not required to support <code>Observation.component.dataAbsentReason</code>.</li>\n</ul>\n</li>\n<li>There are multiple Observation profiles. Refer to the specific profile page for profile specific conformance rules and guidance</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-observation-adi-documentation.html\">US Core Observation ADI Documentation Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-observation-lab.html\">US Core Laboratory Result Observation Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-observation-pregnancystatus.html\">US Core Observation Pregnancy Status Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-observation-pregnancyintent.html\">US Core Observation Pregnancy Intent Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-observation-occupation.html\">US Core Observation Occupation Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-respiratory-rate.html\">US Core Respiratory Rate Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-simple-observation.html\">US Core Simple Observation Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-treatment-intervention-preference.html\">US Core Treatment Intervention Preference Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-care-experience-preference.html\">US Core Care Experience Preference Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-heart-rate.html\">US Core Heart Rate Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-body-temperature.html\">US Core Body Temperature Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-pediatric-weight-for-height.html\">US Core Pediatric Weight for Height Observation Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-pulse-oximetry.html\">US Core Pulse Oximetry Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-smokingstatus.html\">US Core Smoking Status Observation Profile</a>\n \n </li>\n \n \n \n \n <li><strong>MAY</strong> support \n \n <a href=\"StructureDefinition-us-core-observation-sexual-orientation.html\">US Core Observation Sexual Orientation Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-head-circumference.html\">US Core Head Circumference Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-body-height.html\">US Core Body Height Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-bmi.html\">US Core BMI Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-observation-screening-assessment.html\">US Core Observation Screening Assessment Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-average-blood-pressure.html\">US Core Average Blood Pressure Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-blood-pressure.html\">US Core Blood Pressure Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-observation-clinical-result.html\">US Core Observation Clinical Result Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-pediatric-bmi-for-age.html\">US Core Pediatric BMI for Age Observation Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-head-occipital-frontal-circumference-percentile.html\">US Core Pediatric Head Occipital Frontal Circumference Percentile Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-body-weight.html\">US Core Body Weight Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-vital-signs.html\">US Core Vital Signs Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Observation resource using:\n <code class=\"highlighter-rouge\">POST [base]/Observation {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Observation resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Observation/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Observation resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Observation/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Observation resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching Observation resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Observation/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Observation resource using:\n <code class=\"highlighter-rouge\">GET [base]/Observation/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Observation resource using:\n <code class=\"highlighter-rouge\">GET [base]/Observation/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Observation using:\n <code class=\"highlighter-rouge\">GET [base]/Observation/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Observation resources using:\n <code class=\"highlighter-rouge\">GET [base]/Observation/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Observation?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Observation?patient=[type]/[id]&code=[system]|[code]&date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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-lastupdated.html\">_lastUpdated</a>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Observation?patient=[type]/[id]&category=[system]|[code]&_lastUpdated=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Observation?patient=[type]/[id]&category=[system]|[code]&date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-observation-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-observation-category.html\">category</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Observation?patient=[type]/[id]&category=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Observation?patient=[type]/[id]&category=[system]|[code]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-observation-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-observation-code.html\">code</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Observation?patient=[type]/[id]&code=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-observation-category.html\">category</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-observation-code.html\">code</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-observation-date.html\">date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-observation-lastupdated.html\">_lastUpdated</a> (Date/DateTime):<div><p>A server <strong>SHALL</strong> document the types of changes that can be detected using this parameter.</p>\n<p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-observation-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-observation-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Organization\" class=\"no_toc\">Organization</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>Systems <strong>SHALL</strong> support National Provider Identifier (NPI) for organizations and <strong>SHOULD</strong> support Clinical Laboratory Improvement Amendments (CLIA) and the National Association of Insurance Commissioners NAIC Company code (sometimes called "NAIC Number" or "cocode") for <code>Organization.Identifier</code>.</li>\n<li>Systems <strong>SHOULD</strong> follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for <code>Organization.address.line</code> and <code>Organization.address.city</code>.</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-organization.html\">US Core Organization Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Organization resource using:\n <code class=\"highlighter-rouge\">POST [base]/Organization {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Organization resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Organization/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Organization resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Organization/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Organization resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching Organization resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Organization/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Organization resource using:\n <code class=\"highlighter-rouge\">GET [base]/Organization/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Organization resource using:\n <code class=\"highlighter-rouge\">GET [base]/Organization/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Organization using:\n <code class=\"highlighter-rouge\">GET [base]/Organization/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Organization resources using:\n <code class=\"highlighter-rouge\">GET [base]/Organization/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-organization-address.html\">address</a>\n </td>\n <td>\n String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Organization?address=[address]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-organization-name.html\">name</a>\n </td>\n <td>\n String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Organization?name=[name]\n </code>\n </td>\n </tr>\n\n \n \n </tbody>\n </table>\n \n\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Patient\" class=\"no_toc\">Patient</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>The Patient's Social Security Numbers <strong>SHOULD NOT</strong> be used as a patient identifier in <code>Patient.identifier.value</code>.</li>\n<li>The Complex Extensions for Race and Ethnicity allow for one or more codes of which: Must Support at least one category code from the OMB Race and Ethnicity Category Value Sets that draw from the Race & Ethnicity - CDC (CDCREC] code system.\n<ul>\n<li><strong>MAY</strong> include additional codes from the detailed ethnicity and detailed race value sets drawn from the Race & Ethnicity - CDC (CDCREC) code system</li>\n<li><strong>SHALL</strong> include a text description</li>\n</ul>\n</li>\n<li>Although Patient.deceased[x] is marked as <em>Additional USCDI Requirement</em>, certifying systems are not required to support both choices, but <strong>SHALL</strong> support at least <code>Patient.deceasedDateTime</code>.</li>\n<li>Servers can use the US Core Interpreter Needed Extension on this profile or the US Core Encounter Profile to communicate whether a patient needs an interpreter. Although the extension is marked as an <em>Additional USCDI Requirement</em> on both US Core Patient and US Core Encounter Profiles, the certifying Server system is not required to support the extension on both profiles but <strong>SHALL</strong> support the extension on at least one. The certifying Client application <strong>SHALL</strong> support the extension on both profiles.\n<ul>\n<li>Systems <strong>SHOULD</strong> designate the patient's preferred language in the <code>Patient.communication.preferred</code> element.</li>\n</ul>\n</li>\n<li>Certifying systems <strong>SHALL</strong> and non-certifying systems <strong>SHOULD</strong> follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for <code>Patient.address.line</code> and <code>Patient.address.city</code> for new and updated records.</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-patient.html\">US Core Patient Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Patient resource using:\n <code class=\"highlighter-rouge\">POST [base]/Patient {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Patient resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Patient/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Patient resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Patient/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Patient resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching Patient resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Patient resource using:\n <code class=\"highlighter-rouge\">GET [base]/Patient/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Patient resource using:\n <code class=\"highlighter-rouge\">GET [base]/Patient/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Patient using:\n <code class=\"highlighter-rouge\">GET [base]/Patient/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Patient resources using:\n <code class=\"highlighter-rouge\">GET [base]/Patient/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Patient?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-patient-id.html\">_id</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Patient?_id=[id]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-patient-identifier.html\">identifier</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Patient?identifier=[system]|[code]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-patient-name.html\">name</a>\n </td>\n <td>\n String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Patient?name=[name]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-patient-birthdate.html\">birthdate</a>+<a href=\"SearchParameter-us-core-patient-name.html\">name</a>\n </td>\n <td>\n Date/DateTime+String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Patient?birthdate=[dateTime]&name=[name]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-patient-birthdate.html\">birthdate</a>+<a href=\"SearchParameter-us-core-patient-family.html\">family</a>\n </td>\n <td>\n Date/DateTime+String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Patient?birthdate=[dateTime]&family=[family]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-patient-death-date.html\">death-date</a>+<a href=\"SearchParameter-us-core-patient-family.html\">family</a>\n </td>\n <td>\n Date/DateTime+String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Patient?death-date=[dateTime]&family=[family]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-patient-birthdate.html\">birthdate</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>day</em>.</p>\n<p>A server <strong>SHALL</strong> support a value a value precise to the <em>day</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-patient-death-date.html\">death-date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>day</em>.</p>\n<p>A server <strong>SHALL</strong> support a value a value precise to the <em>day</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-patient-identifier.html\">identifier</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Practitioner\" class=\"no_toc\">Practitioner</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<p>Servers that support only US Core Practitioner Profile and do not support the US Core PractitionerRole Profile <strong>SHALL</strong> provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.</p>\n<ul>\n<li>Although Practitioner.address is marked as Must Support,\nthe server system is not required to support it if they support the US Core PractitionerRole Profile, but <strong>SHALL</strong> support it if they do not support the US Core PractitionerRole Profile. The client application <strong>SHALL</strong> support both.</li>\n</ul>\n</li>\n<li>\n<p>To balance the privacy of healthcare workers with the patient's right to access information. Only professional/work contact information about the practitioner <strong>SHOULD</strong> be available to the patient (such as a work address or office telephone number).</p>\n</li>\n<li>\n<p>Systems <strong>SHOULD</strong> follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for <code>Practitioner.address.line</code> and <code>Practitioner.address.city</code>.</p>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-practitioner.html\">US Core Practitioner Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Practitioner resource using:\n <code class=\"highlighter-rouge\">POST [base]/Practitioner {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Practitioner resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Practitioner/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Practitioner resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Practitioner/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Practitioner resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching Practitioner resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Practitioner/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Practitioner resource using:\n <code class=\"highlighter-rouge\">GET [base]/Practitioner/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Practitioner resource using:\n <code class=\"highlighter-rouge\">GET [base]/Practitioner/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Practitioner using:\n <code class=\"highlighter-rouge\">GET [base]/Practitioner/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Practitioner resources using:\n <code class=\"highlighter-rouge\">GET [base]/Practitioner/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-practitioner-id.html\">_id</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Practitioner?_id=[id]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-practitioner-identifier.html\">identifier</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Practitioner?identifier=[system]|[code]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-practitioner-name.html\">name</a>\n </td>\n <td>\n String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Practitioner?name=[name]\n </code>\n </td>\n </tr>\n\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-practitioner-identifier.html\">identifier</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_PractitionerRole\" class=\"no_toc\">PractitionerRole</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>Due to implementer feedback, some US Core Profiles reference the PractitionerRole resource instead of the US Core PractitionerRole Profile. However the US Core PractitionerRole Profile <strong>SHOULD</strong> be used as the default profile if referenced by another US Core profile.</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-practitionerrole.html\">US Core PractitionerRole Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a PractitionerRole resource using:\n <code class=\"highlighter-rouge\">POST [base]/PractitionerRole {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing PractitionerRole resource using:\n <code class=\"highlighter-rouge\">PUT [base]/PractitionerRole/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing PractitionerRole resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/PractitionerRole/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a PractitionerRole resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching PractitionerRole resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a PractitionerRole resource using:\n <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a PractitionerRole resource using:\n <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a PractitionerRole using:\n <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of PractitionerRole resources using:\n <code class=\"highlighter-rouge\">GET [base]/PractitionerRole/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _includes:\n <ul>\n \n \n <li>PractitionerRole:endpoint - <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:endpoint</code></li>\n \n \n \n <li>PractitionerRole:practitioner - <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-practitionerrole-practitioner.html\">practitioner</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?practitioner=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-practitionerrole-specialty.html\">specialty</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/PractitionerRole?specialty=[system]|[code]\n </code>\n </td>\n </tr>\n\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-practitionerrole-practitioner.html\">practitioner</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-practitionerrole-specialty.html\">specialty</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Procedure\" class=\"no_toc\">Procedure</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<p>Procedure codes can be taken from SNOMED-CT, CPT, HCPCS II, ICD-10-PCS, CDT. LOINC.</p>\n<ul>\n<li>Only LOINC concepts that reflect actual procedures\n<strong>SHOULD</strong> be used</li>\n</ul>\n</li>\n<li>\n<p>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>.</p>\n</li>\n<li>\n<p>Servers and Clients <strong>SHALL</strong> support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through <code>Procedure.basedOn</code> linking the Procedure to the US Core ServiceRequest Profile that includes either <code>ServiceRequest.reasonCode</code> or <code>ServiceRequest.reasonReference</code>. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile's <code>Procedure.reasonCode</code> or <code>Procedure.reasonReference</code>. Depending on the procedure being documented, a server will select the appropriate Profile to use.</p>\n<ul>\n<li>\n<p>Although both <code>Procedure.reasonCode</code> and\n<code>Procedure.reasonReference</code> are marked as Additional USCDI Requirements. The certifying server system is not required to support both but <strong>SHALL</strong> support at least one of these elements. The certifying client application <strong>SHALL</strong> support both elements.</p>\n<ul>\n<li>\n<p>when using <code>Procedure.reasonReference</code>:</p>\n<ul>\n<li>\n<p>Servers <strong>SHALL</strong> support <em>at least one</em> target\nresource in <code>Procedure.reasonReference</code>. Clients <strong>SHALL</strong> support all target resources .</p>\n</li>\n<li>\n<p>The referenced resources <strong>SHOULD</strong> be a US Core\nProfile.</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-procedure.html\">US Core Procedure Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Procedure resource using:\n <code class=\"highlighter-rouge\">POST [base]/Procedure {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Procedure resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Procedure/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Procedure resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Procedure/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Procedure resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching Procedure resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Procedure/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Procedure resource using:\n <code class=\"highlighter-rouge\">GET [base]/Procedure/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Procedure resource using:\n <code class=\"highlighter-rouge\">GET [base]/Procedure/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Procedure using:\n <code class=\"highlighter-rouge\">GET [base]/Procedure/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Procedure resources using:\n <code class=\"highlighter-rouge\">GET [base]/Procedure/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/Procedure?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-procedure-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Procedure?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Procedure?patient=[type]/[id]&code=[system]|[code]&date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-procedure-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-procedure-date.html\">date</a>\n </td>\n <td>\n Reference+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Procedure?patient=[type]/[id]&date=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-procedure-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-procedure-status.html\">status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Procedure?patient=[type]/[id]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-procedure-code.html\">code</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-procedure-date.html\">date</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-procedure-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-procedure-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Provenance\" class=\"no_toc\">Provenance</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<p>The US Core Provenance resource <strong>SHALL</strong> be supported for these US Core resources:</p>\n<ul>\n<li>\n<p>AllergyIntolerance</p>\n</li>\n<li>\n<p>CarePlan</p>\n</li>\n<li>\n<p>CareTeam</p>\n</li>\n<li>\n<p>Condition</p>\n</li>\n<li>\n<p>Coverage</p>\n</li>\n<li>\n<p>Device</p>\n</li>\n<li>\n<p>DiagnosticReport</p>\n</li>\n<li>\n<p>DocumentReference</p>\n</li>\n<li>\n<p>Encounter</p>\n</li>\n<li>\n<p>Goal</p>\n</li>\n<li>\n<p>Immunization</p>\n</li>\n<li>\n<p>MedicationDispense</p>\n</li>\n<li>\n<p>MedicationRequest</p>\n</li>\n<li>\n<p>Observation</p>\n</li>\n<li>\n<p>Patient</p>\n</li>\n<li>\n<p>Procedure</p>\n</li>\n<li>\n<p>QuestionnaireResponse</p>\n</li>\n<li>\n<p>RelatedPerson</p>\n</li>\n<li>\n<p>ServiceRequest</p>\n</li>\n</ul>\n</li>\n<li>\n<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>\n</li>\n<li>\n<p>Systems that need to know the activity has occurred <strong>SHOULD</strong> populate the activity.</p>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-provenance.html\">US Core Provenance Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, search-type, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Provenance resource using:\n <code class=\"highlighter-rouge\">POST [base]/Provenance {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Provenance resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Provenance/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Provenance resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Provenance/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Provenance resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching Provenance resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Provenance/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Provenance resource using:\n <code class=\"highlighter-rouge\">GET [base]/Provenance/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Provenance resource using:\n <code class=\"highlighter-rouge\">GET [base]/Provenance/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Provenance using:\n <code class=\"highlighter-rouge\">GET [base]/Provenance/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Provenance resources using:\n <code class=\"highlighter-rouge\">GET [base]/Provenance/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Questionnaire\" class=\"no_toc\">Questionnaire</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<p>US Core defines two ways to represent the questions and responses to screening and assessment instruments:</p>\n<ul>\n<li>\n<p>Observation: US Core Observation Screening Assessment\nProfile</p>\n</li>\n<li>\n<p>Questionnaire/QuestionnaireResponse: SDC Base\nQuestionnaire/US Core QuestionnaireResponse Profile</p>\n</li>\n</ul>\n</li>\n<li>\n<p>US Core Servers <strong>SHALL</strong> support US Core Observation Screening Assessment Profile and <strong>SHOULD</strong> support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile</p>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"https://hl7.org/fhir/uv/sdc/StructureDefinition-sdc-questionnaire.html\">SDC Base Questionnaire Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n \n \n <li><strong>SHOULD</strong> support read, vread</li>\n \n \n <li><strong>MAY</strong> support create, search-type, update, patch, delete, history-instance, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Questionnaire resource using:\n <code class=\"highlighter-rouge\">POST [base]/Questionnaire {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Questionnaire resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Questionnaire/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Questionnaire resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Questionnaire/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Questionnaire resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching Questionnaire resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Questionnaire/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a Questionnaire resource using:\n <code class=\"highlighter-rouge\">GET [base]/Questionnaire/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Questionnaire resource using:\n <code class=\"highlighter-rouge\">GET [base]/Questionnaire/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Questionnaire using:\n <code class=\"highlighter-rouge\">GET [base]/Questionnaire/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Questionnaire resources using:\n <code class=\"highlighter-rouge\">GET [base]/Questionnaire/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_QuestionnaireResponse\" class=\"no_toc\">QuestionnaireResponse</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<p>US Core defines two ways to represent the questions and responses to screening and assessment instruments:</p>\n<ul>\n<li>\n<p>Observation: US Core Observation Screening Assessment\nProfile</p>\n</li>\n<li>\n<p>Questionnaire/QuestionnaireResponse: SDC Base\nQuestionnaire/US Core QuestionnaireResponse Profile</p>\n</li>\n</ul>\n</li>\n<li>\n<p>US Core Servers <strong>SHALL</strong> support US Core Observation Screening Assessment Profile and <strong>SHOULD</strong> support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse Profile</p>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-questionnaireresponse.html\">US Core QuestionnaireResponse Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n \n \n <li><strong>SHOULD</strong> support search-type, read, vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">POST [base]/QuestionnaireResponse {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">PUT [base]/QuestionnaireResponse/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/QuestionnaireResponse/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction fetching QuestionnaireResponse resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a QuestionnaireResponse using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of QuestionnaireResponse resources using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-questionnaireresponse-id.html\">_id</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse?_id=[id]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-questionnaireresponse-questionnaire.html\">questionnaire</a>\n </td>\n <td>\n Reference+Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse?patient=[type]/[id]&questionnaire=[type]/[id]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-questionnaireresponse-authored.html\">authored</a>\n </td>\n <td>\n Reference+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse?patient=[type]/[id]&authored=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-questionnaireresponse-status.html\">status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse?patient=[type]/[id]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-questionnaireresponse-authored.html\">authored</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-questionnaireresponse-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-questionnaireresponse-questionnaire.html\">questionnaire</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-questionnaireresponse-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_RelatedPerson\" class=\"no_toc\">RelatedPerson</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>Systems <strong>SHOULD</strong> follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for <code>RelatedPerson.address.line</code> and <code>RelatedPerson.address.city</code>.</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-relatedperson.html\">US Core RelatedPerson Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a RelatedPerson resource using:\n <code class=\"highlighter-rouge\">POST [base]/RelatedPerson {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing RelatedPerson resource using:\n <code class=\"highlighter-rouge\">PUT [base]/RelatedPerson/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing RelatedPerson resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/RelatedPerson/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a RelatedPerson resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching RelatedPerson resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/RelatedPerson/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a RelatedPerson resource using:\n <code class=\"highlighter-rouge\">GET [base]/RelatedPerson/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a RelatedPerson resource using:\n <code class=\"highlighter-rouge\">GET [base]/RelatedPerson/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a RelatedPerson using:\n <code class=\"highlighter-rouge\">GET [base]/RelatedPerson/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of RelatedPerson resources using:\n <code class=\"highlighter-rouge\">GET [base]/RelatedPerson/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/RelatedPerson?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-relatedperson-id.html\">_id</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/RelatedPerson?_id=[id]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-relatedperson-name.html\">name</a>\n </td>\n <td>\n String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/RelatedPerson?name=[name]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-relatedperson-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/RelatedPerson?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-relatedperson-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-relatedperson-name.html\">name</a>\n </td>\n <td>\n Reference+String\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/RelatedPerson?patient=[type]/[id]&name=[name]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-relatedperson-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_ServiceRequest\" class=\"no_toc\">ServiceRequest</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>\n<p>The Must Support <code>ServiceRequest.category</code> is bound, <em>at a minimum</em>, to the <a href=\"ValueSet-us-core-servicerequest-category.html\">US Core ServiceRequest Category Codes</a>, and other category codes can be used. API consumers can query by category when accessing patient information. For the USCDI <em>Laboratory Order</em>, <em>Imaging Order</em>, <em>Clinical Test Order</em>, and <em>Procedure Order</em> Data Elements, implementers <strong>SHOULD</strong> use the corresponding category codes listed in the table on the US Core ServiceRequest Profile page. For example, laboratory orders would have the category code "108252007" (Laboratory procedure).</p>\n</li>\n<li>\n<p>The <code>ServiceRequest.code</code> value set is broad to accommodate a wide variety of use cases and <strong>SHOULD</strong> be constrained to a subset for a particular use case or domain. These value sets contain concepts that span many use cases and are not bound to any USCDI Data Element. However, the table on the US Core ServiceRequest Profile page identifies <em>additional</em> value set bindings for the USCDI <em>Laboratory Order, Imaging Order and Clinical Test Order</em> Data Elements. Implementers <strong>SHOULD</strong> conform to the binding strengths for each USCDI Order context listed in the table. For example, laboratory orders are extensibly bound to the LOINC Common Laboratory Orders Value Set. Note that the USCDI Class <em>Procedure Order</em> Data Element has no additional binding.</p>\n</li>\n<li>\n<p>Servers and Clients <strong>SHALL</strong> support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through <code>Procedure.basedOn</code> linking the Procedure to the US Core ServiceRequest Profile that includes either <code>ServiceRequest.reasonCode</code> or <code>ServiceRequest.reasonReference</code>. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile's <code>Procedure.reasonCode</code> or <code>Procedure.reasonReference</code>. Depending on the procedure being documented, a server will select the appropriate Profile to use.</p>\n<ul>\n<li>\n<p>Although both <code>ServiceRequest.reasonCode</code> and\n<code>ServiceRequest.reasonReference</code> are marked as Additional USCDI Requirements, the certifying server system is not required to support both, but <strong>SHALL</strong> support at least one of these elements. The certifying client application <strong>SHALL</strong> support both elements.</p>\n<ul>\n<li>\n<p>when using <code>ServiceRequest.reasonReference</code>:</p>\n<ul>\n<li>\n<p>Servers <strong>SHALL</strong> support <em>at least one</em> target\nresource in <code>ServiceRequest.reasonReference</code>. Clients <strong>SHALL</strong> support all target resources.</p>\n</li>\n<li>\n<p>The referenced resources <strong>SHOULD</strong> be a US Core\nProfile as documented in Referencing US Core Profiles.</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-pmo-servicerequest.html\">US Core PMO ServiceRequest Profile</a>\n \n </li>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-servicerequest.html\">US Core ServiceRequest Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support search-type, read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a ServiceRequest resource using:\n <code class=\"highlighter-rouge\">POST [base]/ServiceRequest {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing ServiceRequest resource using:\n <code class=\"highlighter-rouge\">PUT [base]/ServiceRequest/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing ServiceRequest resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/ServiceRequest/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a ServiceRequest resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>search-type</code> interaction fetching ServiceRequest resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a ServiceRequest resource using:\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a ServiceRequest resource using:\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a ServiceRequest using:\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of ServiceRequest resources using:\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n \n \n \n <li>A Client <strong>SHOULD</strong> be capable of supporting the following _revincludes:\n <ul>\n \n \n <li>Provenance:target - <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?[parameter=value]&_revinclude=Provenance:target</code></li>\n \n \n </ul>\n </li>\n \n \n \n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-servicerequest-id.html\">_id</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?_id=[id]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-servicerequest-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?patient=[type]/[id]&code=[system]|[code]&authored=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <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>\n </td>\n <td>\n Reference+Token+Date/DateTime\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?patient=[type]/[id]&category=[system]|[code]&authored=[dateTime]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-servicerequest-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-servicerequest-category.html\">category</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?patient=[type]/[id]&category=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-servicerequest-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-servicerequest-status.html\">status</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?patient=[type]/[id]&status=[system]|[code]</code>\n </td>\n </tr>\n \n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-servicerequest-patient.html\">patient</a>+<a href=\"SearchParameter-us-core-servicerequest-code.html\">code</a>\n </td>\n <td>\n Reference+Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest?patient=[type]/[id]&code=[system]|[code]</code>\n </td>\n </tr>\n \n \n </tbody>\n </table>\n \n\n \n <div>\n <!-- <p>Search Parameter Requirements (When Used Alone or in Combination):</p> -->\n <ul>\n \n <li><a href=\"SearchParameter-us-core-servicerequest-authored.html\">authored</a> (Date/DateTime):<div><p>A client <strong>SHALL</strong> provide a value precise to the <em>second + time offset</em>.</p>\n<p>A server <strong>SHALL</strong> support a value precise to the <em>second + time offset</em>.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-servicerequest-category.html\">category</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-servicerequest-code.html\">code</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-servicerequest-patient.html\">patient</a> (Reference):<div><p>The client <strong>SHALL</strong> provide at least a id value and <strong>MAY</strong> provide both the Type and id values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n <li><a href=\"SearchParameter-us-core-servicerequest-status.html\">status</a> (Token):<div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></li>\n \n </ul>\n </div>\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_Specimen\" class=\"no_toc\">Specimen</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n <p>Resource Specific Documentation:</p>\n <blockquote><div><ul>\n<li>Although both <code>Specimen.identifier</code> and <code>Specimen.accessionIdentifier</code> are marked as Must Support, the server system is not required to support both, but <strong>SHALL</strong> support at least one of these elements. The client application <strong>SHALL</strong> support both.</li>\n</ul>\n</div></blockquote>\n\n \n\n <!-- supported profiles -->\n <p>Supported Profiles:</p>\n <ul>\n \n \n \n \n <li><strong>SHALL</strong> support \n \n <a href=\"StructureDefinition-us-core-specimen.html\">US Core Specimen Profile</a>\n \n </li>\n \n </ul>\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n <p>FHIR RESTful Interactions</p>\n <div style=\"padding-left: 2em;\">\n <p>Summary:</p>\n <ul>\n \n <li><strong>SHALL</strong> support read</li>\n \n \n \n <li><strong>SHOULD</strong> support vread, history-instance</li>\n \n \n <li><strong>MAY</strong> support create, search-type, update, patch, delete, history-type</li>\n \n \n </ul>\n <!-- Rest interaction details -->\n \n <br/>\n <p>Modify Criteria Details:</p>\n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of posting a Specimen resource using:\n <code class=\"highlighter-rouge\">POST [base]/Specimen {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing Specimen resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Specimen/[id] {?_format=[mime-type]}</code>\n \n </li>\n \n\n \n \n \n \n\n \n\n \n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Specimen resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Specimen/[id] {?_format=[mime-type]}</code>\n </li>\n \n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Specimen resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n \n \n \n\n \n\n \n \n \n \n\n \n\n \n \n \n </ul>\n \n \n <br/>\n <p>Fetch and Search Criteria Details:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching Specimen resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Specimen/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHALL</strong> be capable of a <code>read</code> interaction fetching a Specimen resource using:\n <code class=\"highlighter-rouge\">GET [base]/Specimen/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Specimen resource using:\n <code class=\"highlighter-rouge\">GET [base]/Specimen/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Specimen using:\n <code class=\"highlighter-rouge\">GET [base]/Specimen/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Specimen resources using:\n <code class=\"highlighter-rouge\">GET [base]/Specimen/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n <br/>\n <p>Search Parameter Requirements (When Used Alone or in Combination):</p>\n <table style=\"margin-left: 1em;\" class=\"grid\">\n <thead>\n <tr>\n <th style=\"white-space: nowrap;\">Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <!-- search parameters be limited to only SHALL and SHOULD\n http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient\n https://hl7.org/fhir/us/core/SearchParameter-us-core-careplan-patient.html -->\n \n <tr>\n <td>\n <strong>SHALL</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-specimen-id.html\">_id</a>\n </td>\n <td>\n Token\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Specimen?_id=[id]\n </code>\n </td>\n </tr>\n\n \n <tr>\n <td>\n <strong>SHOULD</strong>\n </td>\n <td>\n <a href=\"SearchParameter-us-core-specimen-patient.html\">patient</a>\n </td>\n <td>\n Reference\n </td>\n <td>\n <code class=\"highlighter-rouge\">GET [base]/Specimen?patient=[type]/[id]\n </code>\n </td>\n </tr>\n\n \n \n </tbody>\n </table>\n \n\n \n\n </div> <!-- end padding left -->\n \n\n \n\n <hr/>\n \n <h4 id=\"Client_ValueSet\" class=\"no_toc\">ValueSet</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n <!-- Documenation -->\n \n\n \n\n <!-- supported profiles -->\n \n\n <p>\n \n\n \n\n \n\n \n </p>\n\n <!-- Resource Interactions -->\n \n\n <p>FHIR Operations:</p>\n \n\n <ul>\n \n \n\n \n \n <li> <strong>SHOULD</strong> support\n \n \n \n <a href=\"https://hl7.org/fhir/R4/valueset-operation-expand.html\"><code>$expand</code></a>\n \n </li>\n \n\n \n \n\n \n \n\n \n \n\n </ul>\n \n \n <blockquote>\n <p><code>$expand</code>:</p><div><p>If a server supports DocumentReference for creating, using, and sharing clinical notes, it <strong>SHOULD</strong> also support the <code>context</code> and <code>contextdirection</code> parameters of the $expand operation to enable clients to determine the supported note and report types, as well as the supported read/write formats for notes on the server.</p>\n</div>\n </blockquote>\n \n \n \n\n <hr/>\n \n \n \n\n <!-- Messaging Capabilities -->\n \n\n <!-- Document Capabilities -->\n \n\n</div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cgp"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/core/ImplementationGuide/hl7.fhir.us.core"
}
]
}
}
],
"url" : "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client",
"version" : "9.0.0",
"name" : "UsCoreClientCapabilityStatement",
"title" : "US Core Client CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2025-12-19T19:16:08.871976-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",
"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"
],
"_implementationGuide" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"rest" : [
{
"mode" : "client",
"documentation" : "The US Core Client **SHALL**:\n\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\n\n\n**NOTE**: US Core SearchParameters referenced in this CapabilityStatement that are derived from standard FHIR SearchParameters are only defined to document Server and Client expectations. They specify additional expectations for the following SearchParameter elements:\n\n\n- `multipleAnd`\n- `multipleOr`\n- `comparator`\n- `modifier`\n- `chain`\n\n\nThey **SHALL NOT** be interpreted as search parameters for search. Servers and Clients **SHOULD** use the standard FHIR SearchParameters.",
"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|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-allergyintolerance.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core AllergyIntolerance 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"
}
],
"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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The 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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The 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" : "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" : "required",
"valueString" : "date"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "CarePlan",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-careplan.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core CarePlan Profile"
}
]
}
],
"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\n - US Core Goal **SHOULD** be present in CarePlan.goal\n\n - US Core Condition **SHOULD** be present in\nCarePlan.addresses\n\n - Assessment and Plan **MAY** be included as narrative\ntext",
"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"
}
],
"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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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" : "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" : "role"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "CareTeam",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-careteam.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core CareTeam Profile"
}
]
}
],
"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\n 1. US Core Practitioner Profile\n\n 1. US Core PractitionerRole Profile\n\n 1. US Core Patient Profile\n\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, 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 support only US Core Practitioner Profile and do not support the US Core PractitionerRole 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"
}
],
"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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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" : "clinical-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" : "code"
}
],
"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" : "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" : "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" : "_lastUpdated"
}
],
"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" : "category"
},
{
"url" : "required",
"valueString" : "clinical-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" : "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" : "category"
},
{
"url" : "required",
"valueString" : "encounter"
}
],
"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|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-condition-encounter-diagnosis.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Condition Encounter Diagnosis Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-condition-problems-health-concerns.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Condition Problems and Health Concerns Profile"
}
]
}
],
"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** be present.\n * There is no single element in Condition that represents the date of diagnosis. It may be the assertedDate Extension, `Condition.onsetDateTime`, 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 the assertedDate Extension and `Condition.onsetDateTime`. A server may support both, which means they support all three elements.\n * The client application **SHALL** support all three elements.\n * See the US Core General Guidance page for [Searching Using lastUpdated](general-guidance.html#searching-using-lastupdated). Updates to `Condition.meta.lastUpdated` **SHOULD** reflect:\n * New problems and health concerns\n * Changes in the clinical status or verifications status of problems or health concern",
"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"
}
],
"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" : "abatement-date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-abatement-date|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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-condition-code|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-lastupdated|9.0.0",
"type" : "date",
"documentation" : "A server **SHALL** document the types of changes that can be detected using this parameter.\n\n\nA client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "Coverage",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-coverage.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Coverage 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"
}
],
"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-coverage-patient|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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"
},
{
"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"
}
],
"type" : "Device",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-device|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-device.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Device Profile"
}
]
}
],
"documentation" : "* Medical devices with UDI information **SHALL** represent the UDI code in `Device.udiCarrier.carrierHRF`. All five UDI-PI elements defined in the UDI code may not always be present in every UDI instance. However, those UDI-PI elements present **SHALL** be represented in the corresponding *US Core Device Profile elements.\n\n\n\n UDI may not be present in all scenarios, such as\nhistorical medical devices, patient-reported implant information, payer-reported devices, or improperly documented implants. If UDI is not present and the manufacturer or model number information is available, they **SHOULD** be included to support historical reports of medical devices as follows:\n\n >|medical device data element|US Core Device Profile element|\n >|---|---|\n >|manufacturer|`Device.manufacturer`|\n >|model|`Device.model`|",
"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"
}
],
"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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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-device-status|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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" : "category"
},
{
"url" : "required",
"valueString" : "_lastUpdated"
}
],
"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" : "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" : "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"
}
],
"type" : "DiagnosticReport",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-diagnosticreport-note.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core DiagnosticReport Profile for Report and Note exchange"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-diagnosticreport-lab.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core DiagnosticReport Profile for Laboratory Results Reporting"
}
]
}
],
"documentation" : "* For laboratory result reports use the *US Core DiagnosticReport Profile for Laboratory Results Reporting Profile*.\n\n * Updates to `.meta.lastUpdated` **SHOULD** reflect:\n\n * New laboratory reports\n\n * Changes in the status of laboratory reports including\nevents that trigger the same status (e.g., amended → amended).\n* For imaging and non-laboratory clinical test result reports use the *US Core DiagnosticReport Profile for Report and Note Exchange Profile*.\n\n * Diagnostic imaging results in visual images requiring\ninterpretation and clinical test results/reports may also reference images as part of the report. There is no single approach for accessing imaging studies alongside clinical data using a single authorization flow to give patients and providers access to the images.\n\n * The `DiagnosticReport.media.link` element **SHOULD**\nbe used to support links to various patient-friendly content, such as jpg images of x-rays (see the DiagnosticReport Chest X-ray Report Example).\n\n * The `DiagnosticReport.imagingStudy` element **SHOULD**\nbe used to support exchange with systems that can view DICOM (Digital Imaging and Communications in Medicine) studies, series, and SOP (Service-Object Pair) instances referenced in the [ImagingStudy] resource.\n\n * Alternatively, systems can use business identifiers\nsuch as accession numbers in the `identifier` element to access the source images from external sources.\n* The `DiagnosticRequest.basedOn` element connects the DiagnosticReport to the originating order in the EHR. Systems that initiate the lab order **SHOULD** use this element when reporting the results.",
"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"
}
],
"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-diagnosticreport-category|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-lastupdated|9.0.0",
"type" : "date",
"documentation" : "A server **SHALL** document the types of changes that can be detected using this parameter.\n\n\nA client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-patient|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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-diagnosticreport-status|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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" : "type"
}
],
"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" : "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" : "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" : "SHOULD"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "status"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "DocumentReference",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-adi-documentreference|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-documentreference.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core DocumentReference Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-adi-documentreference.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core ADI DocumentReference Profile"
}
]
}
],
"documentation" : "* For Advance Directive Information (ADI) documents use the *US Core ADI DocumentReference Profile*.\n* For other clinical documents use the *US Core DiagnosticReport Profile for Report and Note Exchange*.\n\n * See the [Clinical Notes](clinical-notes.html) page for\nimportant definitions, requirements, and guidance on creating, using, and sharing Clinical Notes.\n\n * The `DocumentReference.type` binding Must Support at\na minimum the [10 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\n * Although both are marked as must support, the server\nsystem is not required to support an address, and inline base64 encoded data, but **SHALL** support at least one of these elements.\n\n * The client application **SHALL** support both\nelements.\n\n * The `content.attachment.url` may refer to a FHIR\nBinary Resource (i.e. [base]/Binary/[id]), FHIR Document Bundle (i.e [base]/Bundle/[id] or another endpoint.\n\n * If there are multiple `DocumentReference.content`\nelement repetitions, these **SHALL** all represent the same document in different format or attachment metadata. The content element **SHALL NOT** contain different versions of the same content. For version handling use multiple DocumentReferences with `DocumentReference.relatesTo`\n* Every DocumentReference must have a responsible Organization. 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"
}
],
"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|9.0.0",
"type" : "token"
},
{
"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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "status",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-status|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "docref",
"definition" : "http://hl7.org/fhir/us/core/OperationDefinition/docref|9.0.0",
"_definition" : {
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "OperationDefinition-docref.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "$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\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" : "type"
}
],
"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" : "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" : "_lastUpdated"
}
],
"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" : "discharge-disposition"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Encounter",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-encounter.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Encounter Profile"
}
]
}
],
"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\n * Although both are marked as must support, the server\nsystems are not required to support both a code and a reference, but they **SHALL** support *at least one* of these elements.\n\n * The client application **SHALL** support both elements.\n\n * if `Encounter.reasonReference` references an\nObservation, 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\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\n * Although both are marked as must support, the server\nsystems are not required to support both `Encounter.location.location` and `Encounter.serviceProvider`, but they **SHALL** support *at least one* of these elements.\n\n * The client application **SHALL** support both elements.\n\n* If the event facility/location differs from the `Encounter.location`, systems **SHOULD** reference it directly:\n* Servers can use the US Core Interpreter Needed Extension on this profile or the [US Core Patient Profile] to communicate whether a patient needs an interpreter. Although the extension is marked as an *Additional USCDI Requirements* on both US Core Patient and US Core Encounter Profiles, the certifying Server system is not required to support the extension on both profiles, but **SHALL** support the extension on at least one. The certifying Client application **SHALL** support the extension on both profiles.\n\n - Systems **SHOULD** designate the patient's preferred\nlanguage in the `Patient.communication.preferred` element.\n* Updates to `.meta.lastUpdated` **SHOULD** reflect:\n\n - New encounters/visits\n\n - Changes in the status of encounters, including events\nthat trigger the same status (e.g., in-progress → in-progress). These status changes correspond to events that can initiate [HL7 V2] ADT messages.",
"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"
}
],
"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|9.0.0",
"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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-lastupdated|9.0.0",
"type" : "date",
"documentation" : "A server **SHALL** document the types of changes that can be detected using this parameter.\n\n\nA client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "discharge-disposition",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-encounter-discharge-disposition|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
},
{
"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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Endpoint",
"documentation" : "The Media Resource is a Must Support referenced resource when using the US Core PractitionerRole 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" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"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" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"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" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "FamilyMemberHistory",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-familymemberhistory|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-familymemberhistory.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core FamilyMemberHistory 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"
}
],
"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-familymemberhistory-patient|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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-familymemberhistory-code|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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" : "description"
}
],
"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" : "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"
}
],
"type" : "Goal",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-goal.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Goal Profile"
}
]
}
],
"documentation" : "* Although both `Goal.startDate` and `Goal.target.dueDate` are marked as must support, the server system is not required to support both, but **SHALL** support at least one of these elements. The client application **SHALL** support both elements.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "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"
}
],
"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" : "description",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-goal-description|9.0.0",
"type" : "token"
},
{
"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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *day*.\n\n\nA server **SHALL** support a value a value precise to the *day*."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"type" : "HealthcareService",
"documentation" : "The HealthcareService Resource is a referenced resource when using the US Core PractitionerRole Profile and subject to constraint us-core-13: \"SHALL have a practitioner, an organization, a healthcare service, or a 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" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"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" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"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" : "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"
}
],
"type" : "Immunization",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-immunization.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Immunization Profile"
}
]
}
],
"documentation" : "* Based upon the ASTP U.S. Core Data for Interoperability (USCDI) requirements, CVX vaccine codes are required and the NDC vaccine codes **SHOULD** be supported as an additional code.",
"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"
}
],
"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" : "date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-patient|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Location",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-location.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Location Profile"
}
]
}
],
"documentation" : "* Systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `Location.address.line` and `Location.address.city`.",
"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"
}
],
"searchParam" : [
{
"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|9.0.0",
"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|9.0.0",
"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|9.0.0",
"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|9.0.0",
"type" : "string"
},
{
"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|9.0.0",
"type" : "string"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Media",
"documentation" : "The Media Resource is a Must Support referenced resource when using the US Core DiagnosticReport Profile for Report and Note Exchange.",
"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" : "SHOULD"
}
],
"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" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Medication",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-medication.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Medication Profile"
}
]
}
],
"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"
}
]
},
{
"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" : "required",
"valueString" : "type"
}
],
"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"
}
],
"type" : "MedicationDispense",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-medicationdispense.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core MedicationDispense Profile"
}
]
}
],
"documentation" : "* This Profile can represent a medication using a code or reference a Medication resource.\n\n * The Server systems are not required to support both\na code and a reference, but **SHALL** support at least one of these methods.\n\n * The Client application **SHALL** support all methods.\n\n * Systems that primarily rely on NDC codes instead of\nRxNorm to represent medications can use the National Library of Medicine's (NLM) NDC to RxNorm mappings to aid in additional codings.\n\n * When referencing a Medication resource in\n`.medicationReference`, the resource may be contained or an external resource. If an external reference to a Medication resource is used, the Server **SHALL** support the `_include` parameter for searching this element.",
"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"
}
],
"searchInclude" : [
"MedicationDispense: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" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationdispense-patient|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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-medicationdispense-status|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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-medicationdispense-type|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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" : "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"
},
{
"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"
}
],
"type" : "MedicationRequest",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-medicationrequest.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core MedicationRequest Profile"
}
]
}
],
"documentation" : "* This Profile can represent a medication using a code or reference a Medication resource.\n * The Server systems are not required to support both a code and a reference, but **SHALL** support at least one of these methods.\n * The Client application **SHALL** support all methods.\n * Systems that primarily rely on NDC codes instead of RxNorm to represent medications can use the National Library of Medicine's (NLM) NDC to RxNorm mappings to aid in additional codings.\n * When referencing a Medication resource in `.medicationReference`, the resource may be contained or an external resource. If an external reference to a Medication resource is used, the Server **SHALL** support the `_include` parameter for searching this element. \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.\n\n* When recording “self-prescribed” medication, requester **SHOULD** be used to indicate the Patient or RelatedPerson as the prescriber. (See the Medication List section for guidance on accessing a patient medications including over the counter (OTC) medication and other substances taken for medical and recreational use.)\n\n* The MedicationRequest resource can communicate the reason or indication for treatment using either a code in MedicationRequest.reasonCode or a reference using MedicationRequest.reasonReference.\n * Although both `MedicationRequest.reasonCode` and `MedicationRequest.reasonReference` are marked as Additional USCDI Requirements. The certifying server system is not required to support both but **SHALL** support at least one of these elements. The certifying client application **SHALL** support both elements.\n * when using MedicationRequest.reasonReference:\n * Servers **SHALL** support at least one target resource in `MedicationRequest.reasonReference`. Clients **SHALL** support all target resources.\n * The referenced resources **SHOULD** be a US Core Profile as documented in Referencing US Core Profiles.",
"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"
}
],
"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" : "authoredon",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "encounter",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-encounter|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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-medicationrequest-status|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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" : "category"
},
{
"url" : "required",
"valueString" : "_lastUpdated"
}
],
"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" : "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"
},
{
"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"
}
],
"type" : "Observation",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-adi-documentation|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancystatus|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancyintent|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-occupation|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-simple-observation|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-treatment-intervention-preference|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-care-experience-preference|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-sexual-orientation|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-screening-assessment|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-average-blood-pressure|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-result|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-observation-adi-documentation.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Observation ADI Documentation Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-observation-lab.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Laboratory Result Observation Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-observation-pregnancystatus.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Observation Pregnancy Status Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-observation-pregnancyintent.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Observation Pregnancy Intent Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-observation-occupation.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Observation Occupation Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-respiratory-rate.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Respiratory Rate Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-simple-observation.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Simple Observation Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-treatment-intervention-preference.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Treatment Intervention Preference Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-care-experience-preference.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Care Experience Preference Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-heart-rate.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Heart Rate Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-body-temperature.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Body Temperature Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-pediatric-weight-for-height.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Pediatric Weight for Height Observation Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-pulse-oximetry.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Pulse Oximetry Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-smokingstatus.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Smoking Status Observation Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-observation-sexual-orientation.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Observation Sexual Orientation Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-head-circumference.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Head Circumference Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-body-height.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Body Height Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-bmi.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core BMI Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-observation-screening-assessment.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Observation Screening Assessment Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-average-blood-pressure.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Average Blood Pressure Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-blood-pressure.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Blood Pressure Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-observation-clinical-result.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Observation Clinical Result Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-pediatric-bmi-for-age.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Pediatric BMI for Age Observation Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-head-occipital-frontal-circumference-percentile.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Pediatric Head Occipital Frontal Circumference Percentile Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-body-weight.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Body Weight Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-vital-signs.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Vital Signs Profile"
}
]
}
],
"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 * There are multiple Observation profiles. Refer to the specific profile page for profile specific conformance rules and guidance ",
"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"
}
],
"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-observation-category|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-lastupdated|9.0.0",
"type" : "date",
"documentation" : "A server **SHALL** document the types of changes that can be detected using this parameter.\n\n\nA client **SHALL** provide a value precise to the *second + time offset*.\n\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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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-observation-status|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-organization.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Organization Profile"
}
]
}
],
"documentation" : "* Systems **SHALL** support National Provider Identifier (NPI) for organizations and **SHOULD** support Clinical Laboratory Improvement Amendments (CLIA) and the National Association of Insurance Commissioners NAIC Company code (sometimes called \"NAIC Number\" or \"cocode\") for `Organization.Identifier`.\n* Systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `Organization.address.line` and `Organization.address.city`.",
"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"
}
],
"searchParam" : [
{
"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|9.0.0",
"type" : "string"
},
{
"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|9.0.0",
"type" : "string"
}
]
},
{
"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" : "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" : "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" : "SHOULD"
},
{
"url" : "required",
"valueString" : "death-date"
},
{
"url" : "required",
"valueString" : "family"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Patient",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-patient.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Patient Profile"
}
]
}
],
"documentation" : "* The Patient's Social Security Numbers **SHOULD NOT** be used as a patient identifier in `Patient.identifier.value`.\n* The Complex Extensions for Race and Ethnicity allow for one or more codes of which: Must Support at least one category code from the OMB Race and Ethnicity Category Value Sets that draw from the Race & Ethnicity - CDC (CDCREC] code system.\n - **MAY** include additional codes from the detailed ethnicity and detailed race value sets drawn from the Race & Ethnicity - CDC (CDCREC) code system\n - **SHALL** include a text description\n* Although Patient.deceased[x] is marked as *Additional USCDI Requirement*, certifying systems are not required to support both choices, but **SHALL** support at least `Patient.deceasedDateTime`.\n* Servers can use the US Core Interpreter Needed Extension on this profile or the US Core Encounter Profile to communicate whether a patient needs an interpreter. Although the extension is marked as an *Additional USCDI Requirement* on both US Core Patient and US Core Encounter Profiles, the certifying Server system is not required to support the extension on both profiles but **SHALL** support the extension on at least one. The certifying Client application **SHALL** support the extension on both profiles.\n - Systems **SHOULD** designate the patient's preferred language in the `Patient.communication.preferred` element.\n* Certifying systems **SHALL** and non-certifying systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `Patient.address.line` and `Patient.address.city` for new and updated records.",
"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"
}
],
"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|9.0.0",
"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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *day*.\n\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" : "death-date",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-death-date|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *day*.\n\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|9.0.0",
"type" : "string"
},
{
"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|9.0.0",
"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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"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|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-practitioner.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Practitioner Profile"
}
]
}
],
"documentation" : "* Servers that support only US Core Practitioner Profile and do not support the US Core PractitionerRole Profile **SHALL** provide implementation specific guidance how to access a provider’s location and contact information using only the Practitioner resource.\n\n * Although Practitioner.address is marked as Must Support,\nthe server system is not required to support it if they support the US Core PractitionerRole Profile, but **SHALL** support it if they do not support the US Core PractitionerRole Profile. The client application **SHALL** support both.\n* To balance the privacy of healthcare workers with the patient's right to access information. Only professional/work contact information about the practitioner **SHOULD** be available to the patient (such as a work address or office telephone number).\n* Systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `Practitioner.address.line` and `Practitioner.address.city`.",
"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"
}
],
"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|9.0.0",
"type" : "token"
},
{
"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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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-practitioner-name|9.0.0",
"type" : "string"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "PractitionerRole",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-practitionerrole.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core PractitionerRole Profile"
}
]
}
],
"documentation" : "* Due to implementer feedback, some US Core Profiles reference the PractitionerRole resource instead of the US Core PractitionerRole Profile. However the US Core PractitionerRole Profile **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"
}
],
"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" : "practitioner",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-practitioner|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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" : "SHALL"
},
{
"url" : "required",
"valueString" : "patient"
},
{
"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"
}
],
"type" : "Procedure",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-procedure.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Procedure Profile"
}
]
}
],
"documentation" : "* Procedure codes can be taken from SNOMED-CT, CPT, HCPCS II, ICD-10-PCS, CDT. LOINC.\n\n * Only LOINC concepts that reflect actual procedures\n**SHOULD** be used\n* A procedure including an implantable device **SHOULD** use `Procedure.focalDevice` with a reference to the *US Core Implantable Device Profile*.\n* Servers and Clients **SHALL** support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through `Procedure.basedOn` linking the Procedure to the US Core ServiceRequest Profile that includes either `ServiceRequest.reasonCode` or `ServiceRequest.reasonReference`. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile's `Procedure.reasonCode` or `Procedure.reasonReference`. Depending on the procedure being documented, a server will select the appropriate Profile to use.\n\n * Although both `Procedure.reasonCode` and\n`Procedure.reasonReference` are marked as Additional USCDI Requirements. The certifying server system is not required to support both but **SHALL** support at least one of these elements. The certifying client application **SHALL** support both elements.\n\n * when using `Procedure.reasonReference`:\n\n * Servers **SHALL** support *at least one* target\nresource in `Procedure.reasonReference`. Clients **SHALL** support all target resources .\n\n * The referenced resources **SHOULD** be a US Core\nProfile.",
"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"
}
],
"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" : "code",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-code|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-patient|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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-procedure-status|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-provenance.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Provenance Profile"
}
]
}
],
"documentation" : "* The US Core Provenance resource **SHALL** be supported for these US Core resources:\n\n * AllergyIntolerance\n\n * CarePlan\n\n * CareTeam\n\n * Condition\n\n * Coverage\n\n * Device\n\n * DiagnosticReport\n\n * DocumentReference\n\n * Encounter\n\n * Goal\n\n * Immunization\n\n * MedicationDispense\n\n * MedicationRequest\n\n * Observation\n\n * Patient\n\n * Procedure\n\n * QuestionnaireResponse\n\n * RelatedPerson\n\n * ServiceRequest\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"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Questionnaire",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "https://hl7.org/fhir/uv/sdc/StructureDefinition-sdc-questionnaire.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "SDC Base Questionnaire Profile"
}
]
}
],
"documentation" : "* US Core defines two ways to represent the questions and responses to screening and assessment instruments:\n\n\n\n - Observation: US Core Observation Screening Assessment\nProfile\n\n - Questionnaire/QuestionnaireResponse: SDC Base\nQuestionnaire/US Core QuestionnaireResponse Profile\n\n\n* US Core Servers **SHALL** support US Core Observation Screening Assessment Profile and **SHOULD** support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse 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" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"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" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"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" : "questionnaire"
}
],
"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" : "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"
}
],
"type" : "QuestionnaireResponse",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-questionnaireresponse|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-questionnaireresponse.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core QuestionnaireResponse Profile"
}
]
}
],
"documentation" : "* US Core defines two ways to represent the questions and responses to screening and assessment instruments:\n\n\n\n - Observation: US Core Observation Screening Assessment\nProfile\n\n - Questionnaire/QuestionnaireResponse: SDC Base\nQuestionnaire/US Core QuestionnaireResponse Profile\n\n\n* US Core Servers **SHALL** support US Core Observation Screening Assessment Profile and **SHOULD** support the SDC Base Questionnaire Profile/US Core QuestionnaireResponse 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" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"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"
}
],
"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|9.0.0",
"type" : "token"
},
{
"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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "patient",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-questionnaireresponse-patient|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\n\nThe server **SHALL** support both."
},
{
"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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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" : "name"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "RelatedPerson",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-relatedperson.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core RelatedPerson Profile"
}
]
}
],
"documentation" : "* Systems **SHOULD** follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `RelatedPerson.address.line` and `RelatedPerson.address.city`.",
"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"
}
],
"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|9.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-relatedperson-name|9.0.0",
"type" : "string"
},
{
"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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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" : "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" : "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"
},
{
"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"
}
],
"type" : "ServiceRequest",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pmo-servicerequest|9.0.0"🔗 ,
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-pmo-servicerequest.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core PMO ServiceRequest Profile"
}
]
},
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-servicerequest.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core ServiceRequest Profile"
}
]
}
],
"documentation" : "* The Must Support `ServiceRequest.category` is bound, *at a minimum*, to the [US Core ServiceRequest Category Codes](ValueSet-us-core-servicerequest-category.html), and other category codes can be used. API consumers can query by category when accessing patient information. For the USCDI *Laboratory Order*, *Imaging Order*, *Clinical Test Order*, and *Procedure Order* Data Elements, implementers **SHOULD** use the corresponding category codes listed in the table on the US Core ServiceRequest Profile page. For example, laboratory orders would have the category code \"108252007\" (Laboratory procedure).\n\n\n* The `ServiceRequest.code` value set is broad to accommodate a wide variety of use cases and **SHOULD** be constrained to a subset for a particular use case or domain. These value sets contain concepts that span many use cases and are not bound to any USCDI Data Element. However, the table on the US Core ServiceRequest Profile page identifies *additional* value set bindings for the USCDI *Laboratory Order, Imaging Order and Clinical Test Order* Data Elements. Implementers **SHOULD** conform to the binding strengths for each USCDI Order context listed in the table. For example, laboratory orders are extensibly bound to the LOINC Common Laboratory Orders Value Set. Note that the USCDI Class *Procedure Order* Data Element has no additional binding.\n\n\n* Servers and Clients **SHALL** support both US Core ServiceRequest and US Core Procedure Profiles for communicating the reason or justification for a referral as Additional USCDI Requirements. Typically, the reason or justification for a referral or consultation is communicated through `Procedure.basedOn` linking the Procedure to the US Core ServiceRequest Profile that includes either `ServiceRequest.reasonCode` or `ServiceRequest.reasonReference`. When the Procedure does not have an associated ServiceRequest, it is communicated through the US Core Procedure Profile's `Procedure.reasonCode` or `Procedure.reasonReference`. Depending on the procedure being documented, a server will select the appropriate Profile to use.\n\n * Although both `ServiceRequest.reasonCode` and\n`ServiceRequest.reasonReference` are marked as Additional USCDI Requirements, the certifying server system is not required to support both, but **SHALL** support at least one of these elements. The certifying client application **SHALL** support both elements.\n\n * when using `ServiceRequest.reasonReference`:\n\n * Servers **SHALL** support *at least one* target\nresource in `ServiceRequest.reasonReference`. Clients **SHALL** support all target resources.\n\n * The referenced resources **SHOULD** be a US Core\nProfile as documented in Referencing US Core Profiles.",
"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"
}
],
"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-servicerequest-id|9.0.0",
"type" : "token"
},
{
"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|9.0.0",
"type" : "date",
"documentation" : "A client **SHALL** provide a value precise to the *second + time offset*.\n\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" : "category",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-servicerequest-category|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\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|9.0.0",
"type" : "reference",
"documentation" : "The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values.\n\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-servicerequest-status|9.0.0",
"type" : "token",
"documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\n\nThe server **SHALL** support both."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Specimen",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen|9.0.0"
],
"_supportedProfile" : [
{
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "StructureDefinition-us-core-specimen.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "US Core Specimen Profile"
}
]
}
],
"documentation" : "* Although both `Specimen.identifier` and `Specimen.accessionIdentifier` are marked as Must Support, the server system is not required to support both, but **SHALL** support at least one of these elements. The client application **SHALL** support both.",
"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"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-specimen-id|9.0.0",
"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-specimen-patient|9.0.0",
"type" : "reference"
}
]
},
{
"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",
"_definition" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/narrativeLink",
"valueUrl" : "https://hl7.org/fhir/R4/valueset-operation-expand.html"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/display",
"valueString" : "$expand"
}
]
},
"documentation" : "If a server supports DocumentReference for creating, using, and sharing clinical notes, it **SHOULD** also support the `context` and `contextdirection` parameters of the $expand operation to enable clients to determine the supported note and report types, as well as the supported read/write formats for notes on the server."
}
]
}
],
"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"
}
]
}
]
}
IG © 2025+ HL7 International / Cross-Group Projects. Package hl7.fhir.us.core#9.0.0 based on FHIR 4.0.1. Generated 2026-01-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change